Yate
ISDNIUA Class Reference

SIGTRAN ISDN Q.921 User Adaptation Layer. More...

#include <yatesig.h>

Inheritance diagram for ISDNIUA:
ISDNLayer2 SIGAdaptUser SignallingComponent RefObject DebugEnabler GenObject

Public Member Functions

 ISDNIUA (const NamedList &params, const char *name=0, u_int8_t tei=0)
 
virtual ~ISDNIUA ()
 
virtual bool initialize (const NamedList *config)
 
virtual bool multipleFrame (u_int8_t tei, bool establish, bool force)
 
virtual bool sendData (const DataBlock &data, u_int8_t tei, bool ack)
 
virtual void cleanup ()
 
virtual void activeChange (bool active)
 
int32_t iid () const
 
- Public Member Functions inherited from ISDNLayer2
virtual ~ISDNLayer2 ()
 
ISDNLayer3layer3 () const
 
State state () const
 
bool network () const
 
bool detectType () const
 
u_int8_t localSapi () const
 
u_int8_t localTei () const
 
u_int32_t maxUserData () const
 
bool teiAssigned () const
 
bool autoRestart () const
 
unsigned int upTime () const
 
virtual void attach (ISDNLayer3 *layer3)
 
- Public Member Functions inherited from SignallingComponent
virtual ~SignallingComponent ()
 
virtual const StringtoString () const
 
virtual bool control (NamedList &params)
 
virtual NamedListcontrolCreate (const char *oper=0)
 
virtual bool controlExecute (NamedList *params)
 
virtual void engine (SignallingEngine *eng)
 
SignallingEngineengine () const
 
int debugLevel (int level)
 
const StringcomponentType () 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 StringtraceId () const
 
NamedCountergetObjCounter () const
 
NamedCountersetObjCounter (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 SIGAdaptUser
virtual ~SIGAdaptUser ()
 

Protected Member Functions

ISDNIUAClientclient () const
 
virtual bool processMGMT (unsigned char msgType, const DataBlock &msg, int streamId)
 
virtual bool processQPTM (unsigned char msgType, const DataBlock &msg, int streamId)
 
- Protected Member Functions inherited from ISDNLayer2
 ISDNLayer2 (const NamedList &params, const char *name=0, u_int8_t tei=0)
 
Mutexl2Mutex ()
 
void multipleFrameEstablished (u_int8_t tei, bool confirm, bool timeout)
 
void multipleFrameReleased (u_int8_t tei, bool confirm, bool timeout)
 
void dataLinkState (u_int8_t tei, bool cmd, bool value)
 
void idleTimeout ()
 
void receiveData (const DataBlock &data, u_int8_t tei)
 
void teiAssigned (bool status)
 
void changeState (State newState, const char *reason=0)
 
bool changeType ()
 
void autoRestart (bool restart)
 
void setRi (u_int16_t ri)
 
ISDNFrameparsePacket (const DataBlock &packet)
 
- 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 ()
 
virtual void timerTick (const Time &when)
 
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 SIGAdaptUser
 SIGAdaptUser ()
 
SIGAdaptClientadaptation () const
 
SIGTransporttransport () const
 
void adaptation (SIGAdaptClient *adapt)
 
bool activate ()
 
bool aspUp () const
 
bool aspActive () const
 
unsigned char getStreamId ()
 

Protected Attributes

int32_t m_iid
 
- Protected Attributes inherited from SIGAdaptUser
bool m_autostart
 
unsigned char m_streamId
 

Friends

class ISDNIUAClient
 

Additional Inherited Members

- Public Types inherited from ISDNLayer2
enum  State { Released , WaitEstablish , Established , WaitRelease }
 
- Static Public Member Functions inherited from ISDNLayer2
static const char * stateName (State s)
 
- 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 NamedCountergetObjCounter (const String &name, bool create=true)
 
static ObjListgetObjCounters ()
 

Detailed Description

SIGTRAN ISDN Q.921 User Adaptation Layer.

RFC4233 ISDN Layer 2 implementation over SCTP/IP IUA is intended to be used as a Provider-User where Q.921 runs on a Signalling Gateway and the user (Q.931) runs on an Application Server.

Constructor & Destructor Documentation

◆ ISDNIUA()

ISDNIUA ( const NamedList & params,
const char * name = 0,
u_int8_t tei = 0 )

Constructor Initialize this object and the layer 2

Parameters
paramsObject and Layer 2 parameters
nameOptional name for Layer 2
teiValue of TEI for this component

◆ ~ISDNIUA()

virtual ~ISDNIUA ( )
virtual

Destructor

Member Function Documentation

◆ activeChange()

virtual void activeChange ( bool active)
virtual

Traffic activity state change notification

Parameters
activeTrue if the ASP is active and traffic is allowed

Implements SIGAdaptUser.

◆ cleanup()

virtual void cleanup ( )
virtual

Emergency release.

Implements ISDNLayer2.

◆ iid()

int32_t iid ( ) const
inline

Retrieve the numeric Interface Identifier (if any)

Returns
IID value, -1 if not set

◆ initialize()

virtual bool initialize ( const NamedList * config)
virtual

Configure and initialize IUA and its transport

Parameters
configOptional configuration parameters override
Returns
True if IUA and the transport were initialized properly

Reimplemented from SignallingComponent.

◆ multipleFrame()

virtual bool multipleFrame ( u_int8_t tei,
bool establish,
bool force )
virtual

Implements Q.921 DL-ESTABLISH and DL-RELEASE request primitives

Parameters
teiThis layer's TEI
establishTrue to establish. False to release
forceTrue to establish even if we already are in this mode. This parameter is ignored if establish is false
Returns
True if the request was accepted

Reimplemented from ISDNLayer2.

◆ sendData()

virtual bool sendData ( const DataBlock & data,
u_int8_t tei,
bool ack )
virtual

Implements Q.921 DL-DATA and DL-UNIT DATA request primitives

Parameters
dataData to send
teiThe TEI to send with the data frane
ackTrue to send an acknowledged frame, false to send an unacknowledged one
Returns
False if the request was not accepted or send operation failed

Reimplemented from ISDNLayer2.


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