[gnunet-scheme] 05/05: doc/cadet: Draft documentation on CADET network messages.

[gnunet]

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

maxime-devos pushed a commit to branch master
in repository gnunet-scheme.

commit a68c0d1f6c69b4b492a2a5333f592b0b47ed9501
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Mon Feb 7 14:21:24 2022 +0000

    doc/cadet: Draft documentation on CADET network messages.
    
    * doc/cadet.scm (Constructing and analysing network messages): New
      section.
---
 doc/cadet.tm | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/doc/cadet.tm b/doc/cadet.tm
index ffd6a29..0f2b68f 100644
--- a/doc/cadet.tm
+++ b/doc/cadet.tm
@@ -105,6 +105,63 @@
   (AF_CADET, SOCK_RDM, 0) \U\<gtr\> UDP/CADET (VPN), out-of-order, reliable
 
   These sockets not dupable, don't have a fd.<todo|>
+
+  <section|Constructing and analysing network messages>
+
+  <todo|difference between channels and ports>
+
+  <todo|acknowledgement>
+
+  <todo|readable bytevector slices>
+
+  <todo|verify against GNUnet documentation>
+
+  <todo|analysis>
+
+  <\explain>
+    (construct-open-local-port <var|port>)<index|construct-open-local-port>
+  </explain|Create a new 
<scm|/:msg:cadet:local:port:open><index|/:msg:cadet:local:port:open>
+  message for instructing the service to open the port <var|port> at the
+  local peer.>
+
+  <\explain>
+    (construct-close-local-port <var|port>)<index|construct-close-local-port>
+  </explain|Crreate a new 
<scm|/:msg:cadet:local:port:close><index|/:msg:cadet:local:port:close>
+  message for closing the port.>
+
+  <\explain>
+    (construct-local-data <var|client-channel-number> <var|priority>
+    <var|data>)<index|construct-local-data>
+  </explain|Construct a new 
<scm|/:msg:cadet:local:data><index|/:msg:cadet:local:data>
+  message for sending <var|data> \ <todo|client\<less\>-\<gtr\>service>
+  <todo|to/from> the channel with identifier <var|client-channel-number> at
+  the priority specified by the numeric priority-preference value
+  <var|priority>.>
+
+  <\explain>
+    <scm|(construct-local-acknowledgement
+    <var|client-channel-number>)><index|construct-local-acknowledgement>
+  </explain|Construct a new 
<scm|/:msg:cadet:local:acknowledgement><index|/:msg:cadet:local:acknowledgemeent>
+  message for the channel with identifier <var|client-channel-number>, for
+  informing the client that the service is ready for more data.>
+
+  <\explain>
+    <scm|(construct-local-channel-create <todo|arguments> <var|#:options>)>
+  </explain|Construct a new <scm|msg:cadet:local:channel:create> message for
+  <todo|which direction? client\<less\>-\<gtr\>service, reasonable options>>
+
+  <\explain>
+    (construct-destroy-local-channel <var|client-channel-number>)
+  <|explain>
+    Construct a new <scm|msg:cadet:local:channel:destroy> message to destroy
+    the channel with identifier <var|client-channel-number>. This can be sent
+    in two directions: from the client to the service, to close the channel,
+    or from service to client, to inform the channel has been closed.
+
+    <todo|Can the service send this without the client requesting this? If
+    the client send this message, will the service send this message in
+    return as an acknowledgment?>
+  </explain>
 </body>
 
 <\initial>

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