Abstract SIGTRAN User Adaptation component.
More...
#include <yatesig.h>
List of all members.
Public Types |
enum | TrafficMode { TrafficUnused = 0,
TrafficOverride = 1,
TrafficLoadShare = 2,
TrafficBroadcast = 3
} |
Public Member Functions |
virtual | ~SIGAdaptation () |
virtual bool | initialize (const NamedList *config) |
Static Public Member Functions |
static bool | nextTag (const DataBlock &data, int &offset, uint16_t &tag, uint16_t &length) |
static bool | findTag (const DataBlock &data, int &offset, uint16_t tag, uint16_t &length) |
static bool | getTag (const DataBlock &data, uint16_t tag, uint32_t &value) |
static bool | getTag (const DataBlock &data, uint16_t tag, String &value) |
static bool | getTag (const DataBlock &data, uint16_t tag, DataBlock &value) |
static void | addTag (DataBlock &data, uint16_t tag, uint32_t value) |
static void | addTag (DataBlock &data, uint16_t tag, const String &value) |
static void | addTag (DataBlock &data, uint16_t tag, const DataBlock &value) |
Protected Member Functions |
| SIGAdaptation (const char *name=0, const NamedList *params=0, u_int32_t payload=0, u_int16_t port=0) |
virtual bool | processCommonMSG (unsigned char msgClass, unsigned char msgType, const DataBlock &msg, int streamId) |
virtual bool | processMgmtMSG (unsigned char msgType, const DataBlock &msg, int streamId)=0 |
virtual bool | processAspsmMSG (unsigned char msgType, const DataBlock &msg, int streamId)=0 |
virtual bool | processAsptmMSG (unsigned char msgType, const DataBlock &msg, int streamId)=0 |
Detailed Description
Abstract SIGTRAN User Adaptation component.
An interface to a Signalling Transport User Adaptation component
Member Enumeration Documentation
Constructor & Destructor Documentation
SIGAdaptation |
( |
const char * |
name = 0 , |
|
|
const NamedList * |
params = 0 , |
|
|
u_int32_t |
payload = 0 , |
|
|
u_int16_t |
port = 0 |
|
) |
| [explicit, 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 |
Member Function Documentation
static void addTag |
( |
DataBlock & |
data, |
|
|
uint16_t |
tag, |
|
|
uint32_t |
value |
|
) |
| [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 |
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 |
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 |
static bool findTag |
( |
const DataBlock & |
data, |
|
|
int & |
offset, |
|
|
uint16_t |
tag, |
|
|
uint16_t & |
length |
|
) |
| [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
static bool getTag |
( |
const DataBlock & |
data, |
|
|
uint16_t |
tag, |
|
|
uint32_t & |
value |
|
) |
| [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
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
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
static bool nextTag |
( |
const DataBlock & |
data, |
|
|
int & |
offset, |
|
|
uint16_t & |
tag, |
|
|
uint16_t & |
length |
|
) |
| [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
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
Implemented in SIGAdaptServer, and SIGAdaptClient.
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
Implemented in SIGAdaptServer, and SIGAdaptClient.
virtual bool processCommonMSG |
( |
unsigned char |
msgClass, |
|
|
unsigned char |
msgType, |
|
|
const DataBlock & |
msg, |
|
|
int |
streamId |
|
) |
| [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
virtual bool processMgmtMSG |
( |
unsigned char |
msgType, |
|
|
const DataBlock & |
msg, |
|
|
int |
streamId |
|
) |
| [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
Implemented in SIGAdaptServer, and SIGAdaptClient.
The documentation for this class was generated from the following file: