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

[gnunet]

Author: grothoff
Date: 2008-02-16 19:07:20 -0700 (Sat, 16 Feb 2008)
New Revision: 6334

Modified:
   GNUnet-docs/WWW/protocol_cs.php3
   GNUnet-docs/WWW/protocol_cs_afs.php3
   GNUnet-docs/WWW/protocol_cs_core.php3
   GNUnet-docs/WWW/todo
Log:
update

Modified: GNUnet-docs/WWW/protocol_cs.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs.php3    2008-02-17 00:29:58 UTC (rev 6333)
+++ GNUnet-docs/WWW/protocol_cs.php3    2008-02-17 02:07:20 UTC (rev 6334)
@@ -10,12 +10,12 @@
 W("TCP is stream oriented, but GNUnet breaks the stream into records.");
 W("The different messages between GNUnet and the clients all have the 
following basic format:");
 EP();
-LAYOUT("MESSAGE_HEADER",
+LAYOUT("GNUNET_MessageHeader",
        F(ARRAY(N("message size", NBO_()) => 2,
                N("request type", NBO_()) => 2,
                N("(size - 4) bytes of data", "") => 0)));
 BP();
-W("The message type constants are defined in <tt>gnunet_protocols.h</tt> and 
all have names starting with <tt>CS_PROTO_</tt>.");
+W("The message type constants are defined in <tt>gnunet_protocols.h</tt> and 
all have names starting with <tt>GNUNET_CS_PROTO_</tt>.");
 W("The suffix <tt>REQUEST</tt> is used for messages from the client to 
<tt>gnunetd</tt>.");
 W("<tt>REPLY</tt> is used for messages from <tt>gnunetd</tt> to the client.");
 W("If <tt>gnunetd</tt> receives a REQUEST that it does not understand, it 
closes the connection (to prevent the client from blocking on a reply that may 
never come).");

Modified: GNUnet-docs/WWW/protocol_cs_afs.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs_afs.php3        2008-02-17 00:29:58 UTC (rev 
6333)
+++ GNUnet-docs/WWW/protocol_cs_afs.php3        2008-02-17 02:07:20 UTC (rev 
6334)
@@ -11,14 +11,12 @@
 EP();
 echo "<ul>\n";
 LILI("#CS_QUERY","QUERY_START");
-LILI("#CS_QUERY_STOP","QUERY_STOP");
 LILI("#CS_RESULT","RESULT");
 LILI("#CS_INSERT","INSERT");
 LILI("#CS_INDEX","INDEX");
 LILI("#CS_DELETE","DELETE");
 LILI("#CS_UNINDEX","UNINDEX");
 LILI("#CS_TESTINDEX","TESTINDEX");
-LILI("#CS_GET_AVG_PRIORITY","GET_AVG_PRIORITY");
 LILI("#CS_INIT_INDEX","INIT_INDEX");
 echo "</ul>\n";
 
@@ -27,38 +25,22 @@
 W("The client sends a message of this form whenever it is searching or 
downloading.");
 W("The server is expected to perform the search and send results back to the 
client.");
 W("The server can send any number of results with any delay.");
-W("Typically no results are returned after <tt>ttl</tt> seconds and the client 
will re-issue the request.");
-W("The server is supposed to stop searching after receiving a matching 
<tt>QUERY_STOP</tt> message.");
+W("The client can stop searching by closing the connection.");
+W("If the server closes the connection, the client will need to re-send the 
search request using a new connection to continue searching.");
+W("This should only happen if the server is restarted by the user.");
 W("The format of the message is:");
 EP();
 LAYOUT("CS_fs_request_search_MESSAGE",
-       F(ARRAY(N("message size (88 or 152)", NBO_()) => 2,
+       F(ARRAY(N("message size (144 or 208)", NBO_()) => 2,
                V("request type", 8, NBO_()) => 2,
-               N("priority", NBO_()) => 4,
-               N("expiration (cron_t)", NBO_()) => 8,
+               V("reserved", 0, NBO_()) => 4,
                N("type", NBO_()) => 4,
                N("anonymity level", NBO_()) => 4,
+               N("target (if known, otherwise all zeros)", "") => 64,
                N("query", "") => 64,
                N("namespace (optional)", "") => 64)));
 
 
-ANCHOR("CS_QUERY_STOP");H4("QUERY_STOP");
-BP();
-W("This message is send by the client to <tt>gnunetd</tt> to abort a search.");
-W("The format of the message is:");
-EP();
-LAYOUT("CS_fs_request_search_MESSAGE",
-       F(ARRAY(N("message size (88 or 152)", NBO_()) => 2,
-               V("request type", 9, NBO_()) => 2,
-               N("priority", NBO_()) => 4,
-               N("expiration (cron_t)", NBO_()) => 8,
-               N("type", NBO_()) => 4,
-               N("anonymity level", NBO_()) => 4,
-               N("query", "") => 64,
-               N("namespace (optional)", "") => 64)));
-
-
-
 ANCHOR("CS_RESULT");H4("RESULT");
 BP();
 W("If <tt>gnunetd</tt> finds a search result to a %s, it sends back the data 
encapsulated in this message.",
@@ -68,6 +50,7 @@
 LAYOUT("CS_fs_reply_content_MESSAGE",
        F(ARRAY(N("message size (4+X)", NBO_()) => 2,
                V("request type", 9, NBO_()) => 2,
+               N("anonymity level (of content, 0 for unknown)",  NBO_()) => 4,
                N("data (ECRS encoded)", "") => 0)));
 
 ANCHOR("CS_INSERT");H4("INSERT");
@@ -87,9 +70,10 @@
 LAYOUT("CS_fs_request_insert_MESSAGE",
        F(ARRAY(N("message size (20+X)", NBO_()) => 2,
                V("request type", 10, NBO_()) => 2,
+               V("reserved", 0, NBO_()) => 4,
                N("priority", NBO_()) => 4,
-               N("expiration (cron_t)", NBO_()) => 8,
                N("anonymity level", NBO_()) => 4,
+               N("expiration (cron_t)", NBO_()) => 8,
               N("data (ECRS encoded)", "") => 0)));
 
 ANCHOR("CS_INDEX");H4("INDEX");
@@ -110,11 +94,12 @@
 LAYOUT("CS_fs_request_index_MESSAGE",
        F(ARRAY(N("message size (92+X)", NBO_()) => 2,
                V("request type", 11, NBO_()) => 2,
+               V("reserved", 0, NBO_()) => 4,
                N("priority", NBO_()) => 4,
+               N("anonymity level", NBO_()) => 4,
                N("expiration (cron_t)", NBO_()) => 8,
                N("offset of data in file", NBO_()) => 8,
                N("file ID (SHA-512 of entire file)", "") => 64,
-               N("anonymity level", NBO_()) => 4,
               N("data (X bytes in plaintext)", "") => 0)));
 
 
@@ -126,6 +111,7 @@
 LAYOUT("CS_fs_request_delete_MESSAGE",
        F(ARRAY(N("message size (4+X)", NBO_()) => 2,
                V("request type", 12, NBO_()) => 2,
+               V("reserved", 0, NBO_()) => 4,
               N("data (ECRS encoded)", "") => 0)));
 
 
@@ -150,7 +136,7 @@
   intlink_("protocol_cs_core.php3","RETURN_VALUE"));
 W("The format of the message is:");
 EP();
-LAYOUT("RequestTestindex",
+LAYOUT("CS_fs_request_test_index_MESSAGE",
        F(ARRAY(V("message size", 72, NBO_()) => 2,
                V("request type", 14, NBO_()) => 2,
                V("reserved", 0, NBO_()) => 4,
@@ -158,20 +144,6 @@
 EP();
 
 
-ANCHOR("CS_GET_AVG_PRIORITY"); H4("GET_AVG_PRIORITY");
-
-BP();
-W("This query is used by the client to determine the current average priority 
of requests from OTHER peers that are in the routing table.");
-W("The server replies with a %s containing that average priority (or SYSERR on 
error).",
-  intlink_("protocol_cs_core.php3","RETURN_VALUE"));
-W("The format of the message is:");
-EP();
-LAYOUT("CS_MESSAGE_HEADER",
-       F(ARRAY(V("message size", 4, NBO_()) => 2,
-               V("request type", 15, NBO_()) => 2)));
-
-
-
 ANCHOR("CS_INIT_INDEX"); H4("INIT_INDEX");
 
 BP();

Modified: GNUnet-docs/WWW/protocol_cs_core.php3
===================================================================
--- GNUnet-docs/WWW/protocol_cs_core.php3       2008-02-17 00:29:58 UTC (rev 
6333)
+++ GNUnet-docs/WWW/protocol_cs_core.php3       2008-02-17 02:07:20 UTC (rev 
6334)
@@ -11,32 +11,32 @@
 W("The RETURN_VALUE message is also used as part of application-specific CS 
protocols.");
 EP();
 echo "<ul>\n";
-LILI("#CS_returnvalue_MESSAGE","RETURN_VALUE");
-LILI("#CS_SHUTDOWN_REQUEST","SHUTDOWN_REQUEST");
+LILI("#GNUNET_MessageReturnValue","RETURN VALUE");
+LILI("#SHUTDOWN_REQUEST","SHUTDOWN REQUEST");
 echo "</ul>\n";
 
-ANCHOR("CS_returnvalue_MESSAGE");H4("RETURN_VALUE");
+ANCHOR("GNUNET_MessageReturnValue");H4("RETURN VALUE");
 BP();
-W("The RETURN_VALUE message is used to communicate simple (int) return values 
from TCP requests.");
+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_returnvalue_MESSAGE",
+LAYOUT("GNUNET_MessageReturnValue",
        F(ARRAY(V("message size", 8, NBO_()) => 2,
                V("request type", 0, NBO_()) => 2,
                N("return value", NBO_()) => 4)));
 
 
-ANCHOR("CS_SHUTDOWN_REQUEST");H4("SHUTDOWN_REQUEST");
+ANCHOR("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:");
+W("The format of the SHUTDOWN REQUEST message is:");
 EP();
-LAYOUT("CS_MESSAGE_HEADER",
+LAYOUT("GNUNET_MessageHeader",
        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.");
+W("The server responds with a RETURN VALUE message with the contents OK if it 
is shutting down.");
 EP();
 
 include("html_footer.php3");

Modified: GNUnet-docs/WWW/todo
===================================================================
--- GNUnet-docs/WWW/todo        2008-02-17 00:29:58 UTC (rev 6333)
+++ GNUnet-docs/WWW/todo        2008-02-17 02:07:20 UTC (rev 6334)
@@ -1,8 +1,7 @@
 NEW content to be written:
-1) All CS protocols 
-2) P2P tbench
-3) CS tbench, tracekit
-4) Internal Service APIs (stats, identity, pingpong, rpc, traffic, transport, 
dht)
-5) application library APIs (fs, ecrs, fsui, getoption, stats, traffic, dht)
-6) gtk plugins and gtkcommon API
+1) P2P tbench
+2) CS tbench, tracekit
+3) Internal Service APIs (stats, identity, pingpong, rpc, traffic, transport, 
dht)
+4) application library APIs (fs, ecrs, fsui, getoption, stats, traffic, dht)
+5) gtk plugins and gtkcommon API