Added SILC Thread Queue API

[silc.git] / lib / silcutil / silcfsm.h

diff --git a/lib/silcutil/silcfsm.h b/lib/silcutil/silcfsm.h
index 366edf704406b3cd48033f8d833279f7b1fdda1c..3b1a0d4bed8cf8e0fd006d21403d7e80b7fb4e9a 100644 (file)
--- a/lib/silcutil/silcfsm.h
+++ b/lib/silcutil/silcfsm.h
@@ -405,7 +405,7 @@ do {                                                \
  *    is the caller's scheduler and the FSM will be run in the scheduler.
  *    If `schedule' is NULL this will call silc_schedule_get_global to try
  *    get global scheduler.  Returns NULL on error or if system is out of
- *    memory.
+ *    memory and sets silc_errno.
  *
  * EXAMPLE
  *
@@ -487,7 +487,7 @@ SilcBool silc_fsm_init(SilcFSM fsm,
  *    then the thread will actually be executed in real thread, if platform
  *    supports them.  The `thread_context' is delivered to every state
  *    function in the thread.  Returns NULL on error or if the system is out
- *    of memory.
+ *    of memory and sets silc_errno.
  *
  * NOTES
  *
@@ -498,8 +498,11 @@ SilcBool silc_fsm_init(SilcFSM fsm,
  *    for the FSM thread. If you need scheduler in the real thread it is
  *    strongly recommended that you use the SilcSchedule that is allocated
  *    for the thread.  You can retrieve the SilcSchedule from the thread
- *    using silc_fsm_get_schedule function.  Note that, the allocated
- *    SilcSchedule will become invalid after the thread finishes.
+ *    using silc_fsm_get_schedule function.  The new scheduler is a child
+ *    scheduler of the original scheduler used with `fsm'.  Note that, the
+ *    allocated SilcSchedule will become invalid after the thread finishes.
+ *    Note also that the scheduler is automatically set as global scheduler
+ *    in that thread by calling silc_schedule_set_global.
  *
  *    If `real_thread' is FALSE the silc_fsm_get_schedule will return
  *    the SilcSchedule that was originally given to silc_fsm_alloc or