[GNUnet-SVN] r1478 - GNUnet-docs/WWW

[grothoff]

Author: grothoff
Date: 2005-07-13 12:03:01 -0700 (Wed, 13 Jul 2005)
New Revision: 1478

Modified:
   GNUnet-docs/WWW/protocol_p2p_rpc.php3
Log:
update

Modified: GNUnet-docs/WWW/protocol_p2p_rpc.php3
===================================================================
--- GNUnet-docs/WWW/protocol_p2p_rpc.php3       2005-07-13 18:54:07 UTC (rev 
1477)
+++ GNUnet-docs/WWW/protocol_p2p_rpc.php3       2005-07-13 19:03:01 UTC (rev 
1478)
@@ -37,9 +37,6 @@
 ANCHOR("REQ");H4("REQ");
 
 BP();
-W("The %s is used for both REQ and RES messages.",
-  extlink_("doxygen/html/structRPC__Message.html","RPC message"));
-P();
 W("<strong>Security considerations</strong>.");
 W("The RPC module does not provide any access checks on RPC calls.");
 W("While the peer identity of the initiator has been established, there is no 
access control mechanism.");
@@ -52,19 +49,17 @@
 
 W("The format of the REQ message is:");
 EP();
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("size","42");
-rowIntEntryNBO("timestamp (unsigned)");
-rowIntEntryNBO("sequence number (unsigned)");
-rowIntEntryNBO("importance of the request (unsigned)");
-row(shortEntry_("Number of arguments (unsigned)", NBO_()),
-    shortEntry_("Length of the function name (unsigned)", NBO_()));
-rowIntEntry("Function name (variable size)");
-rowIntEntry("Arguments (variable size)");
-echo "</table>\n";
+LAYOUT("RPC_Message",
+       F(ARRAY(N("size", NBO_()) => 2,
+               V("type", 42, NBO_()) => 2,
+              N("sequence number", NBO_()) => 4,
+              N("importance", NBO_()) => 4,
+              N("number of arguments", NBO_()) => 2,
+              N("length of the function name", NBO_()) => 2,
+              N("function name", "") => 0,
+              N("arguments (see RPC_paramSerialize)", "") => 0)));
 BP();
-W("The format of the arguments is first a zero-terminated parameter name, 
followed by the size of the parameter (as an unsigned int in network byte 
order) followed by the actual argument.");
+W("The format of the arguments is first a zero-terminated parameter name, 
followed by the size of the parameter (as an <tt>unsigned int</tt> in network 
byte order) followed by the actual argument.");
 W("The helper functions defined in %s should be used to serialize and 
deserialize the arguments.",
   extlink_("doxygen/html/gnunet__rpc__service_8h.html",
           "gnunet_rpc_service.h"));
@@ -75,23 +70,16 @@
 ANCHOR("RES");H4("RES");
 
 BP();
-W("The %s is used for both REQ and RES messages.",
-  extlink_("doxygen/html/structRPC__Message.html","RPC message"));
-P();
-// W("<strong>Security considerations</strong>.");
-
 W("The format of the RES message is:");
 EP();
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("size","43");
-rowIntEntryNBO("timestamp (unsigned)");
-rowIntEntryNBO("sequence number (unsigned)");
-rowIntEntryNBO("importance of the reply (unsigned)");
-row(shortEntry_("Number of return values (unsigned)", NBO_()),
-    shortEntry_("Error code (0 for success)", NBO_()));
-rowIntEntry("Return values (variable size)");
-echo "</table>\n";
+LAYOUT("RPC_Message",
+       F(ARRAY(N("size", NBO_()) => 2,
+               V("type", 43, NBO_()) => 2,
+              N("sequence number", NBO_()) => 4,
+              N("importance of the reply", NBO_()) => 4,
+              N("number of return values", NBO_()) => 2,
+              N("error code (0 for success)", NBO_()) => 2,
+              N("return values (see RPC_paramDeserialize)", "") => 0)));
 BP();
 W("The number of return values must be 0 if a non-zero error code is 
returned.");
 W("The sequence number must be identical to the number from the REQ message.");
@@ -105,16 +93,13 @@
 
 ANCHOR("ACK");H4("ACK");
 BP();
-W("An %s is purely a notification that a RES was received.",
-  extlink_("doxygen/html/structRPC__ACK__Message.html","ACK message"));
+W("An ACK is purely a notification that a RES was received.");
 W("The format of an ACK is the following:");
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("8","44");
-rowIntEntryNBO("sequence number (unsigned)");
-echo "</table>\n";
-
 EP();
+LAYOUT("RPC_ACK_Message",
+       F(ARRAY(V("size", 8, NBO_()) => 2,
+               V("type", 44, NBO_()) => 2,
+              N("sequence number", NBO_()) => 4)));
 
 include("html_footer.php3");
 ?>