[gnunet-scheme] 231/324: doc: Document message verifiers.

[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 611b5d52b383150af72c68f81b97dc6304d1cd20
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Fri Sep 3 20:07:59 2021 +0200

    doc: Document message verifiers.
    
    * doc/scheme-gnunet.tm (Message handler): Document the message
      verifier.
---
 doc/scheme-gnunet.tm | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
index 004f9d8..8981b4e 100644
--- a/doc/scheme-gnunet.tm
+++ b/doc/scheme-gnunet.tm
@@ -372,8 +372,17 @@
   components: the <with|font-shape|italic|type> of message it handles, an
   <with|font-shape|italic|interposer> which will be explained later, the
   <with|font-shape|italic|verifier> deciding if a message is well-formed and
-  the <with|font-shape|italic|handler procedure>. <todo|document the message
-  type database, interposer and handler procedure>
+  the <with|font-shape|italic|handler procedure>.
+
+  The verifier is passed a bytevector slice with the message and should
+  return <scm|#true> if the message is well-formed and <scm|#false> if it
+  isn't.<space|1em>It may assume that the length of the slice corresponds to
+  the length <em|in> the message header and is at least the length <em|of>
+  the message header and that the type in the message header corresponds to
+  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>
 
   <subsection|Error handler>
 

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