[gnunet-scheme] 37/42: doc/service-communication: Document run-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 f988c2da612571a08fba845cdd0c2544637fee1c
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sat Sep 10 18:50:43 2022 +0200

    doc/service-communication: Document run-loop.
---
 doc/service-communication.tm | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/doc/service-communication.tm b/doc/service-communication.tm
index e418aba..9491e69 100644
--- a/doc/service-communication.tm
+++ b/doc/service-communication.tm
@@ -11,9 +11,9 @@
     The C implementation supports Internet sockets as well.
   </footnote> somewhere on the file system and the client (possibly another
   service) must connect to it.<space|1em>Connections to a service can be made
-  with the <scm|connect/fibers><index|connect/fibers> procedure from
-  <scm|(gnu gnunet mq-impl stream)><index|(gnu gnunet mq-impl stream)>, like
-  this:
+  with the <scm|connect/fibers><index|connect/fibers><label|connect/fibers>
+  procedure from <scm|(gnu gnunet mq-impl stream)><index|(gnu gnunet mq-impl
+  stream)>, like this:
 
   <\scm-code>
     (define mq (connect/fibers config "nse" handlers error-handler))
@@ -563,8 +563,22 @@
     pass. By default, it is an empty list. When entering the loop, the loop
     itself and the <var|initial-extra-loop-arguments> are passed to the
     <scm|#:control-message-handler>, in that order, as state arguments.
+
+    What \<#2018\>entering a loop\<#2019\> entails, is described in the
+    documentation of <scm|run-loop>.
   </explain>
 
+  <\explain>
+    <scm|(run-loop <var|loop> . <var|other-state>)>
+  </explain|Enter the loop <var|loop>, in tail position. The initial state
+  arguments are <scm|loop . other-state>. This asynchronuously connects to
+  the service with <reference|connect/fibers>, using the service name and
+  configuration of <var|loop> and calls the control message handler with the
+  first control message, the procedures <scm|continue> and <scm|continue*>
+  mentioned in the documentation of <scm|make-loop>, the message queue of
+  <scm|connect/fibers>, <var|loop> and the <var|other-state> arguments, in
+  tail position.>
+
   <\explain>
     <scm|(make-loop keyword-arguments <text-dots>)>
   <|explain>

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