|
|
Generic client side (ASP) Signalling Transport User Adaptation component
| enum AspState { AspDown = 0, AspUpRq, AspUp, AspActRq, AspActive } | AspState |
ASP Client states
| explicit SIGAdaptClient (const char* name = 0, const NamedList* params = 0,
u_int32_t payload = 0, u_int16_t port = 0)
| SIGAdaptClient |
[protected]
Constructs an uninitialized User Adaptation client component
Parameters:
| name | Name of this component |
| params | Optional pointer to creation parameters |
| payload | SCTP payload code, ignored for other transports |
| port | SCTP/TCP/UDP default port used for transport |
| bool processMgmtMSG (unsigned char msgType, const DataBlock& msg, int streamId)
| processMgmtMSG |
[protected virtual]
Process Management messages as ASP
Parameters:
| msgType | Type of the message, depends on the class |
| msg | Message data, may be empty |
| streamId | Identifier of the stream the message was received on |
Returns: True if the message was handled
Reimplemented from SIGAdaptation.
| bool processAspsmMSG (unsigned char msgType, const DataBlock& msg, int streamId)
| processAspsmMSG |
[protected virtual]
Process ASP State Maintenance messages as ASP
Parameters:
| msgType | Type of the message, depends on the class |
| msg | Message data, may be empty |
| streamId | Identifier of the stream the message was received on |
Returns: True if the message was handled
Reimplemented from SIGAdaptation.
| bool processAsptmMSG (unsigned char msgType, const DataBlock& msg, int streamId)
| processAsptmMSG |
[protected virtual]
Process ASP Traffic Maintenance messages as ASP
Parameters:
| msgType | Type of the message, depends on the class |
| msg | Message data, may be empty |
| streamId | Identifier of the stream the message was received on |
Returns: True if the message was handled
Reimplemented from SIGAdaptation.
| void activeChange (bool active)
| activeChange |
[protected virtual]
Traffic activity state change notification
Parameters:
| active | True if the ASP is active and traffic is allowed |
| inline bool aspUp ()
| aspUp |
[protected const]
Check if the ASP is Up
Returns: True if the ASPSM is in UP state
| inline bool aspActive ()
| aspActive |
[protected const]
Check if the ASP is Active
Returns: True if the ASPTM is in ACTIVE state
| bool activate ()
| activate |
[protected]
Request activation of the ASP
Returns: True if ASP activation started, false on failure
| void setState (AspState state, bool notify = true)
| setState |
[protected]
Set the state of the ASP, notify user components of changes
Parameters:
| state | New state of the ASP |
| notify | True to notify user layers, false if the changes are internal |
| inline ObjList& users ()
| users |
[protected]
Get access to the list of Adaptation Users of this component
Returns: Reference to the list of Adaptation Users
| int32_t m_aspId | m_aspId |
[protected]
| TrafficMode m_traffic | m_traffic |
[protected]
| Generated by: paulc on bussard on Fri Apr 1 18:17:10 2011, using kdoc 2.0a54. |