[MERGED] libosmocore[master]: doc: fsm timer_cb: explain return value

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Harald Welte gerrit-no-reply at lists.osmocom.org
Fri Dec 9 15:35:08 UTC 2016


Harald Welte has submitted this change and it was merged.

Change subject: doc: fsm timer_cb: explain return value
......................................................................


doc: fsm timer_cb: explain return value

Change-Id: Ic6fbe95737862ed8b8de78058989c8b2ae330006
---
M include/osmocom/core/fsm.h
1 file changed, 2 insertions(+), 1 deletion(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h
index 9b6072d..fba5497 100644
--- a/include/osmocom/core/fsm.h
+++ b/include/osmocom/core/fsm.h
@@ -64,7 +64,8 @@
 	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;

-- 
To view, visit https://gerrit.osmocom.org/1400
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Ic6fbe95737862ed8b8de78058989c8b2ae330006
Gerrit-PatchSet: 1
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder



More information about the gerrit-log mailing list