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

[grothoff]

Author: grothoff
Date: 2005-07-12 19:27:20 -0700 (Tue, 12 Jul 2005)
New Revision: 1454

Added:
   GNUnet-docs/WWW/protocol_cs_getoption.php3
   GNUnet-docs/WWW/protocol_cs_stats.php3
   GNUnet-docs/WWW/protocol_cs_traffic.php3
Modified:
   GNUnet-docs/WWW/protocol_cs_core.php3
   GNUnet-docs/WWW/protocol_cs_index.inc
Log:
update

Modified: GNUnet-docs/WWW/protocol_cs_core.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs_core.php3       2005-07-13 02:02:21 UTC (rev 
1453)
+++ GNUnet-docs/WWW/protocol_cs_core.php3       2005-07-13 02:27:20 UTC (rev 
1454)
@@ -1,172 +1,45 @@
 <?php
 include("scripts.php3");
-$title = "GNUnet Documentation: AFS Client-to-Node protocol";
-$description="GNUnet Documentation - core client-server protocol";
+$title = "GNUnet Documentation: Client-to-Node protocol";
+$description="Documentation of the CS messages implemented by the GNUnet 
core.";
 include("html_header.php3");
 
-ANCHOR("CSprotocolCore");H3("GNUnet Protocol: client-to-node: core");
+H3("GNUnet Protocol: client-to-node: core");
 BP();
