class SS7Layer2

Abstract SS7 layer 2 (data link) message transfer part. More...

Contains pure virtuals
Full nameTelEngine::SS7Layer2
Definition#include <libs/ysig/yatesig.h>
InheritsTelEngine::SignallingComponent [virtual public ]
Inherited bySS7M2PA, SS7M2UA, SS7MTP2
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Methods


Detailed Description

An interface to a Layer 2 (data link) SS7 message transfer part

enum LinkStatus { OutOfAlignment = 0, NormalAlignment = 1, EmergencyAlignment = 2, OutOfService = 3, ProcessorOutage = 4, Busy = 5, O = OutOfAlignment, N = NormalAlignment, E = EmergencyAlignment, OS = OutOfService, PO = ProcessorOutage, B = Busy, }

LinkStatus

LSSU Status Indications

enum Operation { Pause = 0x100, Resume = 0x200, Align = 0x300, Status = 0x400, }

Operation

Control primitives

bool  transmitMSU (const SS7MSU& msu)

transmitMSU

[pure virtual]

Push a Message Signal Unit down the protocol stack

Parameters:
msuMessage data, starting with Service Indicator Octet

Returns: True if message was successfully queued

ObjList*  recoverMSU ()

recoverMSU

[virtual]

Remove the MSUs waiting in the transmit queue and return them

Returns: List of MSUs taken from the queue

unsigned int  status ()

status

[const virtual]

Retrive the current link status indications

Returns: Link status indication bits

const char*  statusName (unsigned int status, bool brief)

statusName

[const virtual]

Get the name of a Layer 2 status

Parameters:
statusStatus indication value
briefRequest to return the short status name

Returns: String describing the status

inline const char*  statusName (bool brief = false)

statusName

[const]

Get the name of the current local Layer 2 status

Parameters:
briefRequest to return the short status name

Returns: String describing the status

bool  operational ()

operational

[const pure virtual]

Check if the link is fully operational

Returns: True if the link is aligned and operational

void  attach (SS7L2User* l2user)

attach

Attach a Layer 2 user component to the data link. Detach from the old one if valid

Parameters:
l2userPointer to Layer 2 user component to attach

inline SS7L2User*  user ()

user

[const]

Get the Layer 2 user component that works with this data link

Returns: Pointer to the user component to which the messages are sent

inline int  sls ()

sls

[const]

Get the Signalling Link Selection number allocated to this link

Returns: SLS value assigned by the upper layer

inline void  sls (int linkSel)

sls

Assign a new Signalling Link Selection number

Parameters:
linkSelNew SLS to assign to this link

bool  control (Operation oper, NamedList* params = 0)

control

[virtual]

Execute a control operation. Operations can change the link status or can query the aligned status.

Parameters:
operOperation to execute
paramsOptional parameters for the operation

Returns: True if the command completed successfully, for query operations also indicates the data link is aligned and operational

Reimplemented from SignallingComponent.

bool  control (NamedList& params)

control

[virtual]

Query or modify layer's settings or operational parameters

Parameters:
paramsThe list of parameters to query or change

Returns: True if the control operation was executed

Reimplemented from SignallingComponent.

inline  SS7Layer2 ()

SS7Layer2

[protected]

Constructor

inline bool  receivedMSU (const SS7MSU& msu)

receivedMSU

[protected]

Push a received Message Signal Unit up the protocol stack

Parameters:
msuMessage data, starting with Service Indicator Octet

Returns: True if message was successfully delivered to the user component

inline void  notify ()

notify

[protected]

Notify out user part about a status change


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.