[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r936 - GNUnet-docs/WWW/test
From: |
durner |
Subject: |
[GNUnet-SVN] r936 - GNUnet-docs/WWW/test |
Date: |
Tue, 14 Jun 2005 12:05:07 -0700 (PDT) |
Author: durner
Date: 2005-06-14 12:05:01 -0700 (Tue, 14 Jun 2005)
New Revision: 936
Modified:
GNUnet-docs/WWW/test/protocol_p2p_afs.php3
GNUnet-docs/WWW/test/protocol_p2p_core.php3
GNUnet-docs/WWW/test/protocol_p2p_dht.php3
GNUnet-docs/WWW/test/protocol_p2p_rpc.php3
GNUnet-docs/WWW/test/protocol_p2p_tracekit.php3
Log:
Reformat
Modified: GNUnet-docs/WWW/test/protocol_p2p_afs.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_p2p_afs.php3 2005-06-14 18:51:16 UTC (rev
935)
+++ GNUnet-docs/WWW/test/protocol_p2p_afs.php3 2005-06-14 19:05:01 UTC (rev
936)
@@ -5,13 +5,12 @@
include("html_header.php3");
afslogo();
-P();
ANCHOR("ROUTING");H4("Anonymous Routing: GAP");
+BP();
W("First, a "correct" implementation of the GAP protocol does not
have to implement routing exactly as described henceforth.");
W("The described algorithm is the best we could come up with so far (while
achieving good anonymity).");
W("Peers can implement a different algorithm and still be protocol
compatible.");
-BR();
-
+P();
W("Whenever a peer receives a query, it must make a couple of decisions.");
W("First, it may decide to just ignore the query.");
W("This is done if the local load is far too high, if the query is expired or
if the query has already been processed recently.");
@@ -22,7 +21,7 @@
W("Note that this is only an approximative description (lacking aspects like
economics, queries with seen replies, multi-queries, and so on), for details
see the %s.\n",
extlink_("doxygen/html/routing_8c.html#a31",
"code (routing.c, needsForwarding)"));
-BR();
+P();
W("Once GAP has decided that a query will be processed, it decides on
performing a local lookup.");
W("Potential replies are send back (with a random delay) if the bandwidth
allocation code permits it.");
@@ -38,7 +37,7 @@
extlink_("doxygen/html/querymanager_8c.html#a16",
"query management code (querymanager.c, fillInQuery)"));
W("The query management then selects suitable recent queries that were so far
not forwarded to the peer in question.");
-BR();
+P();
W("If GAP receives a reply, it checks its routing table for a matching
entry.");
W("It is possible that there is no corresponding query in the routing table
(anymore), in which case the reply is dropped (or, given enough space,
replicated in the local datastore anyway).");
@@ -48,7 +47,7 @@
W("The query stays in the routingtable since there is still a possibility for
loops routing the query back to the peer.");
W("Also some queries can yield multiple results.");
W("In order to handle queries that can yield multiple results, each peer
remembers which results have already been processed for a given query.");
-BR();
+P();
W("The philosophy of why this should achieve good anonymity is described in
the %s.",
extlink_("download/aff.ps", "gap paper"));
@@ -61,7 +60,10 @@
LI(intlink_("#QUERY","GAP_QUERY"));
LI(intlink_("#RESULT","GAP_RESULT"));
echo "</ul>";
+EP();
+
ANCHOR("QUERY");H4("QUERY");
+BP();
W("GAP queries consists of several GAP specific fields, a hash which is used
for routing and for the database lookup, and possibly additional hash codes.");
W("The semantics of these additional hash codes depend on the query type.");
W("As far as GAP is concerend, the query type and those additional hash codes
are merely passed along.");
@@ -91,8 +93,9 @@
W("The type field and all hash codes after the first query are only passed
along and used by the %s.",
extlink_("download/ecrs.ps", "ECRS encoding"));
-P();
+EP();
ANCHOR("RESULT");H4("RESULT");
+BP();
W("A GAP RESULT message is a reply of a GNUnet node to a %s that was used to
request a specific block of a file.",
extlink_("#QUERY","QUERY"));
W("The GAP RESULT message contains the type and first hash code from the
respective QUERY.");
@@ -101,7 +104,7 @@
W("See also the %s and the %s for the way data is transmitted in GNUnet.",
ARRAY(extlink_("download/esed.ps","GNUnet encoding paper"),
extlink_("encoding.php3","encoding page")));
-
+EP();
echo "<table border=3>\n";
include("bittable.inc");
rowSizeType("28+N","17");
Modified: GNUnet-docs/WWW/test/protocol_p2p_core.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_p2p_core.php3 2005-06-14 18:51:16 UTC (rev
935)
+++ GNUnet-docs/WWW/test/protocol_p2p_core.php3 2005-06-14 19:05:01 UTC (rev
936)
@@ -204,7 +204,7 @@
W("If the node is not aware of a corresponding PING (or if the challenge is
wrong), the PONG is silently dropped.");
W("Otherwise the appropriate action corresponding to the PING is triggered.");
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("28","3");
fiveRowIntEntries("receiver identity");
@@ -261,7 +261,7 @@
W("Noise should only be used in encrypted traffic.");
W("The format for noise is:");
EP();
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("≥ 4","6");
rowIntEntry("noise");
Modified: GNUnet-docs/WWW/test/protocol_p2p_dht.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_p2p_dht.php3 2005-06-14 18:51:16 UTC (rev
935)
+++ GNUnet-docs/WWW/test/protocol_p2p_dht.php3 2005-06-14 19:05:01 UTC (rev
936)
@@ -6,6 +6,7 @@
ANCHOR("protocol");H3("GNUnet Protocol: node-to-node: DHT");
+BP();
W("DHT is a service that can be run by a subset of the GNUnet network.");
W("In other words, not all GNUnet peers necessarily support this service.");
W("The DHT service is implemented on top of the %s.",
@@ -31,21 +32,26 @@
W("Other differences result from adaptations of the original work to GNUnet.");
W("Finally, the Kademlia paper describes the basic idea behind a protocol
whereas GNUnet provides a concrete implementation.");
W("As such GNUnet needs to deal with some of the quirks and specific details
that the paper does not address.");
-P();
+EP();
ANCHOR("ping"); H4("DHT_ping");
+BP();
W("A <tt>ping</tt> message is used to determine if another peer participates
in the DHT network and to find out which tables that peer supports.");
W("The proper response to a <tt>ping</tt> is to send back the list of tables
for which the responder is storing data for.");
W("The <tt>ping</tt> request currently uses no arguments.");
W("The resulting table list is stored in under the name <tt>tables</tt>.");
+EP();
ANCHOR("findNode"); H4("DHT_findNode");
+BP();
W("The <tt>findNode</tt> requests is used to find peers in the DHT overlay
that participate in a particular table and that are close to a given key.");
W("The arguments to <tt>findNode</tt> are the <tt>key</tt> and the specific
<tt>table</tt> (both in the form of a hash code).");
W("The response consists of a list of peer identities <tt>peers</tt> which are
the best matching peers found by the responder for this query.");
W("Optionally the response may have an entry <tt>list</tt> that lists the
tables that the responder supports.");
+EP();
ANCHOR("findValue"); H4("DHT_findValue");
+BP();
W("The <tt>findValue</tt> requests asks the peer to perform a DHT lookup on a
particular <tt>key</tt> in a particular <tt>table</tt>.");
W("<tt>findValue</tt> requests are only transmitted to peers that have
previously indicated that they participate in the given <tt>table</tt>.");
W("Peers that participate in a table may only send <tt>findValue</tt> requests
to peers that are closer to the given <tt>key</tt>.");
@@ -53,8 +59,10 @@
W("The RPC returns the result of the lookup operation in fields named
<tt>data</tt>.");
W("Optionally the response may have an entry <tt>list</tt> that lists the
tables that the responder supports.");
W("Peers that receive a <tt>findValue</tt> request and that do not have the
data locally may forward the request to other peers that participate in the
given <tt>table</tt> if those peers have an ID that is closer and if there is a
good chance to obtain a result before the timeout.");
+EP();
ANCHOR("store"); H4("DHT_store");
+BP();
W("The <tt>store</tt> requests asks the peer to store a particular
<tt>value</tt> under a particular <tt>key</tt> in a particular
<tt>table</tt>.");
W("<tt>store</tt> requests are only transmitted to peers that have previously
indicated that they participate in the given <tt>table</tt>.");
W("Peers that participate in a table may only send <tt>store</tt> requests to
peers that are closer to the given <tt>key</tt>.");
@@ -62,13 +70,15 @@
W("If the peer forwards the store message and the storage is confirmed, it
returns the identity of all peers that confirmed storing the data.");
W("Optionally the response may have an entry <tt>list</tt> that lists the
tables that the responder supports.");
W("Peers that receive a <tt>store</tt> request and that do not have the
capacity to store the data locally may forward the request to other peers that
participate in the given <tt>table</tt> if those peers have an ID that is
closer and if there is a good chance to obtain a confirmation for storing the
data before the timeout.");
+EP();
ANCHOR("remove"); H4("DHT_remove");
+BP();
W("The <tt>remove</tt> message works just like the <tt>store</tt> message,
only that the content is removed.");
W("If no content is specified with the <tt>remove</tt> message this indicates
that any kind of content under the given key is to be removed.");
W("The <tt>remove</tt> operation may not be supported by all tables.");
-P();
+EP();
include("html_footer.php3");
?>
\ No newline at end of file
Modified: GNUnet-docs/WWW/test/protocol_p2p_rpc.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_p2p_rpc.php3 2005-06-14 18:51:16 UTC (rev
935)
+++ GNUnet-docs/WWW/test/protocol_p2p_rpc.php3 2005-06-14 19:05:01 UTC (rev
936)
@@ -5,7 +5,7 @@
include("html_header.php3");
ANCHOR("protocol");H3("GNUnet Protocol: node-to-node: RPC");
-
+BP();
W("RPC is a service that can be run by a subset of the GNUnet network.");
W("In other words, not all GNUnet peers necessarily support this service.");
W("A peer that does not support RPC is supposed to ignore RPC requests.");
@@ -26,17 +26,18 @@
extlink_("#RES","RES"));
W("The receiver of the RES always sends back a %s to confirm receit and
complete the 3-way handshake.",
extlink_("#ACK","ACK"));
-BR();
+P();
W("If the initiator does not receive a RES, it will typically retry the REQ
(until timing out).");
W("Similarly, if the responder does not receive the ACK, it will retry the RES
(until timing out).");
W("After receiving the ACK the responder frees all resources associated with
the REQ.");
W("Sequence numbers are used to prevent the responder from executing the
function multiple times.");
-P();
+EP();
ANCHOR("REQ");H4("REQ");
+BP();
W("The %s is used for both REQ and RES messages.",
extlink_("doxygen/html/structRPC__Message.html","RPC message"));
-BR();
+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.");
@@ -48,7 +49,7 @@
W("Future implementations of RPC will likely expose the priority to the RPC
function.");
W("The format of the REQ message is:");
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("size","42");
rowIntEntryNBO("timestamp (unsigned)");
@@ -65,17 +66,18 @@
"gnunet_rpc_service.h"));
W("Each peer is expected to use strictly monotonically increasing sequence
numbers.");
W("There are currently no provisions to handle the integer overflow at
2<sup>32</sup>-1.");
-P();
+EP();
ANCHOR("RES");H4("RES");
+BP();
W("The %s is used for both REQ and RES messages.",
extlink_("doxygen/html/structRPC__Message.html","RPC message"));
-BR();
+P();
// W("<strong>Security considerations</strong>.");
W("The format of the RES message is:");
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("size","43");
rowIntEntryNBO("timestamp (unsigned)");
@@ -93,19 +95,20 @@
"gnunet_rpc_service.h"));
W("Note that GNUnet RPCs can have multiple return values.");
W("The most common error code returned by the RPC service is to indicate that
no function under the given name has been registered at this peer.");
-P();
+EP();
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("The format of an ACK is the following:");
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("8","44");
rowIntEntryNBO("sequence number (unsigned)");
echo "</table>\n";
-P();
+EP();
include("html_footer.php3");
?>
Modified: GNUnet-docs/WWW/test/protocol_p2p_tracekit.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_p2p_tracekit.php3 2005-06-14 18:51:16 UTC
(rev 935)
+++ GNUnet-docs/WWW/test/protocol_p2p_tracekit.php3 2005-06-14 19:05:01 UTC
(rev 936)
@@ -6,6 +6,7 @@
ANCHOR("protocol");H3("GNUnet Protocol: node-to-node: Trace");
+BP();
W("The <tt>tracekit</tt> module provides a protocol that allows tracing the
GNUnet topology.");
W("Not all GNUnet peers support this service, in fact peers that are concerned
about anonymity should probably not support it at all since this protocol
reveils too much information.");
W("The primary purpose of <tt>tracekit</tt> is to help the GNUnet developers
in investigating problems.");
@@ -20,13 +21,13 @@
extlink_("#PROBE","PROBE"));
W("The recipient of the PROBE checks if it has seen the probe previously and
if not forwards it to all other neighbours, sends back a %s and also forwards
all REPLY messages received from its neighbours.",
extlink_("#REPLY","REPLY"));
-BR();
-P();
+EP();
ANCHOR("PROBE");H4("PROBE");
+BP();
W("The format of the %s is:",
extlink_("doxygen/html/structTRACEKIT__p2p__PROBE.html", "PROBE message"));
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("40","36");
rowIntEntryNBO("timestamp (unsigned)");
@@ -45,13 +46,14 @@
W("REPLIES received from those neighbours are forwarded back to the previous
peer that send the PROBE.");
W("The initiator peer identity cannot be confirmed and is not checked in any
way.");
W("The current implementation does not use the economic system to limit the
importance of requests.");
-P();
+EP();
ANCHOR("REPLY");H4("REPLY");
+BP();
W("The format of the %s is:",
extlink("doxygen/html/structTRACEKIT__p2p__REPLY.html", "REPLY message"));
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
include("bittable.inc");
rowSizeType("size","37");
fiveRowIntEntries("initiator peer identity");
@@ -65,7 +67,7 @@
W("The internal client ID is copied unchanged from the original request.");
W("The message contains a variable number of peer IDs for each connected
peer.");
W("If a peer has more connected peers than what can be fit into one message,
it may construct multiple REPLIES.");
-P();
+EP();
include("html_footer.php3");
?>
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r936 - GNUnet-docs/WWW/test,
durner <=