git » nmdb » commit d597dc7

Clarify the network protocol document.

author Alberto Bertogli
2007-06-01 16:05:18 UTC
committer Alberto Bertogli
2007-06-01 16:05:18 UTC
parent 510d22e57b9118b35e22423e4af31960f4f9f076
Clarify the network protocol document.

Indicate to the reader that the protocol is message-based, and the
transport protocol can wrap around it (as TCP does).

Signed-off-by: Alberto Bertogli <albertito@gmail.com>
doc/network.rst +6 -0 
diff --git a/doc/network.rst b/doc/network.rst
index 65b8249..4be8c16 100644
--- a/doc/network.rst
+++ b/doc/network.rst
@@ -6,6 +6,12 @@ nmdb_ Network Protocol
 
 **NOTE:** All integers are in network byte order.
 
+The nmdb network protocol relies on a message passing underlying transport
+protocol. It normally uses TIPC, but can use TCP with a messaging layer too.
+This document describes the protocol in a transport-independent way, assuming
+the transport protocol can send and receive messages reliably and preserve
+message boundaries. No ordering guarantees are required.
+
 
 Requests
 ========