aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2016-12-09 16:10:34 +0100
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2016-12-09 16:10:46 +0100
commitdda5e7991c5dd55845a176848c6dc98bc37cfe6c (patch)
tree799f99d5c2ec9984dee986b71cbad3d07b71f445
parent0898a007bac173f0a61564914d54d0496a851235 (diff)
doc: fsm timer_cb: explain return value
-rw-r--r--include/osmocom/core/fsm.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h
index 9b6072dc..fba5497b 100644
--- a/include/osmocom/core/fsm.h
+++ b/include/osmocom/core/fsm.h
@@ -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;