[gnunet-scheme] 232/324: doc: Partially document handler procedures and interposers.

[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 b582b55c5603acddf0a4ed237a1d84390f26948d
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Fri Sep 3 20:56:34 2021 +0200

    doc: Partially document handler procedures and interposers.
    
    * doc/scheme-gnunet.tm (Message handler): Document the handler
      procedure and the interposer somewhat.
---
 doc/scheme-gnunet.tm | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
index 8981b4e..3b60d46 100644
--- a/doc/scheme-gnunet.tm
+++ b/doc/scheme-gnunet.tm
@@ -355,7 +355,7 @@
 
     \ \ \ (symbol-value message-type msg:util:dummy)
 
-    \ \ \ (lambda (p) (p))
+    \ \ \ (lambda (thunk) (thunk))
 
     \ \ \ (lambda (slice)
 
@@ -382,7 +382,15 @@
   the type of the message handler.<space|1em>Messages will only be passed to
   the handler procedue if the verifiers returns <scm|#true>.
 
-  <todo|document the message type database, interposer and handler procedure>
+  The handler procedure is passed a bytevector slice with the message, but
+  only if the verifier considers it well-formed.<space|1em>The handler
+  procedure and verifier are run from the
+  <with|font-shape|italic|interposer>.<space|1em>The interposer is passed a
+  thunk to execute and may e.g. install exception handlers and parameterise
+  parameters.<space|1em>It can change the current input, output and error
+  ports for example.
+
+  <todo|document the message type database, various procedures>
 
   <subsection|Error handler>
 

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