[gnunet-scheme] 33/42: server: Document 'make-loop'.

[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 31b340daafd5477a44ab13fb780488f5cef8e7d7
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sat Sep 10 13:14:17 2022 +0200

    server: Document 'make-loop'.
---
 doc/service-communication.tm | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/doc/service-communication.tm b/doc/service-communication.tm
index f23848b..c63b7f0 100644
--- a/doc/service-communication.tm
+++ b/doc/service-communication.tm
@@ -565,6 +565,42 @@
     <scm|#:control-message-handler>, in that order, as state arguments.
   </explain>
 
+  <\explain>
+    <scm|(make-loop keyword-arguments <text-dots>)>
+  <|explain>
+    Make a loop. Unless mentioned otherwise, all mentioned keyword arguments
+    are required to be set. Non-mentioned keyword arguments can be passed to
+    <scm|make-loop> but will be ignored.
+
+    <\description>
+      <item*|<scm|#:connected>, <scm|#:disconnected>>(optional) See the
+      <reference|server object> pattern. They can be accessed with
+      <scm|loop:connected> and <scm|loop:disconnected> respectively.
+
+      <item*|<scm|#:configuration>>The <reference|configuration> to use for
+      this loop. This module uses it for connecting to the service, but it
+      can be used by the service client code as well, by accessing it with
+      <scm|loop:configuration>.
+
+      <item*|<scm|#:service-name>>The name of the service to pass to
+      <scm|connect/fibers> (a string). This must match the name used in the
+      configuration. It can be accessed with <scm|loop:service-name>.
+
+      <item*|<scm|#:terminal-condition>>The terminal condition of the server.
+
+      <item*|<scm|#:control-channel>>The control channel of the server.
+
+      <item*|<scm|#:lost-and-found>>The <reference|lost-and-found> of the
+      server.
+
+      <item*|<scm|#:control-message-handler>><todo|>
+
+      <item*|<scm|#:make-message-handlers>>This procedure takes the state
+      arguments and returns the message handlers (<todo|TODO: document
+      <scm|message-handlers>>).
+    </description>
+  </explain>
+
   <\explain>
     <scm|(maybe-send-control-message! <var|server> . <var|message>)>
   <|explain>

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