messagepack-rpc: Message Pack RPC over TCP
Downloads
- messagepack-rpc-0.5.1.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.2.0.0, 0.5.1 |
|---|---|
| Change log | CHANGELOG |
| Dependencies | base (>=4 && <5), bytestring (>=0.10 && <0.11), cereal (>=0.5 && <0.6), containers (>=0.5 && <0.6), messagepack (>=0.5 && <0.6), network-simple (>=0.4 && <0.5) [details] |
| License | MIT |
| Copyright | (c) 2014 Rodrigo Setti |
| Author | Rodrigo Setti |
| Maintainer | rodrigosetti@gmail.com |
| Revised | Revision 1 made by rodrigosetti at 2016-09-06T03:59:58Z |
| Category | Network |
| Home page | http://github.com/rodrigosetti/messagepack-rpc |
| Source repo | head: git clone git@github.com:rodrigosetti/messagepack-rpc.git |
| Uploaded | by rodrigosetti at 2015-11-04T02:26:07Z |
| Distributions | |
| Reverse Dependencies | 1 direct, 0 indirect [details] |
| Downloads | 5555 total (7 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2015-11-04 [all 1 reports] |
Readme for messagepack-rpc-0.5.1
[back to package description]messagepack-rpc
Message Pack RPC over TCP.
Right now this implementation only supports TCP, but the plan is to support multiple transports ( UDP, UNIX domain sockets, etc.)
MessagePack-RPC Protocol specification
Reference: http://wiki.msgpack.org/display/MSGPACK/RPC+specification
The protocol consists of "Request" message and the corresponding "Response" message. The server must send "Response" message in reply with the "Request" message.
Request Message
The request message is a four elements array shown below, packed by MessagePack format.
[type, msgid, method, params]
type
Must be zero (integer). Zero means that this message is the "Request" message.
msgid
The 32-bit unsigned integer number. This number is used as a sequence number. The server replies with a requested msgid.
method
The string, which represents the method name.
params
The array of the function arguments. The elements of this array is arbitrary object.
Response Message
The response message is a four elements array shown below, packed by MessagePack format.
[type, msgid, error, result]
type
Must be one (integer). One means that this message is the "Response" message.
msgid
The 32-bit unsigned integer number. This corresponds to the request message.
error
If the method is executed correctly, this field is Nil. If the error occurred at the server-side, then this field is an arbitrary object which represents the error.
result
An arbitrary object, which represents the returned result of the function. If error occurred, this field should be nil.
Notification Message (not yet supported)
The notification message is a three elements array shown below, packed by MessagePack format.
[type, method, params]
type
Must be two (integer). Two means that this message is the "Notification" message.
method
The string, which represents the method name.
params
The array of the function arguments. The elements of this array is arbitrary object.
The Order of the Response
The server implementations don't need to send the reply, in the order of the received requests. If they receive the multiple messages, they can reply in random order.
This is required for the pipelining. At the server side, some functions are fast, and some are not. If the server must reply with in order, the slow functions delay the other replies even if it's execution is already completed.