Change in osmo-msc[master]: call_leg: document the parent_event_* items

Neels Hofmeyr gerrit-no-reply at lists.osmocom.org
Fri May 10 13:33:04 UTC 2019


Neels Hofmeyr has submitted this change and it was merged. ( https://gerrit.osmocom.org/13946 )

Change subject: call_leg: document the parent_event_* items
......................................................................

call_leg: document the parent_event_* items

Change-Id: Ib099178a0f6ab218646c67c0e7a3d360c81af684
---
M include/osmocom/msc/call_leg.h
M src/libmsc/call_leg.c
2 files changed, 9 insertions(+), 0 deletions(-)

Approvals:
  Jenkins Builder: Verified
  Pau Espin Pedrol: Looks good to me, but someone else must approve
  Vadim Yanitskiy: Looks good to me, but someone else must approve
  Harald Welte: Looks good to me, approved



diff --git a/include/osmocom/msc/call_leg.h b/include/osmocom/msc/call_leg.h
index 61107ee..d8380f5 100644
--- a/include/osmocom/msc/call_leg.h
+++ b/include/osmocom/msc/call_leg.h
@@ -34,6 +34,7 @@
 	/* Array indexed by enum rtp_direction. */
 	enum mgcp_connection_mode crcx_conn_mode[2];
 
+	/* Events dispatched to the parent fi, see call_leg_alloc() doc. */
 	uint32_t parent_event_rtp_addr_available;
 	uint32_t parent_event_rtp_complete;
 
diff --git a/src/libmsc/call_leg.c b/src/libmsc/call_leg.c
index 1b7db2b..46405bc 100644
--- a/src/libmsc/call_leg.c
+++ b/src/libmsc/call_leg.c
@@ -64,6 +64,14 @@
 	OSMO_ASSERT( osmo_fsm_register(&call_leg_fsm) == 0 );
 }
 
+/* Allocate a call leg FSM instance as child of an arbitrary other FSM instance.
+ * The call leg FSM dispatches events to its parent FSM instance on specific events:
+ * - parent_event_term: dispatch this to the parent FI when the call leg terminates (call ended, either planned or by
+ *   failure).
+ * - parent_event_rtp_addr_available: one of the rtp_stream instances managed by the call leg has received an RTP
+ *   address from the MGW. The struct rtp_stream instance is passed as data argument for the event dispatch.
+ * - parent_event_rtp_complete: one of the rtp_stream instances entered the RTP_STREAM_ST_ESTABLISHED state.
+ */
 struct call_leg *call_leg_alloc(struct osmo_fsm_inst *parent_fi,
 				uint32_t parent_event_term,
 				uint32_t parent_event_rtp_addr_available,

-- 
To view, visit https://gerrit.osmocom.org/13946
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-msc
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: Ib099178a0f6ab218646c67c0e7a3d360c81af684
Gerrit-Change-Number: 13946
Gerrit-PatchSet: 2
Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder (1000002)
Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Pau Espin Pedrol <pespin at sysmocom.de>
Gerrit-Reviewer: Vadim Yanitskiy <axilirator at gmail.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190510/be6ad284/attachment.html>


More information about the gerrit-log mailing list