oxen-io
/
oxen-mq
mirror of https://github.com/oxen-io/oxen-mq.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc fix - remove "init" and update "start" doc 

init() got removed during the tagged threads PR, but the documentation
didn't get updated.  Fixed it.
This commit is contained in:
Jason Rhinelander 2020-06-30 18:48:09 -03:00
parent 932bbb33d7
commit 9c54264321
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lokimq/lokimq.h
View File

@ -865,12 +865,9 @@ public:
*
* \param name - the name of the thread; will be used in log messages and (if supported by the
* OS) as the system thread name.
* \param init - an optional callback to invoke from the thread immediately after creating it.
* This can be used to perform initialization, however should not depend on LokiMQ having
* started.
*
* \param start - similar to init, but this is called immediately *after* the LokiMQ object has
* started up and so can use LokiMQ object functionality.
* \param start - an optional callback to invoke from the thread as soon as LokiMQ itself starts
* up (i.e. after a call to `start()`).
*
* \returns a TaggedThreadID object that can be passed to job(), batch(), or add_timer() to
* direct the task to the tagged thread.