Change in openbsc[master]: osmux.h: Document enum osmux_state

[Harald Welte]

Harald Welte has submitted this change and it was merged. ( https://gerrit.osmocom.org/11340 )

Change subject: osmux.h: Document enum osmux_state
......................................................................

osmux.h: Document enum osmux_state

Change-Id: If5de6e981e9af7b667dd3365d758f868f38bf6e0
---
M openbsc/include/openbsc/osmux.h
1 file changed, 4 insertions(+), 4 deletions(-)

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



diff --git a/openbsc/include/openbsc/osmux.h b/openbsc/include/openbsc/osmux.h
index f3ea72a..6386125 100644
--- a/openbsc/include/openbsc/osmux.h
+++ b/openbsc/include/openbsc/osmux.h
@@ -26,10 +26,10 @@
 int osmux_used_cid(void);
 
 enum osmux_state {
-	OSMUX_STATE_DISABLED = 0,
-	OSMUX_STATE_NEGOTIATING,
-	OSMUX_STATE_ACTIVATING,
-	OSMUX_STATE_ENABLED,
+	OSMUX_STATE_DISABLED = 0, /* Osmux not being currently used by endp */
+	OSMUX_STATE_NEGOTIATING,  /* Osmux was locally requested in MGCP CRCX */
+	OSMUX_STATE_ACTIVATING,   /* Osmux was accepted in MGCP CRCX ACK. It can now be enabled by \ref osmux_enable_endpoint. */
+	OSMUX_STATE_ENABLED,	  /* Osmux was initialized by \ref osmux_enable_endpoint and can process frames */
 };
 
 enum osmux_usage {

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

Gerrit-Project: openbsc
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: If5de6e981e9af7b667dd3365d758f868f38bf6e0
Gerrit-Change-Number: 11340
Gerrit-PatchSet: 1
Gerrit-Owner: Pau Espin Pedrol <pespin at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder (1000002)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20181015/6bf7aead/attachment.htm>