[gnunet-scheme] 83/324: Document the current state of message queues.

[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 769aee2362223e64360e58376c1b625be605a66b
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Wed Feb 17 22:42:13 2021 +0100

    Document the current state of message queues.
    
    * README.org
      (Modules): new subsection ‘Message queues’.
      (Conventions): new subsection ‘Documenting modules’.
---
 README.org | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/README.org b/README.org
index 3a1ee1f..46ac13d 100644
--- a/README.org
+++ b/README.org
@@ -45,15 +45,28 @@
   + a nice Scheme interface to GNUnet!
 * Modules
   + gnu/gnunet/directory.scm: directory construction
-  + gnu/gnunet/util/mq.scm and friends: message queues for
-    network messages, and calling an appropriate handler for
-    each message type.
   + gnu/gnunet/message/envelope.scm: some program data around
     message types (e.g. priority, notify on sent hook)
   + gnu/gnunet/concurrency/update.scm: a box with a value,
     that can be updated, resulting in a new box.  Updates
     can be waited upon.
 
+** Message queues
+   + gnu/gnunet/util/mq.scm: message priorities & preferences
+
+     Preferences: is out-of-order allowed or not,
+     should the message be corked or not ...
+
+     TODO rename to gnu/gnunet/mq/priority.scm
+   + gnu/gnunet/util/mq-handler.scm: what to do in
+     response to a message.
+
+     Different message types may need need different
+     capabilities; the interposition can be used to adjust
+     the ambient authority appropriately.
+
+     TODO rename to gnu/gnunet/mq/handler.scm
+   + TODO actual queues?  Maybe we don't need them?
 ** Network structures
    Features:
 
@@ -87,6 +100,8 @@
      are created when accessing network structures with
      (gnu gnunet netstruct syntactic).
 * Conventions
+** Documenting modules
+   Add a little information to ‘* Modules’.
 ** Fiddling with options
    Options like ‘priority’, ‘anonymity’, ‘replication’
    and ‘no-index’ should be ‘passed’ using SRFI-39 parameters,

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