git » nmdb » commit b12871a

Document UDP support.

author Alberto Bertogli
2007-06-07 05:30:34 UTC
committer Alberto Bertogli
2007-06-07 05:30:34 UTC
parent a0da39b79ddeb1ec171f891a77466260d00cfd60

Document UDP support.

Add the new function in the libnmdb's manpage, and mention it in the rest
of the documentation.

Signed-off-by: Alberto Bertogli <albertito@gmail.com>

doc/design.rst +2 -2
doc/guide.rst +3 -3
doc/network.rst +4 -4
libnmdb/libnmdb.3 +5 -3

diff --git a/doc/design.rst b/doc/design.rst
index 57ca2ac..e28fc82 100644
--- a/doc/design.rst
+++ b/doc/design.rst
@@ -21,8 +21,8 @@ Network interface
 =================
 
 The server communicates with its clients using messages, which can be
-delivered through TIPC_ or TCP. Messages are limited by design to 64k so they
-stay inside within TIPC_'s limits.
+delivered through TIPC_, TCP or UDP. Messages are limited by design to 64k so
+they stay inside within TIPC_'s limits.
 
 TIPC_ is completely connectionless, and uses the reliable datagram layer
 provided by TIPC_. The network protocol is specified in another document, and
diff --git a/doc/guide.rst b/doc/guide.rst
index 32f5447..112475d 100644
--- a/doc/guide.rst
+++ b/doc/guide.rst
@@ -8,8 +8,8 @@ nmdb User Guide
 Introduction
 ============
 
-nmdb_ is a simple and fast cache and database for TIPC_ and TCP clusters. It
-allows applications in the cluster to use a centralized, shared cache and
+nmdb_ is a simple and fast cache and database for TIPC_, TCP and UDP clusters.
+It allows applications in the cluster to use a centralized, shared cache and
 database in a very easy way. It stores *(key, value)* pairs, with each key
 having only one associated value.
 
@@ -82,7 +82,7 @@ TIPC setup
 If you want to use the server and the clients in different machines using
 TIPC, you need to setup your TIPC network. If you just want to run everything
 in one machine, you already have a TIPC network set up, or you only want to
-use TCP connections, you can skip this section.
+use TCP or UDP connections, you can skip this section.
 
 Before we begin, all the machines should already be connected in an Ethernet
 LAN, and have the tipc-config application that should come with your Linux
diff --git a/doc/network.rst b/doc/network.rst
index 4be8c16..7df5cae 100644
--- a/doc/network.rst
+++ b/doc/network.rst
@@ -7,10 +7,10 @@ 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.
+protocol. It normally uses TIPC, but can use UDP, or 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
diff --git a/libnmdb/libnmdb.3 b/libnmdb/libnmdb.3
index d436ccf..76c1d33 100644
--- a/libnmdb/libnmdb.3
+++ b/libnmdb/libnmdb.3
@@ -8,6 +8,7 @@ libnmdb - Library for interacting with a nmdb server
 .BI "nmdb_t *nmdb_init();"
 .BI "int nmdb_add_tipc_server(nmdb_t *" db ", int " port ");"
 .BI "int nmdb_add_tcp_server(nmdb_t *" db ", const char * " addr ", int " port ");"
+.BI "int nmdb_add_udp_server(nmdb_t *" db ", const char * " addr ", int " port ");"
 .BI "int nmdb_free(nmdb_t *" db ");"
 .sp
 .BI "int nmdb_set(nmdb_t *" db ","
@@ -59,10 +60,11 @@ Optionally, you can add more servers to the server pool, using
 .BR nmdb_add_*_server ().
 You can add any number of servers, and each time a request is made, one will
 be selected. Be aware that you should add all the servers before start using
-the database. For both
-.B nmdb_add_tipc_server()
+the database. For
+.BR nmdb_add_tipc_server() ,
+.B nmdb_add_tcp_server()
 and
-.BR nmdb_add_tcp_server() ,
+.BR nmdb_add_udp_server() ,
 if you pass -1 as the port, it will select the default one.