Yate
Public Member Functions
SccpRemote Class Reference

#include <yatesig.h>

Inheritance diagram for SccpRemote:
RefObject Mutex GenObject Lockable

List of all members.

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 ()

Detailed Description

Helper class to keep a remote sccp


Constructor & Destructor Documentation

Constructor

Parameters:
pcTypeThe pointcode type
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
virtual ~SccpRemote ( ) [virtual]

Destructor


Member Function Documentation

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
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
unsigned int getCongestion ( ) [inline]

Helper method to obtain the congestion level

Returns:
The congestion level
int getPackedPointcode ( ) [inline]

Obtain the pointcode as an integer

Returns:
The packed pointcode representation

References SS7PointCode::pack().

const SS7PointCode& getPointCode ( ) [inline]

Obtain the PointCode of the remote SCCP

Returns:
The pointcode of the remote SCCP
const char* getPointCodeType ( ) [inline]

Obtain a string representation of the remote pointcode type

Returns:
String representation of remote pointcode type

References TelEngine::lookup().

SCCPManagement::SccpStates getState ( ) [inline]

Obtain the state of this remote SCCP

Returns:
Remote SCCP state
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
ObjList& getSubsystems ( ) [inline]

Helper method to obtain remote sccp's subsystems list

Returns:
The subsystems list
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
void resetCongestion ( ) [inline]

Helper method to reset congestion level

void setCongestion ( unsigned int  cl) [inline]

Helper method to set congestion level

Parameters:
clThe new congestion level
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: