[www] branch master updated: Added more descriptive information to API page.

[gnunet]

This is an automated email from the git hooks/post-receive script.

t3sserakt pushed a commit to branch master
in repository www.

The following commit(s) were added to refs/heads/master by this push:
     new 6f3d94cc Added more descriptive information to API page.
6f3d94cc is described below

commit 6f3d94ccdf1c988fcd11481c0053a8bbd43ab74f
Author: t3sserakt <t3ss@posteo.de>
AuthorDate: Tue Apr 30 11:23:13 2024 +0200

    Added more descriptive information to API page.
---
 template/probnat/api.html.j2 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/template/probnat/api.html.j2 b/template/probnat/api.html.j2
index 90e56cfd..64267f69 100644
--- a/template/probnat/api.html.j2
+++ b/template/probnat/api.html.j2
@@ -39,9 +39,11 @@
          The second is to create the synchronisation message which the caller 
has to send to the other peer.
          Within GNUnet the Distance Vector DV protocol is used for sending the 
synchronisation message. Applications which do not want to use the complete 
GNUnet stack have to use transportion by other means.<br/><br/>
 
-         The API call needs two parameters. The avarage round trip time 
rtt_avarage has to be provided by the callers application. In GNUnet this 
information is constantly calculated from messages delivered by DV. Again, 
applications not using the GNUnet stack have to assemble this information by 
themself. The second parameter is returned by the first API call and must be 
temporarily stored to use it in the second.<br/><br/>
+         The API call needs two parameters. The avarage round trip time 
rtt_avarage has to be provided by the callers application. In GNUnet this 
information is constantly calculated from messages delivered by DV. Again, 
applications not using the GNUnet stack have to assemble this information by 
themself. The round trip time has to be calculated as the time a message  needs 
to arrive at another peer plus the time a response to this message needs to 
travel back. The messages used to measure th [...]
 
-         The first API call also needs the avarage RTT and the synchronisation 
message received from another peer. The callback is called, if both peers are 
ready to synchronize. Therefore the callback should start the burst mode which 
will finally do the hole punch for NAT traversal.<br/><br/>
+         The second parameter is returned by the first API call and must be 
temporarily stored to use it in the second. This is the burst synchromisation 
method, which encapsulates the RTT calculated by the sending peer, and if that 
peer is ready to sync.<br/><br/>
+
+         The first API call also needs the avarage RTT and the synchronisation 
message received from another peer. The callback is called, if both peers are 
ready to synchronize. Therefore the callback should start the burst mode which 
will finally do the hole punch for NAT traversal. One can find an example in 
the GNUnet code src/service/transport/gnunet-service-transport.c in the 
function handle_flow_control. <br/><br/>
           {% endtrans %}
         </p>
       </section>

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.