Yate
SCCP Class Reference

Abstract SS7 SCCP interface. More...

#include <yatesig.h>

Inheritance diagram for SCCP:
SignallingComponent RefObject DebugEnabler GenObject SS7SCCP SS7SUA

Public Types

enum  Type {
  CoordinateRequest = 0 , CoordinateConfirm = 1 , CoordinateIndication = 2 , CoordinateResponse = 3 ,
  StatusIndication = 4 , StatusRequest = 5 , PointCodeStatusIndication = 6 , TraficIndication = 7 ,
  SubsystemStatus = 8
}
 

Public Member Functions

 SCCP ()
 
virtual ~SCCP ()
 
virtual int sendMessage (DataBlock &data, const NamedList &params)
 
virtual bool managementStatus (Type type, NamedList &params)
 
virtual void attach (SCCPUser *user)
 
virtual void detach (SCCPUser *user)
 
virtual void attachGTT (GTT *gtt)
 
virtual void updateTables (const NamedList &params)
 
- 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)
 

Static Public Member Functions

static const TokenDictnotifTypes ()
 
- 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

NamedListtranslateGT (const NamedList &params, const String &prefix, const String &nextPrefix)
 
HandledMSU pushMessage (DataBlock &data, NamedList &params, int ssn)
 
HandledMSU notifyMessage (DataBlock &data, NamedList &params, int ssn)
 
bool managementMessage (Type type, NamedList &params)
 
virtual bool isEndpoint ()
 
void resolveGTParams (SS7MsgSCCP *msg, const NamedList *gtParams)
 
- 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)
 

Friends

class SCCPManagement
 

Detailed Description

Abstract SS7 SCCP interface.

An interface to a SS7 Signalling Connection Control Part

Constructor & Destructor Documentation

◆ SCCP()

SCCP ( )

Constructor

◆ ~SCCP()

virtual ~SCCP ( )
virtual

Destructor

Member Function Documentation

◆ attach()

virtual void attach ( SCCPUser * user)
virtual

Attach an user to this SS7 SCCP

Parameters
userPointer to the SCCP user

◆ attachGTT()

virtual void attachGTT ( GTT * gtt)
virtual

Attach an Global Title Translator to this SS7 SCCP

Parameters
gttPointer to the Global Title Translator

◆ detach()

virtual void detach ( SCCPUser * user)
virtual

Detach an user from this SS7 SCCP

Parameters
userPointer to the SCCP user

◆ isEndpoint()

virtual bool isEndpoint ( )
inlineprotectedvirtual

Check if this sccp is an endpoint

Returns
False

Reimplemented in SS7SCCP.

◆ managementMessage()

bool managementMessage ( Type type,
NamedList & params )
protected

Broadcast a management message to all attached users

Parameters
typeThe type of notification
paramsThe list of parameters
Returns
True if at least one user processed the message

◆ managementStatus()

virtual bool managementStatus ( Type type,
NamedList & params )
virtual

Receive management information from attached users.

Parameters
typeThe type of management message
paramsList of parameters (Affected subsystem [M])
Returns
True if the notification was processed

Reimplemented in SS7SCCP.

◆ notifTypes()

static const TokenDict * notifTypes ( )
static

Obtain the dictionary for notifications types

Returns
Pointer to the notification types dictionary

◆ notifyMessage()

HandledMSU notifyMessage ( DataBlock & data,
NamedList & params,
int ssn )
protected

Notify the users that a message failed to be delivered to destination

Parameters
dataThe message data
paramsThe list of parameters
ssnThe ssn of the SCCP user
Returns
HandledMSU enum value

◆ pushMessage()

HandledMSU pushMessage ( DataBlock & data,
NamedList & params,
int ssn )
protected

Send a SCCP message to users list for processing

Parameters
dataThe message data
paramsThe list of parameters
ssnThe ssn of the SCCP user
Returns
HandledMSU enum value

◆ resolveGTParams()

void resolveGTParams ( SS7MsgSCCP * msg,
const NamedList * gtParams )
protected

Copy the parameters returned by Global Title Translator in the SCCP Message

Parameters
msgThe SCCP message
gtParamsThe parameters returned by GTT

◆ sendMessage()

virtual int sendMessage ( DataBlock & data,
const NamedList & params )
virtual

Send a message

Parameters
dataData to be transported trough SCCP protocol
paramsSCCP parameters SCCP parameters : MessageReturn : boolean / integer True or 0x08 to return message on error. NOTE int values should me below 0x0f sequenceControl : boolean. True to send messages in sequence LocalPC : integer. Local pointcode RemotePC : integer. Remote pointcode Address Parameter: Address parameter starts with : CallingPartyAddress or CalledPartyAddress followed by: .ssn : integer (0-255) Subsequence number .pointcode : integer Packed pointcode .gt : string The digits of the global title .gt.plan : integer GT numbering plan .gt.encoding : integer GT encoding scheme .gt.translation : integer GT Translation type .gt.nature : integer Gt nature of address indicator (ITU only) Importance : integer (0-7) Importance of the message! (ITU only)

Reimplemented in SS7SCCP.

◆ translateGT()

NamedList * translateGT ( const NamedList & params,
const String & prefix,
const String & nextPrefix )
protected

Translate a Global Title

Parameters
paramsThe Global Title content
prefixThe prefix of the global title content parameters
nextPrefixOther prefix of the global title content parameters
Returns
a new SCCP route or 0 is no route was found

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