[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-scheme] 38/42: doc/service-communication: Add procedures to the
From: |
gnunet |
Subject: |
[gnunet-scheme] 38/42: doc/service-communication: Add procedures to the index. |
Date: |
Sat, 10 Sep 2022 19:08:31 +0200 |
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 e81e5d90a52043e5953b1e4974d9d1e60b35a5d2
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sat Sep 10 18:52:53 2022 +0200
doc/service-communication: Add procedures to the index.
---
doc/service-communication.tm | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/doc/service-communication.tm b/doc/service-communication.tm
index 9491e69..1b5ff16 100644
--- a/doc/service-communication.tm
+++ b/doc/service-communication.tm
@@ -378,7 +378,8 @@
code:
<\explain>
- <scm|(garbage-collectable <var|service> <var|connect>)>
+ <scm|(garbage-collectable <var|service>
+ <var|connect>)><index|garbage-collectable>
<|explain>
Test that the server object is properly garbage collectable \U i.e., make
sure that when the server object is not used anymore, all new fibers are
@@ -398,7 +399,7 @@
<\explain>
<scm|(close-not-connected-no-callbacks <var|service> <var|connect>
- <var|disconnect!> #:rest)>
+ <var|disconnect!> #:rest)><index|close-not-connected-no-callbacks>
<|explain>
This tests the connection and disconnection callbacks. It verifies that
if the service daemon is down, the connection and disconnection callbacks
@@ -409,7 +410,8 @@
</explain>
<\explain>
- <scm|(connect-after-eof-after-connected <var|service> <var|connect>)>
+ <scm|(connect-after-eof-after-connected <var|service>
+ <var|connect>)><index|connect-after-eof-after-connected>
</explain|This tests the connection and disconnection callbacks, in case
the server disconnects without sending or receiving anything.<space|1em>It
verifies that the connection and disconnection callback is called and that
@@ -417,7 +419,7 @@
reconnection.>
<\explain>
- <scm|(reconnects service <var|service> <var|connect>)>
+ <scm|(reconnects service <var|service> <var|connect>)><index|reconnects>
</explain|This tests the reconnection logic, by repeatedly closing the
connection from the server side and verifying that the connection and
disconnection callbacks are called in the right order and sufficiently
@@ -425,7 +427,8 @@
<\explain>
<scm|(determine-reported-errors <var|service> <var|connect> <var|proc>
- #:key (<var|n-connections> 1) (<var|n-errors> 1))>
+ #:key (<var|n-connections> 1) (<var|n-errors>
+ 1))><index|determine-reported-errors>
<|explain>
This is not a test by itself, but can be used as basis for writing tests
on error reporting logic. It connects to a service simulated by
@@ -541,7 +544,7 @@
<\explain>
<scm|(spawn-server-loop server #:make-loop #:initial-extra-loop-arguments
- <text-dots>)>
+ <text-dots>)><index|spawn-server-loop>
<|explain>
Make the loop for <var|server> and enter it in the background.
@@ -569,7 +572,7 @@
</explain>
<\explain>
- <scm|(run-loop <var|loop> . <var|other-state>)>
+ <scm|(run-loop <var|loop> . <var|other-state>)><index|run-loop>
</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
@@ -580,7 +583,7 @@
tail position.>
<\explain>
- <scm|(make-loop keyword-arguments <text-dots>)>
+ <scm|(make-loop keyword-arguments <text-dots>)><index|make-loop>
<|explain>
Make a loop. Unless mentioned otherwise, all mentioned keyword arguments
are required to be set. Non-mentioned keyword arguments can be passed to
@@ -633,7 +636,8 @@
</explain>
<\explain>
- <scm|(maybe-send-control-message! <var|server> . <var|message>)>
+ <scm|(maybe-send-control-message! <var|server> .
+ <var|message>)><index|maybe-send-control-message!>
<|explain>
Maybe-send the message <var|message> to the service. If sent, return
<scm|#true>. If the control loop is not active anymore (i.e., the
@@ -642,7 +646,7 @@
<\explain>
<scm|(maybe-send-control-message!* <var|terminal-condition>
- <var|control-channel> . <var|message>)>
+ <var|control-channel> . <var|message>)><index|maybe-send-control-message!*>
</explain|This is like <scm|maybe-send-control-message!>, except it doesn't
need a reference to the <scm|\<less\>server\<gtr\>> object, which sometimes
is required for GC reasons.>
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet-scheme] 24/42: cadet/client: Re-indent., (continued)
- [gnunet-scheme] 24/42: cadet/client: Re-indent., gnunet, 2022/09/10
- [gnunet-scheme] 33/42: server: Document 'make-loop'., gnunet, 2022/09/10
- [gnunet-scheme] 30/42: doc/service-communication: Document the control loop., gnunet, 2022/09/10
- [gnunet-scheme] 18/42: cadet/client: Rewrite with run-loop., gnunet, 2022/09/10
- [gnunet-scheme] 32/42: server: Add type checking to make-loop., gnunet, 2022/09/10
- [gnunet-scheme] 36/42: doc/concurrency: Add missing label for lost-and-found., gnunet, 2022/09/10
- [gnunet-scheme] 39/42: server: Add type checking., gnunet, 2022/09/10
- [gnunet-scheme] 35/42: doc/service-communication: Document #:control-message-handler., gnunet, 2022/09/10
- [gnunet-scheme] 37/42: doc/service-communication: Document run-loop., gnunet, 2022/09/10
- [gnunet-scheme] 34/42: server: Rename control -> continue., gnunet, 2022/09/10
- [gnunet-scheme] 38/42: doc/service-communication: Add procedures to the index.,
gnunet <=
- [gnunet-scheme] 40/42: doc/service-communication: Add missing argument of make-disconnect!., gnunet, 2022/09/10
- [gnunet-scheme] 41/42: NEWS: Update., gnunet, 2022/09/10
- [gnunet-scheme] 42/42: Merge branch 'server-unification', gnunet, 2022/09/10