[gnunet-scheme] 35/42: doc/service-communication: Document #:control-message-handler.

[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 d7b95b6302a02d0f2b02eae66606639aacb70561
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sat Sep 10 14:08:04 2022 +0200

    doc/service-communication: Document #:control-message-handler.
    
    * doc/service-communication.tm (make-loop)[#:control-message-handler]:
    Document it.
---
 doc/service-communication.tm | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/doc/service-communication.tm b/doc/service-communication.tm
index c63b7f0..e418aba 100644
--- a/doc/service-communication.tm
+++ b/doc/service-communication.tm
@@ -593,7 +593,24 @@
       <item*|<scm|#:lost-and-found>>The <reference|lost-and-found> of the
       server.
 
-      <item*|<scm|#:control-message-handler>><todo|>
+      <item*|<scm|#:control-message-handler>>The control message handler is a
+      procedure accepting a control message from the control channel, a
+      procedure <scm|loop>, a procedure <scm|loop*>, a message queue and the
+      state arguments, in that order.
+
+      It must handle the control message (<scm|handle-control-message!> can
+      be useful). After it is handled, it can decide to continue the control
+      message handling loop by calling <scm|loop> or <scm|loop*> in tail
+      position.
+
+      The procedure <scm|loop> accepts as arguments the new state argument
+      and calls the <scm|#:control-message-handler> (i.e. in tail position,
+      and taking the control message handler of the new loop, not the old
+      loop) message and the new state arguments.
+
+      The procedure <scm|loop*> functions likewise, but it has an additional
+      message argument before the other arguments, and instead of taking the
+      next message from the control channel, it uses the passed message.
 
       <item*|<scm|#:make-message-handlers>>This procedure takes the state
       arguments and returns the message handlers (<todo|TODO: document

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