Yate
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
SIGAdaptation Class Reference

Abstract SIGTRAN User Adaptation component. More...

#include <yatesig.h>

Inheritance diagram for SIGAdaptation:
SignallingComponent SIGTRAN Mutex RefObject DebugEnabler Lockable GenObject SIGAdaptClient SIGAdaptServer ISDNIUAClient SS7M2UAClient

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

Traffic modes


Constructor & Destructor Documentation

virtual ~SIGAdaptation ( ) [virtual]

Destructor

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:
nameName of this component
paramsOptional pointer to creation parameters
payloadSCTP payload code, ignored for other transports
portSCTP/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:
dataBlock of data containing TLV parameters
tagType tag of parameter to add
valueValue of parameter to add
static void addTag ( DataBlock data,
uint16_t  tag,
const String value 
) [static]

Add a String parameter

Parameters:
dataBlock of data containing TLV parameters
tagType tag of parameter to add
valueValue of parameter to add
static void addTag ( DataBlock data,
uint16_t  tag,
const DataBlock value 
) [static]

Add a raw binary parameter

Parameters:
dataBlock of data containing TLV parameters
tagType tag of parameter to add
valueValue 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:
dataBlock of data containing TLV parameters
offsetOffset of current parameter in block, gets updated
tagType tag of searched parameter
lengthUnpadded 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:
dataBlock of data containing TLV parameters
tagType tag of searched parameter
valueVariable to store the decoded parameter if found
Returns:
True if the requested parameter was found and decoded
static bool getTag ( const DataBlock data,
uint16_t  tag,
String value 
) [static]

Get the value of a String parameter

Parameters:
dataBlock of data containing TLV parameters
tagType tag of searched parameter
valueVariable to store the decoded parameter if found
Returns:
True if the requested parameter was found and decoded
static bool getTag ( const DataBlock data,
uint16_t  tag,
DataBlock value 
) [static]

Get the value of a raw binary parameter

Parameters:
dataBlock of data containing TLV parameters
tagType tag of searched parameter
valueVariable to store the decoded parameter if found
Returns:
True if the requested parameter was found and decoded
virtual bool initialize ( const NamedList config) [virtual]

Transport initialization

Parameters:
configConfiguration section for the adaptation

Reimplemented from SignallingComponent.

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:
dataBlock of data containing TLV parameters
offsetOffset of current parameter in block, initialize to negative for first tag
tagType tag of returned parameter
lengthUnpadded length of returned parameter in octets
Returns:
True if the current parameter was valid
virtual bool processAspsmMSG ( unsigned char  msgType,
const DataBlock msg,
int  streamId 
) [protected, pure virtual]

Abstract processing of ASP State Maintenance messages

Parameters:
msgTypeType of the message, depends on the class
msgMessage data, may be empty
streamIdIdentifier of the stream the message was received on
Returns:
True if the message was handled

Implemented in SIGAdaptServer, and SIGAdaptClient.

virtual bool processAsptmMSG ( unsigned char  msgType,
const DataBlock msg,
int  streamId 
) [protected, pure virtual]

Abstract processing of ASP Traffic Maintenance messages

Parameters:
msgTypeType of the message, depends on the class
msgMessage data, may be empty
streamIdIdentifier 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:
msgClassClass of the message
msgTypeType of the message, depends on the class
msgMessage data, may be empty
streamIdIdentifier 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:
msgTypeType of the message, depends on the class
msgMessage data, may be empty
streamIdIdentifier 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: