Abstract SS7 SCCP user interface. More...

#include <yatesig.h>

Inheritance diagram for SCCPUser:

Public Member Functions
	SCCPUser (const NamedList &params)

virtual	~SCCPUser ()

virtual bool	initialize (const NamedList *config)

virtual bool	sendData (DataBlock &data, NamedList &params)

virtual bool	sccpNotify (SCCP::Type type, NamedList &params)

virtual HandledMSU	receivedData (DataBlock &data, NamedList &params)

virtual HandledMSU	notifyData (DataBlock &data, NamedList &params)

virtual bool	managementNotify (SCCP::Type type, NamedList &params)

virtual void	attach (SCCP *sccp)

SCCP *	sccp () const

Public Member Functions inherited from SignallingComponent
virtual	~SignallingComponent ()

virtual const String &	toString () const

virtual bool	control (NamedList &params)

virtual NamedList *	controlCreate (const char *oper=0)

virtual bool	controlExecute (NamedList *params)

virtual void	engine (SignallingEngine *eng)

SignallingEngine *	engine () const

int	debugLevel (int level)

const String &	componentType () 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 String &	traceId () const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (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)

Protected Member Functions
virtual void	destroyed ()

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)

Additional Inherited Members
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 NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Detailed Description

Abstract SS7 SCCP user interface.

An interface to a SS7 Signalling Connection Control Part user

Constructor & Destructor Documentation

◆ SCCPUser()

SCCPUser ( const NamedList & params )

Constructor

◆ ~SCCPUser()

virtual ~SCCPUser ( )

virtual

Destructor, detaches from the SCCP implementation

Member Function Documentation

◆ attach()

virtual void attach ( SCCP * sccp )

virtual

Attach as user to a SCCP

Parameters

sccp	Pointer to the SCCP to use NOTE: This method will deref the pointer if is the same with the one that we already have!! When this method is called the sccp pointer reference counter must be incremented for this SCCPUser.

References sccp().

◆ destroyed()

virtual void destroyed ( )

protectedvirtual

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

Reimplemented from SignallingComponent.

◆ initialize()

virtual bool initialize ( const NamedList * config )

virtual

Configure and initialize the component and any subcomponents it may have

Parameters

config Optional configuration parameters override

Returns: True if the component was initialized properly

Reimplemented from SignallingComponent.

Reimplemented in SS7TCAP.

◆ managementNotify()

virtual bool managementNotify	(	SCCP::Type	type,
		NamedList &	params )

virtual

Notification from SCCP management to a sccp user about pointcodes status, OOS responses/indications, subsystems status

Type: CoordinateIndication -> Indication from a remote SCCP User that requires to go OOS
    params: "ssn" -> The subsystem number of the remote SCCP User
                  "smi" -> Subsystem multiplicity indicator
                  "pointcode" -> The pointcode of the remote SCCP User
Type: SubsystemStatus -> Request from SCCP Management to SCCP Users to query the specified subsystem status.
                         This happens when a SubsystemStatusTest(SST) message is received
          params: "ssn" -> The requested subsystem
    returned params:
                  "subsystem-status" -> The status of the subsystem: UserOutOfService, UserInService
                                        Missing = UserOutOfService

Parameters

type	The type of notification
params	List of parameters

Returns: False on error

Reimplemented in SS7TCAP.

◆ notifyData()

virtual HandledMSU notifyData	(	DataBlock &	data,
		NamedList &	params )

virtual

Notification from SCCP that a message failed to arrive to it's destination

Parameters

data	User data send.
params	SCCP parameters Note! The data may not contain the full message block previously sent (in case of SCCP segmentation), but it must always must contain the first segment

Reimplemented in SS7TCAP.

◆ receivedData()

virtual HandledMSU receivedData	(	DataBlock &	data,
		NamedList &	params )

virtual

Notification from SCCP that a message has arrived

Parameters

data	Received user data
params	SCCP parameters

Returns: True if this user has processed the message, false otherwise

Reimplemented in SS7TCAP.

◆ sccp()

SCCP * sccp ( ) const

inline

Retrieve the SCCP to which this component is attached

Returns: Pointer to the attached SCCP or NULL

Referenced by attach().

◆ sccpNotify()

virtual bool sccpNotify	(	SCCP::Type	type,
		NamedList &	params )

virtual

Send a request / notification from users to sccp regarding a subsystem status

Type : CoordinateRequest -> Request from a user to sccp to go OOS
     params: "ssn" The ssn to go OOS
             "smi" Subsystem multiplicity indicator
           "backups" The number of backup subsystems
           "backup.N.ssn" The ssn of the backup subsystem number N
           "backup.N.pointcode" The ssn of the backup subsystem number N
Type : CoordinateResponse -> Indication from a user to sccp in response to CoordinateIndication<
     params: "ssn" The subsystem number that approved the indication
             "smi" 0
Type : StatusRequest -> Request from user to sccp to update a subsystem status
           params: "ssn" The affected subsystem number
                   "smi" 0;
                   "subsystem-status": The requested status: UserOutOfService, UserInService

Parameters

type	The type of request / notification
params	List of parameters

Returns: True if sccp management has processed the request / notification.

◆ sendData()

virtual bool sendData	(	DataBlock &	data,
		NamedList &	params )

virtual

Send a message to SCCP for transport

Parameters

data	User data
params	SCCP parameters Note! If the request is made with return option set there is no warranty that a notification will be received in case that the message failed to be delivered

Reimplemented in SS7TCAP.

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

yatesig.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SCCPUser()

◆ ~SCCPUser()

Member Function Documentation

◆ attach()

◆ destroyed()

◆ initialize()

◆ managementNotify()

◆ notifyData()

◆ receivedData()

◆ sccp()

◆ sccpNotify()

◆ sendData()