Yate
SS7L3User Class Referenceabstract

Abstract user of SS7 layer 3 (network) message transfer part. More...

#include <yatesig.h>

Inheritance diagram for SS7L3User:
SignallingComponent RefObject DebugEnabler GenObject SS7Layer4 SS7Router SS7ISUP SS7Management SS7SCCP SS7TUP SS7Testing SS7BICC

Public Member Functions

virtual void attach (SS7Layer3 *network)=0
 
- Public Member Functions inherited from SignallingComponent
virtual ~SignallingComponent ()
 
virtual const StringtoString () const
 
virtual bool initialize (const NamedList *config)
 
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)
 

Protected Member Functions

virtual HandledMSU receivedMSU (const SS7MSU &msu, const SS7Label &label, SS7Layer3 *network, int sls)=0
 
virtual bool recoveredMSU (const SS7MSU &msu, const SS7Label &label, SS7Layer3 *network, int sls)
 
virtual void receivedUPU (SS7PointCode::Type type, const SS7PointCode node, SS7MSU::Services part, unsigned char cause, const SS7Label &label, int sls)
 
virtual void notify (SS7Layer3 *link, int sls)
 
virtual void routeStatusChanged (SS7PointCode::Type type, const SS7PointCode &node, SS7Route::State state)
 
- 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)
 

Static Protected Member Functions

static ObjListgetNetRoutes (SS7Layer3 *network, SS7PointCode::Type type)
 
static const ObjListgetNetRoutes (const SS7Layer3 *network, SS7PointCode::Type type)
 

Friends

class SS7Layer3
 
class SS7Router
 

Additional Inherited Members

- 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

Abstract user of SS7 layer 3 (network) message transfer part.

An user of a Layer 3 (data link) SS7 message transfer part

Member Function Documentation

◆ attach()

virtual void attach ( SS7Layer3 * network)
pure virtual

Attach a SS7 Layer 3 (network) to the user component

Parameters
networkPointer to network component to attach

Implemented in SS7ISUP, SS7Layer4, SS7Router, and SS7SCCP.

◆ getNetRoutes() [1/2]

static const ObjList * getNetRoutes ( const SS7Layer3 * network,
SS7PointCode::Type type )
staticprotected

Retrieve the route table of a network for a specific Point Code type

Parameters
networkNetwork layer to retrieve routes from
typePoint Code type of the desired table
Returns
Pointer to the list of SS7Route or NULL if no such route

◆ getNetRoutes() [2/2]

static ObjList * getNetRoutes ( SS7Layer3 * network,
SS7PointCode::Type type )
staticprotected

Retrieve the route table of a network for a specific Point Code type

Parameters
networkNetwork layer to retrieve routes from
typePoint Code type of the desired table
Returns
Pointer to the list of SS7Route or NULL if no such route

◆ notify()

virtual void notify ( SS7Layer3 * link,
int sls )
protectedvirtual

Process a notification generated by the attached network layer

Parameters
linkNetwork or linkset that generated the notification
slsSignalling Link that generated the notification, negative if none

Reimplemented in SS7ISUP, SS7Management, SS7Router, SS7SCCP, and SS7Testing.

◆ receivedMSU()

virtual HandledMSU receivedMSU ( const SS7MSU & msu,
const SS7Label & label,
SS7Layer3 * network,
int sls )
protectedpure virtual

Process a MSU received from the Layer 3 component

Parameters
msuMessage data, starting with Service Indicator Octet
labelRouting label of the received MSU
networkNetwork layer that delivered the MSU
slsSignalling Link the MSU was received from
Returns
Result of MSU processing

Implemented in SS7BICC, SS7ISUP, SS7Management, SS7Router, SS7SCCP, and SS7Testing.

◆ receivedUPU()

virtual void receivedUPU ( SS7PointCode::Type type,
const SS7PointCode node,
SS7MSU::Services part,
unsigned char cause,
const SS7Label & label,
int sls )
inlineprotectedvirtual

Notification for receiving User Part Unavailable

Parameters
typeType of Point Code
nodeNode on which the User Part is unavailable
partUser Part (service) reported unavailable
causeUnavailability cause - Q.704 15.17.5
labelRouting label of the UPU message
slsSignaling link the UPU was received on

Reimplemented in SS7ISUP, SS7Router, and SS7SCCP.

◆ recoveredMSU()

virtual bool recoveredMSU ( const SS7MSU & msu,
const SS7Label & label,
SS7Layer3 * network,
int sls )
inlineprotectedvirtual

Reroute a recovered Message Signal Unit

Parameters
msuMessage data, starting with Service Indicator Octet
labelRouting label of the recovered MSU
networkNetwork layer that recovered the MSU
slsSignalling Link the MSU was recovered from
Returns
True if the MSU was successfully rerouted

◆ routeStatusChanged()

virtual void routeStatusChanged ( SS7PointCode::Type type,
const SS7PointCode & node,
SS7Route::State state )
inlineprotectedvirtual

Process route status changed notifications

Parameters
typeType of Point Code
nodeDestination node witch state has changed
stateThe new route state

Reimplemented in SS7SCCP.


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