osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 0
Code Issues Releases Wiki Activity

doc: fsm timer_cb: explain return value 

Change-Id: Ic6fbe95737862ed8b8de78058989c8b2ae330006
This commit is contained in:
Neels Hofmeyr 2016-12-09 16:10:34 +01:00
parent 0898a007ba
commit dda5e7991c
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
include/osmocom/core/fsm.h
View File

@ -64,7 +64,8 @@ struct osmo_fsm {
void (*allstate_action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
/*! \breif clean-up function, called during termination */
void (*cleanup)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause);
/*! \brief timer call-back for states with time-out */
/*! \brief timer call-back for states with time-out.
* \returns 1 to request termination, 0 to keep running. */
int (*timer_cb)(struct osmo_fsm_inst *fi);
/*! \brief logging sub-system for this FSM */
int log_subsys;