-W("The only application independent, always available client-server (CS) 
message that are currently defined are:");
+W("The following messages are not specific to any particular appliation.");
+W("They are implemented by the core and always available.");
+W("The RETURN_VALUE message is also used as part of application-specific CS 
protocols.");
 EP();
 echo "<ul><li>";
 extlink("#CS_RETURN_VALUE","RETURN_VALUE");
 echo "</li><li>";
-extlink("#CS_GET_STATISTICS","GET_STATISTICS");
-echo "</li><li>";
-extlink("#CS_STATISTICS","STATISTICS");
-echo "</li><li>";
-extlink("#CS_TRAFFIC_QUERY","TRAFFIC_QUERY");
-echo "</li><li>";
-extlink("#CS_TRAFFIC_INFO","TRAFFIC_INFO");
-echo "</li><li>";
 extlink("#CS_SHUTDOWN_REQUEST","SHUTDOWN_REQUEST");
-echo "</li><li>";
-extlink("#CS_GET_OPTION_REQUEST","GET_OPTION_REQUEST");
-echo "</li><li>";
-extlink("#CS_GET_OPTION_REPLY","GET_OPTION_REPLY");
 echo "</li></ul>";
 
+
 ANCHOR("CS_RETURN_VALUE");H4("RETURN_VALUE");
 BP();
 W("The RETURN_VALUE message is used to communicate simple (int) return values 
from TCP requests.");
 W("It is always send in response to another, specific request.");
 W("The format of the RETURN_VALUE message is:");
 EP();
+LAYOUT("CS_RETURN_VALUE",
+       F(ARRAY(V("message size", 8, NBO_()) => 2,
+               V("request type", 0, NBO_()) => 2,
+               N("return value", NBO_()) => 4)));
 
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("8","0");
-rowIntEntryNBO("the return value");
-echo "</table>\n";
 
-ANCHOR("CS_GET_STATISTICS");H4("GET_STATISTICS");
-BP();
-W("With this message, the client can request statistics from the server.");
-W("The server always replies with a %s message.",
-  extlink_("#CS_STATISTICS","STATISTICS"));
-P();
-W("The format of the GET_STATISTICS message is:");
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("4", "1");
-echo "</table>\n";
-
-ANCHOR("CS_STATISTICS");H4("STATISTICS");
-BP();
-W("The available statistical information may change between GNUnet versions.");
-W("It also depends on which modules are loaded.");
-W("The %s of this message is:",
-  extlink_("doxygen/html/structSTATISTICS__Message.html","format"));
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("variable", "2");
-rowIntEntryNBO("start time (gnuentd start)");
-rowIntEntryNBO("start time (gnunetd start)");
-rowIntEntryNBO("total counters (number of statistical values gnunetd keeps 
track of)");
-rowIntEntryNBO("stat counters (number of statistical values transmitted in 
this message)");
-rowIntEntryNBO("values (unsigned long long[stat counters])");
-rowIntEntryNBO("descriptions (stat counters of zero-terminated strings 
describing the values)");
-echo "</table>\n";
-
-BP();
-W("The server sends potentially several STATISTICS messages until the sum of 
<tt>stat counters</tt> in all messages equals the <tt>total counters</tt> 
advertised.");
-W("The last decription string is also zero-terminated.");
-W("Thus the last character in every STATISTICS message is 0.");
-EP();
-
-
-ANCHOR("CS_TRAFFIC_QUERY");H4("TRAFFIC_QUERY");
-BP();
-W("With this message, the client can request traffic statistics from 
gnunetd.");
-W("The time period specfied in the message specifies which traffic is 
interesting for the request (in terms of not older than time period time 
units).");
-W("The format of the TRAFFIC_QUERY message is:");
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("4", "2");
-rowIntEntryNBO("time period (in CU)");
-echo "</table>\n";
-BP();
-W("The server responds with a TRAFFIC_INFO message.");
-EP();
-
-
-ANCHOR("CS_TRAFFIC_INFO");H4("TRAFFIC_INFO");
-BP();
-W("With this message, the server sends traffic information to the client.");
-W("The format of the TRAFFIC_INFO message is:");
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("4", "3");
-rowIntEntryNBO("number of traffic counters that follow");
-echo "</table>\n";
-
-BP();
-W("The traffic counters have the following format:");
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-row(shortEntry_("flags (see TC_ constants)", NBO_()),
-    shortEntry_("number of messages of this type that were processed", 
NBO_()));
-row(shortEntry_("message type", NBO_()),
-    shortEntry_("average message size", NBO_()));
-rowIntEntryNBO("bitmask indicating in which of the last 32 time units a 
message was received");
-echo "</table>\n";
-
-
 ANCHOR("CS_SHUTDOWN_REQUEST");H4("SHUTDOWN_REQUEST");
 BP();
 W("With this message, the client can request gnunetd to shutdown.");
 W("The format of the SHUTDOWN_REQUEST message is:");
 EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("4", "64");
-echo "</table>\n";
+LAYOUT("CS_HEADER",
+       F(ARRAY(V("message size", 4, NBO_()) => 2,
+               V("request type", 1, NBO_()) => 2)));
 BP();
 W("The server responds with a RETURN_VALUE message with the contents OK if it 
is shutting down.");
 EP();
 
-
-ANCHOR("GET_OPTION_REQUEST");H4("GET_OPTION_REQUEST");
-BP();
-W("With this message, the client can request the value of an option from the 
gnunetd configuration.");
-W("The format of the GET_OPTION_REQUEST message is:");
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("4", "65");
-rowIntEntry("32 characters giving the section name, 0-terminated");
-rowIntEntry("32 characters giving the option name, 0-terminated");
-echo "</table>\n";
-BP();
-W("The server responds with a GET_OPTION_REPLY message.");
-
-EP();
-ANCHOR("GET_OPTION_REPLY");H4("GET_OPTION_REPLY");
-BP();
-W("With this message, the server notifies the client about the value of an 
option.");
-W("The format of the GET_OPTION_REPLY message is:");
-EP();
-
-echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
-include("bittable.inc");
-rowSizeType("variable(&gt;4)", "66");
-rowIntEntry("option value (as characters), 0-terminated, size determined");
-echo "</table>\n";
-
-
-
-
 include("html_footer.php3");
 ?>

Added: GNUnet-docs/WWW/protocol_cs_getoption.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs_getoption.php3  2005-07-13 02:02:21 UTC (rev 
1453)
+++ GNUnet-docs/WWW/protocol_cs_getoption.php3  2005-07-13 02:27:20 UTC (rev 
1454)
@@ -0,0 +1,44 @@
+<?php
+include("scripts.php3");
+$title = "GNUnet Documentation: getoption CS protocol";
+$description="Documentation of the client-server getoption protocol";
+include("html_header.php3");
+
+H3("GNUnet Protocol: client-to-node: getoption");
+BP();
+W("The %s messages are implemented by the %s service.",
+  ARRAY("GET_OPTION", "getoption"));
+EP();
+echo "<ul><li>";
+extlink("#CS_GET_OPTION_REQUEST","GET_OPTION_REQUEST");
+echo "</li><li>";
+extlink("#CS_GET_OPTION_REPLY","GET_OPTION_REPLY");
+echo "</li></ul>";
+
+ANCHOR("GET_OPTION_REQUEST");H4("GET_OPTION_REQUEST");
+BP();
+W("With this message, the client can request the value of an option from the 
gnunetd configuration.");
+W("The format of the GET_OPTION_REQUEST message is:");
+EP();
+LAYOUT("CS_GET_OPTION_REQUEST",
+       F(ARRAY(V("message size", 68, NBO_()) => 2,
+               V("request type", 2, NBO_()) => 2,
+               N("section name", "") => 32,
+               N("option name", "") => 32)));
+BP();
+W("The server responds with a GET_OPTION_REPLY message.");
+EP();
+
+ANCHOR("GET_OPTION_REPLY");H4("GET_OPTION_REPLY");
+BP();
+W("With this message, the server notifies the client about the value of an 
option.");
+W("The format of the GET_OPTION_REPLY message is:");
+EP();
+LAYOUT("CS_GET_OPTION_REPLY",
+       F(ARRAY(N("message size", NBO_()) => 2,
+               V("request type", 3, NBO_()) => 2,
+               N("value (size - 4 bytes), 0-terminated", "") => 0)));
+
+include("html_footer.php3");
+
+?>

Modified: GNUnet-docs/WWW/protocol_cs_index.inc
===================================================================
--- GNUnet-docs/WWW/protocol_cs_index.inc       2005-07-13 02:02:21 UTC (rev 
1453)
+++ GNUnet-docs/WWW/protocol_cs_index.inc       2005-07-13 02:27:20 UTC (rev 
1454)
@@ -1,8 +1,11 @@
 <ol>
 <li><?php intlink("protocol_cs_core.php3","GNUnet core"); ?></li>
-<li><?php intlink("protocol_cs_afs.php3","AFS"); ?></li>
-<!-- li><?php intlink("protocol_cs_chat.php3","Chat"); ?></li -->
-<!-- li><?php intlink("protocol_cs_tbench.php3","TBench"); ?></li -->
-<!-- li><?php intlink("protocol_cs_tracekit.php3","TraceKit"); ?></li -->
-<li><?php intlink("protocol_cs_testbed.php3","Testbed"); ?></li>
+<li><?php intlink("protocol_cs_getoption.php3","getoption"); ?></li>
+<li><?php intlink("protocol_cs_stats.php3","stats"); ?></li>
+<li><?php intlink("protocol_cs_traffic.php3","traffic"); ?></li>
+<li><?php intlink("protocol_cs_afs.php3","fs"); ?></li>
+<!-- li><?php intlink("protocol_cs_chat.php3","chat"); ?></li -->
+<!-- li><?php intlink("protocol_cs_tbench.php3","tbench"); ?></li -->
+<!-- li><?php intlink("protocol_cs_tracekit.php3","tracekit"); ?></li -->
+<li><?php intlink("protocol_cs_testbed.php3","testbed"); ?></li>
 </ol>

Added: GNUnet-docs/WWW/protocol_cs_stats.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs_stats.php3      2005-07-13 02:02:21 UTC (rev 
1453)
+++ GNUnet-docs/WWW/protocol_cs_stats.php3      2005-07-13 02:27:20 UTC (rev 
1454)
@@ -0,0 +1,58 @@
+<?php
+include("scripts.php3");
+$title = "GNUnet Documentation: stats CS protocol";
+$description="Documentation of the CS stats protocol";
+include("html_header.php3");
+
+H3("GNUnet Protocol: client-to-node: stats");
+BP();
+W("The %s messages are implemented by the %s service.",
+  ARRAY("STATISTICS", "stats"));
+EP();
+echo "<ul><li>";
+extlink("#CS_GET_STATISTICS","GET_STATISTICS");
+echo "</li><li>";
+extlink("#CS_STATISTICS","STATISTICS");
+echo "</li><li>";
+extlink("#CS_GET_MESSAGE_SUPPORTED","GET_MESSAGE_SUPPORTED");
+echo "</li></ul>";
+
+ANCHOR("CS_GET_STATISTICS");H4("GET_STATISTICS");
+BP();
+W("With this message, the client can request statistics from the server.");
+W("The server always replies with a %s message.",
+  extlink_("#CS_STATISTICS","STATISTICS"));
+P();
+W("The format of the GET_STATISTICS message is:");
+EP();
+LAYOUT("CS_HEADER",
+       F(ARRAY(V("message size", 4, NBO_()) => 2,
+               V("request type", 36, NBO_()) => 2)));
+
+
+ANCHOR("CS_STATISTICS");H4("STATISTICS");
+BP();
+W("The available statistical information may change between GNUnet versions.");
+W("It also depends on which modules are loaded.");
+W("The format of this message is:"):
+EP();
+
+LAYOUT("STATS_CS_MESSAGE",
+       F(ARRAY(N("message size", NBO_()) => 2,
+               V("request type", 37, NBO_()) => 2,
+               V("reserved", 0, NBO_()) => 4,
+               N("start time (cron_t)", NBO_()) => 8,
+               N("total", NBO_()) => 4,
+               N("count", NBO_()) => 4,
+               N("values (count unsigned long longs)", NBO_()) => 0,
+              N("names (count 0-terminated strings)", ""))));
+BP();
+W("The server sends potentially several STATISTICS messages until the sum of 
<tt>count</tt> in all messages equals the <tt>total</tt> advertised.");
+W("The last decription string is also zero-terminated.");
+W("Thus the last character in every of these messages is 0.");
+EP();
+
+
+
+include("html_footer.php3");
+?>

Added: GNUnet-docs/WWW/protocol_cs_traffic.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs_traffic.php3    2005-07-13 02:02:21 UTC (rev 
1453)
+++ GNUnet-docs/WWW/protocol_cs_traffic.php3    2005-07-13 02:27:20 UTC (rev 
1454)
@@ -0,0 +1,66 @@
+<?php
+include("scripts.php3");
+$title = "GNUnet Documentation: traffic CS protocol";
+$description="Documentation of the CS traffic protocol";
+include("html_header.php3");
+
+H3("GNUnet Protocol: client-to-node: traffic");
+BP();
+W("The %s messages are implemented by the %s service.",
+  ARRAY("TRAFFIC", "traffic"));
+EP();
+echo "<ul><li>";
+extlink("#CS_TRAFFIC_QUERY","TRAFFIC_QUERY");
+echo "</li><li>";
+extlink("#CS_TRAFFIC_INFO","TRAFFIC_INFO");
+echo "</li></ul>";
+
+
+ANCHOR("CS_TRAFFIC_QUERY");H4("TRAFFIC_QUERY");
+BP();
+W("With this message, the client can request traffic statistics from 
gnunetd.");
+W("The time period specfied in the message specifies which traffic is 
interesting for the request (in terms of not older than time period time 
units).");
+W("The format of the TRAFFIC_QUERY message is:");
+EP();
+
+echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
+include("bittable.inc");
+rowSizeType("4", "2");
+rowIntEntryNBO("time period (in CU)");
+echo "</table>\n";
+BP();
+W("The server responds with a TRAFFIC_INFO message.");
+EP();
+
+
+ANCHOR("CS_TRAFFIC_INFO");H4("TRAFFIC_INFO");
+BP();
+W("With this message, the server sends traffic information to the client.");
+W("The format of the TRAFFIC_INFO message is:");
+EP();
+
+echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
+include("bittable.inc");
+rowSizeType("4", "3");
+rowIntEntryNBO("number of traffic counters that follow");
+echo "</table>\n";
+
+BP();
+W("The traffic counters have the following format:");
+EP();
+
+echo "<table class=\"border\" border=\"0\" cellspacing=\"0\" 
cellpadding=\"0\">\n";
+include("bittable.inc");
+row(shortEntry_("flags (see TC_ constants)", NBO_()),
+    shortEntry_("number of messages of this type that were processed", 
NBO_()));
+row(shortEntry_("message type", NBO_()),
+    shortEntry_("average message size", NBO_()));
+rowIntEntryNBO("bitmask indicating in which of the last 32 time units a 
message was received");
+echo "</table>\n";
+
+
+
+
+
+include("html_footer.php3");
+?>