SS7Layer2 Class Reference

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

#include <yatesig.h>

Inheritance diagram for SS7Layer2:
SignallingComponent RefObject DebugEnabler GenObject SS7M2PA SS7M2UA SS7MTP2

List of all members.

Public Types

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
}
enum  Operation { Pause = 0x100, Resume = 0x200, Align = 0x300, Status = 0x400 }

Public Member Functions

virtual bool transmitMSU (const SS7MSU &msu)=0
virtual ObjListrecoverMSU ()
virtual unsigned int status () const
virtual const char * statusName (unsigned int status, bool brief) const
const char * statusName (bool brief=false) const
virtual bool operational () const =0
void attach (SS7L2User *l2user)
SS7L2Useruser () const
int sls () const
void sls (int linkSel)
virtual bool control (Operation oper, NamedList *params=0)
virtual bool control (NamedList &params)

Protected Member Functions

 SS7Layer2 ()
bool receivedMSU (const SS7MSU &msu)
void notify ()

Detailed Description

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

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


Member Enumeration Documentation

enum LinkStatus

LSSU Status Indications

enum Operation

Control primitives


Constructor & Destructor Documentation

SS7Layer2 (  )  [inline, protected]

Constructor


Member Function Documentation

void attach ( SS7L2User l2user  ) 

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

Parameters:
l2user Pointer to Layer 2 user component to attach

Referenced by SS7MTP2::destroyed().

virtual bool control ( NamedList params  )  [virtual]

Query or modify layer's settings or operational parameters

Parameters:
params The list of parameters to query or change
Returns:
True if the control operation was executed

Reimplemented from SignallingComponent.

virtual bool control ( Operation  oper,
NamedList params = 0 
) [virtual]

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

Parameters:
oper Operation to execute
params Optional parameters for the operation
Returns:
True if the command completed successfully, for query operations also indicates the data link is aligned and operational

Reimplemented in SS7MTP2.

void notify (  )  [inline, protected]

Notify out user part about a status change

virtual bool operational (  )  const [pure virtual]

Check if the link is fully operational

Returns:
True if the link is aligned and operational

Implemented in SS7MTP2.

bool receivedMSU ( const SS7MSU msu  )  [inline, protected]

Push a received Message Signal Unit up the protocol stack

Parameters:
msu Message data, starting with Service Indicator Octet
Returns:
True if message was successfully delivered to the user component
virtual ObjList* recoverMSU (  )  [virtual]

Remove the MSUs waiting in the transmit queue and return them

Returns:
List of MSUs taken from the queue

Reimplemented in SS7MTP2.

void sls ( int  linkSel  )  [inline]

Assign a new Signalling Link Selection number

Parameters:
linkSel New SLS to assign to this link
int sls (  )  const [inline]

Get the Signalling Link Selection number allocated to this link

Returns:
SLS value assigned by the upper layer
virtual unsigned int status (  )  const [virtual]

Retrive the current link status indications

Returns:
Link status indication bits

Reimplemented in SS7MTP2.

const char* statusName ( bool  brief = false  )  const [inline]

Get the name of the current local Layer 2 status

Parameters:
brief Request to return the short status name
Returns:
String describing the status

References SS7Layer2::statusName().

Referenced by SS7Layer2::statusName().

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

Get the name of a Layer 2 status

Parameters:
status Status indication value
brief Request to return the short status name
Returns:
String describing the status
virtual bool transmitMSU ( const SS7MSU msu  )  [pure virtual]

Push a Message Signal Unit down the protocol stack

Parameters:
msu Message data, starting with Service Indicator Octet
Returns:
True if message was successfully queued

Implemented in SS7MTP2.

SS7L2User* user (  )  const [inline]

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

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

The documentation for this class was generated from the following file:
Generated on Thu Apr 8 18:19:45 2010 for Yate by  doxygen 1.6.3