|
| ||||||||||||||||||
An interface to a Signalling Transport User Adaptation component
| enum TrafficMode { TrafficUnused = 0, TrafficOverride = 1, TrafficLoadShare = 2, TrafficBroadcast = 3, } | TrafficMode |
Traffic modes
| ~SIGAdaptation ()
| ~SIGAdaptation |
[virtual]
Destructor
| bool initialize (const NamedList* config)
| initialize |
[virtual]
Transport initialization
Parameters:
| config | Configuration section for the adaptation |
Reimplemented from SignallingComponent.
| bool nextTag (const DataBlock& data, int& offset, uint16_t& tag, uint16_t& length)
| nextTag |
[static]
Advance to next tag in a Type-Length-Value set of parameters
Parameters:
| data | Block of data containing TLV parameters |
| offset | Offset of current parameter in block, initialize to negative for first tag |
| tag | Type tag of returned parameter |
| length | Unpadded length of returned parameter in octets |
Returns: True if the current parameter was valid
| bool findTag (const DataBlock& data, int& offset, uint16_t tag, uint16_t& length)
| findTag |
[static]
Find a specific tag in a Type-Length-Value set of parameters
Parameters:
| data | Block of data containing TLV parameters |
| offset | Offset of current parameter in block, gets updated |
| tag | Type tag of searched parameter |
| length | Unpadded length of returned parameter in octets |
Returns: True if the requested parameter was found
| bool getTag (const DataBlock& data, uint16_t tag, uint32_t& value)
| getTag |
[static]
Get the value of a 32 bit integer parameter
Parameters:
| data | Block of data containing TLV parameters |
| tag | Type tag of searched parameter |
| value | Variable to store the decoded parameter if found |
Returns: True if the requested parameter was found and decoded
| bool getTag (const DataBlock& data, uint16_t tag, String& value)
| getTag |
[static]
Get the value of a String parameter
Parameters:
| data | Block of data containing TLV parameters |
| tag | Type tag of searched parameter |
| value | Variable to store the decoded parameter if found |
Returns: True if the requested parameter was found and decoded
| bool getTag (const DataBlock& data, uint16_t tag, DataBlock& value)
| getTag |
[static]
Get the value of a raw binary parameter
Parameters:
| data | Block of data containing TLV parameters |
| tag | Type tag of searched parameter |
| value | Variable to store the decoded parameter if found |
Returns: True if the requested parameter was found and decoded
| void addTag (DataBlock& data, uint16_t tag, uint32_t value)
| addTag |
[static]
Add a 32 bit integer parameter
Parameters:
| data | Block of data containing TLV parameters |
| tag | Type tag of parameter to add |
| value | Value of parameter to add |
| void addTag (DataBlock& data, uint16_t tag, const String& value)
| addTag |
[static]
Add a String parameter
Parameters:
| data | Block of data containing TLV parameters |
| tag | Type tag of parameter to add |
| value | Value of parameter to add |
| void addTag (DataBlock& data, uint16_t tag, const DataBlock& value)
| addTag |
[static]
Add a raw binary parameter
Parameters:
| data | Block of data containing TLV parameters |
| tag | Type tag of parameter to add |
| value | Value of parameter to add |
| explicit SIGAdaptation (const char* name = 0, const NamedList* params = 0,
u_int32_t payload = 0, u_int16_t port = 0)
| SIGAdaptation |
[protected]
Constructs an uninitialized User Adaptation 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 processCommonMSG (unsigned char msgClass,
unsigned char msgType, const DataBlock& msg, int streamId)
| processCommonMSG |
[protected virtual]
Processing of common management messages
Parameters:
| msgClass | Class of the message |
| 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
| bool processMgmtMSG (unsigned char msgType, const DataBlock& msg, int streamId)
| processMgmtMSG |
[protected pure virtual]
Abstract processing of Management messages
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
| bool processAspsmMSG (unsigned char msgType, const DataBlock& msg, int streamId)
| processAspsmMSG |
[protected pure virtual]
Abstract processing of ASP State Maintenance messages
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
| bool processAsptmMSG (unsigned char msgType, const DataBlock& msg, int streamId)
| processAsptmMSG |
[protected pure virtual]
Abstract processing of ASP Traffic Maintenance messages
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
| Generated by: paulc on bussard on Fri Apr 1 18:17:10 2011, using kdoc 2.0a54. |