commit cdabcf2d8bf9ec458111216352fe4c9ac3c11bd0
parent d1a71233594235411e1a4da75caa71c2bb31f902
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Fri, 11 Mar 2022 05:23:34 +0100
-English fixes
Diffstat:
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/draft-schanzen-r5n.xml b/draft-schanzen-r5n.xml
@@ -873,14 +873,17 @@ bchar = *(ALPHA / DIGIT)
<section anchor="routing_functions">
<name>Routing Functions</name>
<t>
- The R<sup>5</sup>N routing component <bcp14>MUST</bcp14> implement the following functions:
+ Using the data structures described so far,
+ the R<sup>5</sup>N routing component provides
+ the following functions for
+ message processing (<xref target="p2p_messages"/>):
</t>
<dl>
<dt>
<tt>GetDistance(A, B) -> Distance as Integer</tt>
</dt>
<dd>
- this function calculates the binary XOR between A and B.
+ This function calculates the binary XOR between A and B.
The resulting distance is interpreted as an integer where
the leftmost bit is the most significant bit.
</dd>
@@ -888,38 +891,39 @@ bchar = *(ALPHA / DIGIT)
<tt>SelectClosestpeer(K, B) -> N</tt>
</dt>
<dd>
- This function selects the connected peer <tt>N</tt> from our
+ This function selects the neighbour <tt>N</tt> from our
routing table with the shortest XOR-distance to the key <tt>K</tt>.
This means that for all other peers <tt>N'</tt> in the routing table
<tt>GetDistance(N, K) < GetDistance(N',K)</tt>.
- peers in the Bloom filter <tt>B</tt> are not considered.
+ Peers with a positive test against the peer Bloom
+ filter <tt>B</tt> are not considered.
</dd>
<dt>
<tt>SelectRandompeer(B) -> N</tt>
</dt>
<dd>
- This function selects a random peer <tt>N</tt> from all connected
- peers.
- peers in the Bloom filter <tt>B</tt> are not considered.
+ This function selects a random peer <tt>N</tt> from
+ all neighbours.
+ Peers with a positive test in the peer Bloom
+ filter <tt>B</tt> are not considered.
</dd>
<dt>
<tt>Selectpeer(K, H, B) -> N</tt>
</dt>
<dd>
- This function selects a peer <tt>N</tt> depending on the
+ This function selects a neighbour <tt>N</tt> depending on the
number of hops <tt>H</tt> parameter.
If <tt>H < NETWORK_SIZE_ESTIMATE</tt>
- this function <bcp14>MUST</bcp14> return <tt>SelectRandompeer()</tt> and
- <tt>SelectClosestpeer(K)</tt> otherwise.
- peers in the Bloom filter <tt>B</tt> are not considered.
+ this function <bcp14>MUST</bcp14> return <tt>SelectRandompeer(B)</tt> and
+ <tt>SelectClosestpeer(K, B)</tt> otherwise.
</dd>
<dt>
<tt>IsClosestpeer(N, K, B) -> true | false</tt>
</dt>
<dd>
- checks if <tt>N</tt> is the closest peer for <tt>K</tt>
+ This function checks if <tt>N</tt> is the closest peer for <tt>K</tt>
(cf. <tt>SelectClosestpeer(K)</tt>).
- peers in the Bloom filter <tt>B</tt> are not considered.
+ Peers with a positive test in the Bloom filter <tt>B</tt> are not considered.
</dd>
</dl>
</section>