Yate
Protected Member Functions | List of all members
SIGAdaptServer Class Reference

Server side SIGTRAN User Adaptation component. More...

#include <yatesig.h>

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

Protected Member Functions

 SIGAdaptServer (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)
 
- Protected Member Functions inherited from SIGAdaptation
 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 void timerTick (const Time &when)
 
bool processHeartbeat (unsigned char msgType, const DataBlock &msg, int streamId)
 
void resetHeartbeat ()
 
void enableHeartbeat (unsigned char streamId)
 
- Protected Member Functions inherited from SignallingComponent
 SignallingComponent (const char *name=0, const NamedList *params=0, const char *type="unknown")
 
virtual void destroyed ()
 
void insert (SignallingComponent *component)
 
virtual void detach ()
 
void setName (const char *name)
 
void setCompType (const char *type)
 
unsigned long tickSleep (unsigned long usec=1000000) const
 
- Protected Member Functions inherited from RefObject
virtual void zeroRefs ()
 
bool resurrect ()
 
- Protected Member Functions inherited from DebugEnabler
void debugName (const char *name)
 
- Protected Member Functions inherited from SIGTRAN
virtual bool processMSG (unsigned char msgVersion, unsigned char msgClass, unsigned char msgType, const DataBlock &msg, int streamId)=0
 

Additional Inherited Members

- Public Types inherited from SIGAdaptation
enum  TrafficMode { TrafficUnused = 0 , TrafficOverride = 1 , TrafficLoadShare = 2 , TrafficBroadcast = 3 }
 
enum  HeartbeatState { HeartbeatDisabled = 0 , HeartbeatEnabled = 1 , HeartbeatWaitResponse = 2 }
 
enum  Errors {
  InvalidVersion = 0x01 , InvalidIID = 0x02 , UnsupportedMessageClass = 0x03 , UnsupportedMessageType = 0x04 ,
  UnsupportedTrafficMode = 0x05 , UnexpectedMessage = 0x06 , ProtocolError = 0x07 , UnsupportedIIDType = 0x08 ,
  InvalidStreamIdentifier = 0x09 , UnassignedTEI = 0x0a , UnrecognizedSAPI = 0x0b , InvalidTEISAPI = 0x0c ,
  ManagementBlocking = 0x0d , ASPIDRequired = 0x0e , InvalidASPID = 0x0f , ASPActiveIID = 0x10 ,
  InvalidParameterValue = 0x11 , ParameterFieldError = 0x12 , UnexpectedParameter = 0x13 , DestinationStatusUnknown = 0x14 ,
  InvalidNetworkAppearance = 0x15 , MissingParameter = 0x16 , InvalidRoutingContext = 0x19 , NotConfiguredAS = 0x1a ,
  SubsystemStatusUnknown = 0x1b , InvalidLoadsharingLabel = 0x1c
}
 
- Public Types inherited from SIGTRAN
enum  MsgClass {
  MGMT = 0 , TRAN = 1 , SSNM = 2 , ASPSM = 3 ,
  ASPTM = 4 , QPTM = 5 , MAUP = 6 , CLMSG = 7 ,
  COMSG = 8 , RKM = 9 , IIM = 10 , M2PA = 11
}
 
enum  MsgMGMT { MgmtERR = 0 , MgmtNTFY = 1 }
 
enum  MsgSSNM {
  SsnmDUNA = 1 , SsnmDAVA = 2 , SsnmDAUD = 3 , SsnmSCON = 4 ,
  SsnmDUPU = 5 , SsnmDRST = 6
}
 
enum  MsgASPSM {
  AspsmUP = 1 , AspsmDOWN = 2 , AspsmBEAT = 3 , AspsmUP_ACK = 4 ,
  AspsmDOWN_ACK = 5 , AspsmBEAT_ACK = 6
}
 
enum  MsgASPTM { AsptmACTIVE = 1 , AsptmINACTIVE = 2 , AsptmACTIVE_ACK = 3 , AsptmINACTIVE_ACK = 4 }
 
enum  MsgRKM { RkmREG_REQ = 1 , RkmREG_RSP = 2 , RkmDEREG_REQ = 3 , RkmDEREG_RSP = 4 }
 
enum  MsgIIM { IimREG_REQ = 1 , IimREG_RSP = 2 , IimDEREG_REQ = 3 , IimDEREG_RSP = 4 }
 
- Public Member Functions inherited from SIGAdaptation
virtual ~SIGAdaptation ()
 
virtual bool initialize (const NamedList *config)
 
void notifyLayer (SignallingInterface::Notification status)
 
- Public Member Functions inherited from SignallingComponent
virtual ~SignallingComponent ()
 
virtual const String & toString () const
 
virtual bool control (NamedList &params)
 
virtual NamedList * controlCreate (const char *oper=0)
 
virtual bool controlExecute (NamedList *params)
 
virtual void engine (SignallingEngine *eng)
 
SignallingEngine * engine () const
 
