Yate
SccpRemote Class Reference

#include <yatesig.h>

Inheritance diagram for SccpRemote:
RefObject Mutex GenObject Lockable

Public Member Functions

 SccpRemote (SS7PointCode::Type pcType)
 
 SccpRemote (unsigned int pointcode, SS7PointCode::Type pcType)
 
virtual ~SccpRemote ()
 
bool initialize (const String &params)
 
SCCPManagement::SccpStates getState ()
 
SccpSubsystemgetSubsystem (int ssn)
 
void setState (SCCPManagement::SccpStates state)
 
const SS7PointCodegetPointCode ()
 
int getPackedPointcode ()
 
const char * getPointCodeType ()
 
void dump (String &dest, bool extended=false)
 
bool changeSubsystemState (int ssn, SCCPManagement::SccpStates newState)
 
ObjListgetSubsystems ()
 
void setCongestion (unsigned int cl)
 
void resetCongestion ()
 
unsigned int getCongestion ()
 
- 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 StringtoString () const
 
virtual const StringtraceId () const
 
NamedCountergetObjCounter () const
 
NamedCountersetObjCounter (NamedCounter *counter)
 
- Public Member Functions inherited from Mutex
 Mutex (bool recursive=false, const char *name=0)
 
 Mutex (const Mutex &original)
 
 ~Mutex ()
 
Mutexoperator= (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 ()
 

Additional Inherited Members

- 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 ()
 
- 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 ()
 
- Protected Member Functions inherited from RefObject
virtual void zeroRefs ()
 
bool resurrect ()
 
virtual void destroyed ()
 

Detailed Description

Helper class to keep a remote sccp

Constructor & Destructor Documentation

◆ SccpRemote() [1/2]

Constructor

Parameters
pcTypeThe pointcode type

◆ SccpRemote() [2/2]

SccpRemote ( unsigned int pointcode,
SS7PointCode::Type pcType )

Constructor. Construncot an Remote sccp from given pointcode and pointcode type

Parameters
pointcodeInteger value assigned to remote pointcode.
pcTypeRemote pointcode type

◆ ~SccpRemote()

virtual ~SccpRemote ( )
virtual

Destructor

Member Function Documentation

◆ changeSubsystemState()

bool changeSubsystemState ( int ssn,
SCCPManagement::SccpStates newState )

Helper method to change a subsystem state

Parameters
ssnThe subsystem ssn
newStateThe subsystem new state
Returns
False if the subsystem state is the same

◆ dump()

void dump ( String & dest,
bool extended = false )

Dump this sccp status an all it's subsystems

Parameters
destDestination string
extendedTrue to append the subsystems status

◆ getCongestion()

unsigned int getCongestion ( )
inline

Helper method to obtain the congestion level

Returns
The congestion level

◆ getPackedPointcode()

int getPackedPointcode ( )
inline

Obtain the pointcode as an integer

Returns
The packed pointcode representation

◆ getPointCode()

const SS7PointCode & getPointCode ( )
inline

Obtain the PointCode of the remote SCCP

Returns
The pointcode of the remote SCCP

◆ getPointCodeType()

const char * getPointCodeType ( )
inline

Obtain a string representation of the remote pointcode type

Returns
String representation of remote pointcode type

References SS7PointCode::lookup().

◆ getState()

SCCPManagement::SccpStates getState ( )
inline

Obtain the state of this remote SCCP

Returns
Remote SCCP state

◆ getSubsystem()

SccpSubsystem * getSubsystem ( int ssn)

Find a subsystem stored in remote subsystems list

Parameters
ssnThe subsystem number of the remote subsystem
Returns
Pointer to the Subsystem or 0 if it was not found

◆ getSubsystems()

ObjList & getSubsystems ( )
inline

Helper method to obtain remote sccp's subsystems list

Returns
The subsystems list

◆ initialize()

bool initialize ( const String & params)

Initialize the pointcode and subsystems list from a string

Parameters
paramsString containing the pointcode and the subsystems list
Returns
False if the pointcode from the string is not valid Usage

◆ resetCongestion()

void resetCongestion ( )
inline

Helper method to reset congestion level

◆ setCongestion()

void setCongestion ( unsigned int cl)
inline

Helper method to set congestion level

Parameters
clThe new congestion level

◆ setState()

void setState ( SCCPManagement::SccpStates state)

Set remote SCCP state

Parameters
stateThe new state of the remote SCCP

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