nats: FIX: add README file
This patch adds a README file describing the known-limitations of our implementation. Change-Id: I174db79783861f145ae224eca86f3fe4968e0205 Signed-off-by: Flavio Santes <flavio.santes@intel.com>
This commit is contained in:
parent
9676df04d1
commit
b0cd36040c
1 changed files with 49 additions and 0 deletions
49
samples/net/nats_clients/README
Normal file
49
samples/net/nats_clients/README
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
NATS Client Library
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
NATS is a text-based IoT protocol based on a publisher-subscriber paradigm.
|
||||||
|
|
||||||
|
This implementation is still WORK IN PROGRESS. So, API may change.
|
||||||
|
|
||||||
|
NATS messages are listed below:
|
||||||
|
|
||||||
|
Msg Side Description
|
||||||
|
INFO Server Sent to client after initial TCP/IP connection
|
||||||
|
CONNECT Client Sent to server to specify connection information
|
||||||
|
PUB Client Publish a message to a subject, with optional reply subject
|
||||||
|
SUB Client Subscribe to a subject (or subject wildcard)
|
||||||
|
UNSUB Client Unsubscribe (or auto-unsubscribe) from subject
|
||||||
|
MSG Server Delivers a message payload to a subscriber
|
||||||
|
PING Both PING keep-alive message
|
||||||
|
PONG Both PONG keep-alive response
|
||||||
|
+OK Server Acknowledges well-formed protocol message in verbose mode
|
||||||
|
-ERR Server Indicates a protocol error. Will cause client disconnect.
|
||||||
|
|
||||||
|
|
||||||
|
Known Limitations
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Msg Side Status
|
||||||
|
INFO Server Partially implemented. Not fully tested.
|
||||||
|
INFO Client Partially implemented. See nats_unpack_info function.
|
||||||
|
CONNECT Client Fully implemented.
|
||||||
|
PUB Client Fully implemented.
|
||||||
|
SUB Client Fully implemented.
|
||||||
|
UNSUB Client Fully implemented.
|
||||||
|
MSG Client Fully implemented.
|
||||||
|
PING Server Fully implemented.
|
||||||
|
PING Client Fully implemented.
|
||||||
|
PONG Server Fully implemented.
|
||||||
|
PONG Client Fully implemented.
|
||||||
|
+OK Client Fully implemented.
|
||||||
|
-ERR Client Not implemented: if the client receives something different
|
||||||
|
from +OK, we must assume an error was detected by the peer.
|
||||||
|
Future versions may include this message.
|
||||||
|
|
||||||
|
|
||||||
|
References
|
||||||
|
----------
|
||||||
|
|
||||||
|
More information about the NATS protocol can be found at:
|
||||||
|
|
||||||
|
http://nats.io/documentation/internals/nats-protocol/
|
Loading…
Add table
Add a link
Reference in a new issue