Yate
SccpLocalSubsystem Class Reference
Inheritance diagram for SccpLocalSubsystem:
RefObject Mutex GenObject Lockable

Public Member Functions

 SccpLocalSubsystem (unsigned char ssn, u_int64_t coordInterval, u_int64_t istInterval, unsigned char smi=0)
 
virtual ~SccpLocalSubsystem ()
 
unsigned char getSSN ()
 
void setState (SCCPManagement::SccpStates newState)
 
SCCPManagement::SccpStates getState ()
 
void startCoord ()
 
bool ignoreTests ()
 
void setIgnoreTests (bool ignore)
 
bool timeout ()
 
void manageTimeout (SCCPManagement *mgm)
 
void stopCoordTimer ()
 
unsigned char getSmi ()
 
void dump (String &dest)
 
bool receivedSOG (unsigned char ssn, int pointcode)
 
void resetTimers ()
 
void clearBackups ()
 
void appendBackup (RemoteBackupSubsystem *backup)
 
- 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 ()
 

Constructor & Destructor Documentation

◆ SccpLocalSubsystem()

SccpLocalSubsystem ( unsigned char ssn,
u_int64_t coordInterval,
u_int64_t istInterval,
unsigned char smi = 0 )

Constructor

Parameters
ssnThe subsystem number
coordIntervalThe time interval for coordinate changed timer
istIntervalThe time interval for ignore status test timer
smiSubsystem multiplicity indicator

◆ ~SccpLocalSubsystem()

virtual ~SccpLocalSubsystem ( )
virtual

Destructor

Member Function Documentation

◆ appendBackup()

void appendBackup ( RemoteBackupSubsystem * backup)
inline

Append new backup subsystem

Parameters
backupThe backup subsystem to append

References Mutex::lock().

◆ clearBackups()

void clearBackups ( )
inline

Clear remote backup subsystems

References Mutex::lock().

◆ dump()

void dump ( String & dest)

Dump this sccp subsystem status

Parameters
destDestination string

◆ getSmi()

unsigned char getSmi ( )
inline

Obtain the subsystem multiplicity indicator of this subsystem

Returns
The Subsystem multiplicity indicator

◆ getSSN()

unsigned char getSSN ( )
inline

Obtain the subsystem number number of this sccp subsystem

Returns
The ssn associated with this subsystem

◆ getState()

SCCPManagement::SccpStates getState ( )
inline

Obtain the state associated with this sccp subsystem

Returns
The state of this SCCP subsystem

◆ ignoreTests()

bool ignoreTests ( )
inline

Check if this subsystem should ignore SST (Subsystem status test)

◆ manageTimeout()

void manageTimeout ( SCCPManagement * mgm)

Handle coord timer timeout

Parameters
mgmPointer to sccp management who owns this sccp local subsystem

◆ receivedSOG()

bool receivedSOG ( unsigned char ssn,
int pointcode )

Process a subsystem out of service grant message

Parameters
ssnThe remote ssn
pointcodeThe remote pointcode
Returns
True if the message was procesed

◆ resetTimers()

void resetTimers ( )
inline

Helper method used to reset timers

◆ setIgnoreTests()

void setIgnoreTests ( bool ignore)

Inform this subsystem if should ignore subsystem status tests

Parameters
ignoreTrue to ignore subsystem status tests

◆ setState()

void setState ( SCCPManagement::SccpStates newState)
inline

Set a new state of this SCCP subsystem

Parameters
newStateThew new state to set

◆ startCoord()

void startCoord ( )
inline

Start coordinate change timer

◆ stopCoordTimer()

void stopCoordTimer ( )
inline

Stop coordinate change timer

◆ timeout()

bool timeout ( )

Check if coordinate change timer has timed out

Returns
True if coordinate change timer has timed out

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