Yate
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
SIGAdaptClient Class Reference

Client side SIGTRAN User Adaptation component. More...

#include <yatesig.h>

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

List of all members.

Public Types

enum  AspState {
  AspDown = 0, AspUpRq, AspUp, AspActRq,
  AspActive
}

Public Member Functions

virtual void notifyLayer (SignallingInterface::Notification status)

Protected Member Functions

 SIGAdaptClient (const char *name=0, const NamedList *params=0, u_int32_t payload=0, u_int16_t port=0)
virtual bool processMgmtMSG (unsigned char msgType, const DataBlock &msg, int streamId)
virtual bool processAspsmMSG (unsigned char msgType, const DataBlock &msg, int streamId)
virtual bool processAsptmMSG (unsigned char msgType, const DataBlock &msg, int streamId)
virtual void activeChange (bool active)
bool aspUp () const
bool aspActive () const
bool activate ()
void setState (AspState state, bool notify=true)
ObjListusers ()

Protected Attributes

int32_t m_aspId
TrafficMode m_traffic

Friends

class SIGAdaptUser

Detailed Description

Client side SIGTRAN User Adaptation component.

Generic client side (ASP) Signalling Transport User Adaptation component


Member Enumeration Documentation

enum AspState

ASP Client states


Constructor & Destructor Documentation

SIGAdaptClient ( 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 client 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

bool activate ( ) [protected]

Request activation of the ASP

Returns:
True if ASP activation started, false on failure
virtual void activeChange ( bool  active) [protected, virtual]

Traffic activity state change notification

Parameters:
activeTrue if the ASP is active and traffic is allowed
bool aspActive ( ) const [inline, protected]

Check if the ASP is Active

Returns:
True if the ASPTM is in ACTIVE state
bool aspUp ( ) const [inline, protected]

Check if the ASP is Up

Returns:
True if the ASPSM is in UP state
virtual void notifyLayer ( SignallingInterface::Notification  status) [virtual]

Method called when the transport status has been changed

Parameters:
statusStatus of the transport causing the notification

Reimplemented from SIGTRAN.

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

Process ASP State Maintenance messages as ASP

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

Implements SIGAdaptation.

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

Process ASP Traffic Maintenance messages as ASP

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

Implements SIGAdaptation.

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

Process Management messages as ASP

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

Implements SIGAdaptation.

void setState ( AspState  state,
bool  notify = true 
) [protected]

Set the state of the ASP, notify user components of changes

Parameters:
stateNew state of the ASP
notifyTrue to notify user layers, false if the changes are internal
ObjList& users ( ) [inline, protected]

Get access to the list of Adaptation Users of this component

Returns:
Reference to the list of Adaptation Users

Member Data Documentation

int32_t m_aspId [protected]

ASP Identifier for ASPSM UP messages

TrafficMode m_traffic [protected]

Traffic mode for ASPTM ACTIVE messages


The documentation for this class was generated from the following file: