Yate
SS7Layer4 Class Reference

Abstract SS7 layer 4 (application) protocol. More...

#include <yatesig.h>

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

Public Member Functions

virtual void destroyed ()
 
virtual bool initialize (const NamedList *config)
 
virtual void attach (SS7Layer3 *network)
 
SS7Layer3network () const
 
unsigned char sio () const
 
unsigned char sif () const
 
unsigned char ssf () const
 
unsigned char prio () const
 
unsigned char ni () const
 
unsigned char getSIO (const NamedList &params) const
 
- 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)
 

Static Public Member Functions

static unsigned char getSIO (const NamedList &params, unsigned char sif, unsigned char prio, unsigned char ni)
 
static unsigned char getSIO (const NamedList &params, unsigned char sif, unsigned char ssf)
 
static unsigned char getSIO (const NamedList &params, unsigned char sio)
 
- 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 ()
 

Protected Member Functions

 SS7Layer4 (unsigned char sio=SS7MSU::National, const NamedList *params=0)
 
int transmitMSU (const SS7MSU &msu, const SS7Label &label, int sls=-1)
 
- Protected Member Functions inherited from SS7L3User
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")
 
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 Attributes

unsigned char m_sio
 

Additional Inherited Members

- Static Protected Member Functions inherited from SS7L3User
static ObjListgetNetRoutes (SS7Layer3 *network, SS7PointCode::Type type)
 
static const ObjListgetNetRoutes (const SS7Layer3 *network, SS7PointCode::Type type)
 

Detailed Description

Abstract SS7 layer 4 (application) protocol.

An interface to a Layer 4 (application) SS7 protocol

Constructor & Destructor Documentation

◆ SS7Layer4()

SS7Layer4 ( unsigned char sio = SS7MSU::National,
const NamedList * params = 0 )
protected

Constructor

Parameters
sioDefault value of Service Information Octet
paramsOptional parameters to alter the value of SIO

References sio().

Referenced by SS7Testing::SS7Testing().

Member Function Documentation

◆ attach()

virtual void attach ( SS7Layer3 * network)
virtual

Attach a SS7 network or router to this service. Detach itself from the old one if valid

Parameters
networkPointer to network or router to attach

Implements SS7L3User.

Reimplemented in SS7ISUP, and SS7SCCP.

References network().

◆ destroyed()

virtual void destroyed ( )
virtual

This method is called to clean up and destroy the object after the reference counter becomes zero

Reimplemented from SignallingComponent.

Reimplemented in SS7ISUP, and SS7SCCP.

◆ getSIO() [1/4]

unsigned char getSIO ( const NamedList & params) const
inline

Get a SIO value from a parameters list

Parameters
paramsParameter list to retrieve "service", "priority" and "netindicator"
Returns
Adjusted SIO value

References getSIO(), and m_sio.

◆ getSIO() [2/4]

static unsigned char getSIO ( const NamedList & params,
unsigned char sif,
unsigned char prio,
unsigned char ni )
static

Get a SIO value from a parameters list

Parameters
paramsParameter list to retrieve "service", "priority" and "netindicator"
sifDefault Service Information Field to apply parameters to
prioDefault Priority Field to apply parameters to
niDefault Network Indicator Field to apply parameters to
Returns
Adjusted SIO value

References ni(), prio(), and sif().

Referenced by getSIO(), getSIO(), and getSIO().

◆ getSIO() [3/4]

static unsigned char getSIO ( const NamedList & params,
unsigned char sif,
unsigned char ssf )
inlinestatic

Get a SIO value from a parameters list

Parameters
paramsParameter list to retrieve "service", "priority" and "netindicator"
sifDefault Service Information Field to apply parameters to
ssfDefault Subservice Field to apply parameters to
Returns
Adjusted SIO value

References getSIO(), sif(), and ssf().

◆ getSIO() [4/4]

static unsigned char getSIO ( const NamedList & params,
unsigned char sio )
inlinestatic

Get a SIO value from a parameters list

Parameters
paramsParameter list to retrieve "service", "priority" and "netindicator"
sioDefault SIO to apply parameters to
Returns
Adjusted SIO value

References getSIO(), and sio().

◆ initialize()

virtual bool initialize ( const NamedList * config)
virtual

Initialize the application layer, connect it to the SS7 router

Parameters
configOptional configuration parameters override
Returns
True if the application was initialized properly

Reimplemented from SignallingComponent.

Reimplemented in SS7ISUP, SS7SCCP, and SS7Testing.

◆ network()

SS7Layer3 * network ( ) const
inline

Retrieve the SS7 network or router to which this service is attached

Returns
Pointer to the network or router this service is attached to

Referenced by SS7ISUP::attach(), attach(), SS7SCCP::attach(), SS7ISUP::processMSU(), SS7BICC::receivedMSU(), SS7ISUP::receivedMSU(), SS7Management::receivedMSU(), SS7SCCP::receivedMSU(), and SS7Testing::receivedMSU().

◆ ni()

unsigned char ni ( ) const
inline

Get the default sending Network Indicator bits for this protocol

Returns
Network Indicator bits

References m_sio.

Referenced by getSIO().

◆ prio()

unsigned char prio ( ) const
inline

Get the default sending Priority bits for this protocol

Returns
Priority bits

References m_sio.

Referenced by getSIO().

◆ sif()

unsigned char sif ( ) const
inline

Get the Service Information Field (SS7 protocol number)

Returns
SIF value used in matching and sending MSUs

References m_sio.

Referenced by getSIO(), getSIO(), and SS7TUP::SS7TUP().

◆ sio()

unsigned char sio ( ) const
inline

Get the default sending Service Information Octet for this protocol

Returns
SIO value

References m_sio.

Referenced by SS7ISUP::buildMSU(), getSIO(), SS7BICC::SS7BICC(), SS7ISUP::SS7ISUP(), SS7Layer4(), SS7Management::SS7Management(), and SS7Testing::SS7Testing().

◆ ssf()

unsigned char ssf ( ) const
inline

Get the default sending Service Switching Function bits for this protocol

Returns
Combined Priority and Network Indicator bits

References m_sio.

Referenced by SS7ISUP::createMSU(), and getSIO().

◆ transmitMSU()

int transmitMSU ( const SS7MSU & msu,
const SS7Label & label,
int sls = -1 )
inlineprotected

Ask the Layer 3 to push a Message Signal Unit down the protocol stack

Parameters
msuMessage data, starting with Service Indicator Octet
labelRouting label of the MSU to use in routing
slsSignalling Link Selection, negative to choose best
Returns
Link the message was successfully queued to, negative for error

Member Data Documentation

◆ m_sio

unsigned char m_sio
protected

Service Information Octet (SIO) for this protocol

Referenced by getSIO(), ni(), prio(), sif(), sio(), and ssf().


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