From dda5e7991c5dd55845a176848c6dc98bc37cfe6c Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Fri, 9 Dec 2016 16:10:34 +0100 Subject: doc: fsm timer_cb: explain return value Change-Id: Ic6fbe95737862ed8b8de78058989c8b2ae330006 --- include/osmocom/core/fsm.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'include/osmocom/core') 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; -- cgit v1.2.3