Finite State Machine SilcFSM SilcFSMStruct SilcFSMThread SilcFSMThreadStruct SILC_FSM_CONTINUE SILC_FSM_YIELD SILC_FSM_WAIT SILC_FSM_FINISH SilcFSMDestructor SilcFSMThreadDestructor SILC_FSM_STATE SILC_FSM_CALL SILC_FSM_CALL_CONTINUE SILC_FSM_CALL_CONTINUE_SYNC SILC_FSM_THREAD_WAIT silc_fsm_alloc silc_fsm_init silc_fsm_thread_alloc silc_fsm_thread_init silc_fsm_free silc_fsm_start silc_fsm_start_sync silc_fsm_next silc_fsm_next_later silc_fsm_continue silc_fsm_continue_sync silc_fsm_finish silc_fsm_set_context silc_fsm_get_context silc_fsm_set_state_context silc_fsm_get_state_context silc_fsm_get_schedule silc_fsm_get_machine silc_fsm_is_started SilcFSMEvent SilcFSMEventStruct silc_fsm_event_alloc silc_fsm_event_init silc_fsm_event_free SILC_FSM_EVENT_WAIT SILC_FSM_EVENT_TIMEDWAIT SILC_FSM_EVENT_SIGNAL

silc_fsm_alloc

SYNOPSIS

    SilcFSM silc_fsm_alloc(void *fsm_context,
                           SilcFSMDestructor destructor,
                           void *destructor_context,
                           SilcSchedule schedule);

DESCRIPTION

Allocates SILC Finite State Machine context. The `destructor' with `destructor_context' will be called when the machines finishes. The caller must free the returned context with silc_fsm_free. The `fsm_context' is delivered to every FSM state function. The `schedule' 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 and sets silc_errno.

EXAMPLE

    SilcAsyncOperation silc_async_call(Callback callback, void *cb_context)
    {
      SilcAsyncOperation op;
      SilcFSM fsm;
      ...

      // Allocate async operation so that caller can control us, like abort
      op = silc_async_alloc(silc_async_call_abort, NULL, ourcontext);

      // Start FSM
      fsm = silc_fsm_alloc(ourcontext, fsm_destructor, ourcontext,
                           schedule);
      silc_fsm_start(fsm, first_state);
      ...

      // Return async operation for upper layer
      return op;
    }