Changes between Version 10 and Version 11 of TrickleApi

Timestamp:

Aug 2, 2018, 12:31:46 PM (6 years ago)

Author:

davea

Comment:

--

TrickleApi

@@ -22 +22 @@
 == Server-side API ==
 
+=== Handling trickle-up messages ===
+
 To handle trickle-up messages, use a 'trickle_handler' daemon.
-This is a program, based on sched/trickle_handler.cpp, linked with a function
+This is a program, based on sched/trickle_handler.cpp, linked with functions
 
 {{{
-int handle_trickle(MSG_FROM_HOST&);
+int handle_trickle_init(int argc, char** argv);     // initialize
+int handle_trickle(MSG_FROM_HOST&);                 // handle a trickle message
 
 struct MSG_FROM_HOST {
@@ -40 +43 @@
 The daemon must be passed a '--variety X' command-line argument, telling it what kind of messages to handle.
 The daemon should be specified in the [ProjectDaemons project configuration file].
+
+By default, a trickle handler daemon enumerates msg_from_host records with handled==0,
+and when done sets handled=1.
+If you need multiple stages of trickle handling,
+you can do so by assigning '''handled_enum''' and '''handled_set''' in handle_trickle_init().
+For example, by setting these to 1 and 2 respectively you can add a 2nd stage of handling.
+
+
+=== Sending trickle-down messages ===
 
 To send trickle-down messages (from a trickle handler daemon or other program) you must insert a record in the 'msg_to_host' table.