[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-scheme] 233/324: doc: Document the message type database a littl
From: |
gnunet |
Subject: |
[gnunet-scheme] 233/324: doc: Document the message type database a little. |
Date: |
Tue, 21 Sep 2021 13:24:33 +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 643d42dd635d2c8937f92de34bf24b8119e16429
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Fri Sep 3 22:48:10 2021 +0200
doc: Document the message type database a little.
* doc/scheme-gnunet.tm (Message type database): New section.
---
doc/scheme-gnunet.tm | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
index 3b60d46..8050718 100644
--- a/doc/scheme-gnunet.tm
+++ b/doc/scheme-gnunet.tm
@@ -392,6 +392,26 @@
<todo|document the message type database, various procedures>
+ <subsection|Message type database>
+
+ The module <scm|(gnu gnunet message protocols)> has a mapping of symbolic
+ names of every message type known to scheme-GNUnet to their numeric
+ value.<space|1em>To use it, the macro <scm|symbol-value> from <scm|(gnu
+ extractor enum)> is required and possibly <scm|value-\<gtr\>index> as
+ well.<space|1em>To determine the numeric value of the message type
+ <scm|msg:nse:estimate>, one would write:
+
+ <\scm-code>
+ (define numeric-type
+
+ \ \ (value-\<gtr\>index (symbol-value message-type msg:nse:estimate)))
+ </scm-code>
+
+ <todo|other various enum procedures for introspection, documentation,
+ <text-dots>?>
+
+ <todo|how to define new message types>
+
<subsection|Error handler>
The message queue implementation usually just sends and receives messages,
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet-scheme] 229/324: guix: Import missing module., (continued)
- [gnunet-scheme] 229/324: guix: Import missing module., gnunet, 2021/09/21
- [gnunet-scheme] 194/324: mq-impl/stream: Eliminate atomic box., gnunet, 2021/09/21
- [gnunet-scheme] 191/324: doc: Document message queue error handling., gnunet, 2021/09/21
- [gnunet-scheme] 216/324: mq: Inject errors if no appropriate message handler exists., gnunet, 2021/09/21
- [gnunet-scheme] 190/324: Correct XXX and TODO on input:regular-end-of-file., gnunet, 2021/09/21
- [gnunet-scheme] 196/324: mq-impl/stream: Stop all fibers when EOF is reached (part 1)., gnunet, 2021/09/21
- [gnunet-scheme] 201/324: tests/mq-stream: Make test more strict., gnunet, 2021/09/21
- [gnunet-scheme] 204/324: mq-impl/stream: Document implementation pitfall., gnunet, 2021/09/21
- [gnunet-scheme] 214/324: tests/mq: Use 'message-handler' macro., gnunet, 2021/09/21
- [gnunet-scheme] 217/324: tests/mq: Spam the log less., gnunet, 2021/09/21
- [gnunet-scheme] 233/324: doc: Document the message type database a little.,
gnunet <=
- [gnunet-scheme] 232/324: doc: Partially document handler procedures and interposers., gnunet, 2021/09/21
- [gnunet-scheme] 239/324: tests/network-size: Don't let the GC close port., gnunet, 2021/09/21
- [gnunet-scheme] 241/324: nse/client: Add a 'disconnected' callback., gnunet, 2021/09/21
- [gnunet-scheme] 195/324: mq-impl/stream: Reduce nesting., gnunet, 2021/09/21
- [gnunet-scheme] 200/324: mq-impl/stream: Make error injection less unobviously correct., gnunet, 2021/09/21
- [gnunet-scheme] 210/324: mq-stream: Reuse 'type' variable instead of reading the type again., gnunet, 2021/09/21
- [gnunet-scheme] 219/324: mq-impl/stream: Create the message queue as late as possible., gnunet, 2021/09/21
- [gnunet-scheme] 230/324: doc: Correct errors in ‘network structure’ section., gnunet, 2021/09/21
- [gnunet-scheme] 235/324: doc: Document how errors and received/sent messages are ordered., gnunet, 2021/09/21
- [gnunet-scheme] 199/324: guix: Use patched version of guile-fibers., gnunet, 2021/09/21