int debugLevel (int level)
 
const String & componentType () const
 
- Public Member Functions inherited from RefObject
 RefObject ()
 
virtual ~RefObject ()
 
virtual void * getObject (const String &name) const
 
virtual bool alive () const
 
bool ref ()
 
bool deref ()
 
int refcount () const
 
virtual void destruct ()
 
- Public Member Functions inherited from GenObject
 GenObject ()
 
virtual ~GenObject ()
 
virtual const String & traceId () const
 
NamedCounter * getObjCounter () const
 
NamedCounter * setObjCounter (NamedCounter *counter)
 
- Public Member Functions inherited from DebugEnabler
 DebugEnabler (int level=TelEngine::debugLevel(), bool enabled=true)
 
int debugLevel () const
 
int debugLevel (int level)
 
bool debugEnabled () const
 
void debugEnabled (bool enable)
 
const char * debugName () const
 
bool debugAt (int level) const
 
bool debugChained () const
 
void debugChain (const DebugEnabler *chain=0)
 
void debugCopy (const DebugEnabler *original=0)
 
- Public Member Functions inherited from SIGTRAN
 SIGTRAN (u_int32_t payload=0, u_int16_t port=0)
 
virtual ~SIGTRAN ()
 
virtual void attach (SIGTransport *trans)
 
SIGTransport * transport () const
 
u_int32_t payload () const
 
u_int16_t defPort () const
 
bool connected (int streamId=0) const
 
bool transmitMSG (unsigned char msgVersion, unsigned char msgClass, unsigned char msgType, const DataBlock &msg, int streamId=0) const
 
bool transmitMSG (unsigned char msgClass, unsigned char msgType, const DataBlock &msg, int streamId=0) const
 
bool restart (bool force)
 
bool getSocketParams (const String &params, NamedList &result)
 
virtual bool transportNotify (SIGTransport *newTransport, const SocketAddr &addr)
 
bool hasTransportThread ()
 
void stopTransportThread ()
 
- Public Member Functions inherited from Mutex
 Mutex (bool recursive=false, const char *name=0)
 
 Mutex (const Mutex &original)
 
 ~Mutex ()
 
Mutex & operator= (const Mutex &original)
 
virtual bool lock (long maxwait=-1)
 
virtual bool unlock ()
 
virtual bool locked () const
 
const char * owner () const
 
bool recursive () const
 
- Public Member Functions inherited from Lockable
virtual ~Lockable ()
 
virtual bool check (long maxwait=-1)
 
virtual bool unlockAll ()
 
- Static Public Member Functions inherited from SIGAdaptation
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)
 
- Static Public Member Functions inherited from SignallingComponent
static bool resolveConfig (const String &cmpName, NamedList &params, const NamedList *config)
 
- Static Public Member Functions inherited from RefObject
static bool alive (const RefObject *obj)
 
static bool efficientIncDec ()
 
- Static Public Member Functions inherited from GenObject
static void * getObject (const String &name, const GenObject *obj)
 
static bool getObjCounting ()
 
static void setObjCounting (bool enable)
 
static NamedCounter * getObjCounter (const String &name, bool create=true)
 
static ObjList & getObjCounters ()
 
- Static Public Member Functions inherited from SIGTRAN
static const TokenDict * classNames ()
 
static const char * typeName (unsigned char msgClass, unsigned char msgType, const char *defValue=0)
 
- Static Public Member Functions inherited from Mutex
static int count ()
 
static int locks ()
 
static bool efficientTimedLock ()
 
- Static Public Member Functions inherited from Lockable
static void wait (unsigned long maxwait)
 
static unsigned long wait ()
 
static void startUsingNow ()
 
static void enableSafety (bool safe=true)
 
static bool safety ()
 

Detailed Description

Server side SIGTRAN User Adaptation component.

Generic server side (SG) Signalling Transport User Adaptation component

Constructor & Destructor Documentation

◆ SIGAdaptServer()

SIGAdaptServer ( const char * name = 0,
const NamedList * params = 0,
u_int32_t payload = 0,
u_int16_t port = 0 )
inlineexplicitprotected

Constructs an uninitialized User Adaptation server 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

References SIGTRAN::payload(), and SIGAdaptation::SIGAdaptation().

Member Function Documentation

◆ processAspsmMSG()

virtual bool processAspsmMSG ( unsigned char msgType,
const DataBlock & msg,
int streamId )
protectedvirtual

Process ASP State Maintenance messages as SG

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.

◆ processAsptmMSG()

virtual bool processAsptmMSG ( unsigned char msgType,
const DataBlock & msg,
int streamId )
protectedvirtual

Process ASP Traffic Maintenance messages as SG

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.

◆ processMgmtMSG()

virtual bool processMgmtMSG ( unsigned char msgType,
const DataBlock & msg,
int streamId )
protectedvirtual

Process Management messages as SG

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.

The documentation for this class was generated from the following file:
Generated by doxygen 1.13.2