SS7MTP2 Class Reference

SS7 Layer 2 implementation on top of a hardware interface. More...

#include <yatesig.h>

Inheritance diagram for SS7MTP2:
SS7Layer2 SignallingReceiver SignallingDumpable Mutex SignallingComponent SignallingComponent Lockable RefObject DebugEnabler RefObject DebugEnabler GenObject GenObject

List of all members.

Public Types

enum  ErrorCorrection { Basic, Preventive, Adaptive }

Public Member Functions

 SS7MTP2 (const NamedList &params, unsigned int status=OutOfService)
virtual ~SS7MTP2 ()
virtual bool initialize (const NamedList *config)
virtual bool transmitMSU (const SS7MSU &msu)
virtual ObjListrecoverMSU ()
virtual unsigned int status () const
virtual bool aligned () const
virtual bool operational () const
virtual bool control (Operation oper, NamedList *params=0)
virtual bool notify (SignallingInterface::Notification event)

Protected Member Functions

virtual void destroyed ()
virtual void timerTick (const Time &when)
virtual bool receivedPacket (const DataBlock &packet)
virtual void processFISU ()
virtual void processLSSU (unsigned int status)
bool transmitLSSU (unsigned int status)
bool transmitLSSU ()
bool transmitFISU ()
void startAlignment (bool emergency=false)
void abortAlignment ()
bool startProving ()

Detailed Description

SS7 Layer 2 implementation on top of a hardware interface.

Q.703 SS7 Layer 2 (Data Link) implementation on top of a hardware interface


Member Enumeration Documentation

Types of error correction


Constructor & Destructor Documentation

SS7MTP2 ( const NamedList params,
unsigned int  status = OutOfService 
)

Constructor

Parameters:
params Layer's parameters
status Initial status
virtual ~SS7MTP2 (  )  [virtual]

Destructor


Member Function Documentation

void abortAlignment (  )  [protected]

Abort an alignment procedure if link errors occur

virtual bool aligned (  )  const [virtual]

Check if the link is aligned. The link may not be operational, the other side may be still proving.

Returns:
True if the link is aligned
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 from SS7Layer2.

virtual void destroyed (  )  [inline, protected, virtual]

Remove all attachements. Disposes the memory

Reimplemented from SignallingComponent.

References SignallingReceiver::attach(), SS7Layer2::attach(), SignallingComponent::destroyed(), and TelEngine::destruct().

virtual bool initialize ( const NamedList config  )  [virtual]

Configure and initialize MTP2 and its interface

Parameters:
config Optional configuration parameters override
Returns:
True if MTP2 and the interface were initialized properly

Reimplemented from SignallingComponent.

virtual bool notify ( SignallingInterface::Notification  event  )  [virtual]

Process a notification generated by the attached interface

Parameters:
event Notification event reported by the interface
Returns:
True if notification was processed

Reimplemented from SignallingReceiver.

virtual bool operational (  )  const [virtual]

Check if the link is aligned and operational

Returns:
True if the link is operational

Implements SS7Layer2.

virtual void processFISU (  )  [protected, virtual]

Process a received Fill-In Signal Unit

virtual void processLSSU ( unsigned int  status  )  [protected, virtual]

Process a received Link Status Signal Unit

Parameters:
status Link status indications
virtual bool receivedPacket ( const DataBlock packet  )  [protected, virtual]

Process a Signalling Packet received by the hardware interface

Returns:
True if message was successfully processed

Implements SignallingReceiver.

virtual ObjList* recoverMSU (  )  [virtual]

Remove the MSUs waiting in the transmit queue and return them

Returns:
List of MSUs taken from the queue

Reimplemented from SS7Layer2.

void startAlignment ( bool  emergency = false  )  [protected]

Initiates alignment and proving procedure

Parameters:
emergency True if emergency alignment is desired
bool startProving (  )  [protected]

Start the link proving period

Returns:
True if proving period was started
virtual unsigned int status (  )  const [virtual]

Retrive the current link status indications

Returns:
Link status indication bits

Reimplemented from SS7Layer2.

virtual void timerTick ( const Time when  )  [protected, virtual]

Periodical timer tick used to perform alignment and housekeeping

Parameters:
when Time to use as computing base for events and timeouts

Reimplemented from SignallingComponent.

bool transmitFISU (  )  [protected]

Push a Fill-In Signal Unit down the protocol stack

Returns:
True if message was successfully queued
bool transmitLSSU (  )  [inline, protected]

Push a Link Status Signal Unit with the current status down the protocol stack

Returns:
True if message was successfully queued

References SS7MTP2::transmitLSSU().

Referenced by SS7MTP2::transmitLSSU().

bool transmitLSSU ( unsigned int  status  )  [protected]

Push a Link Status Signal Unit down the protocol stack

Parameters:
status Link status indications
Returns:
True if message was successfully queued
virtual bool transmitMSU ( const SS7MSU msu  )  [virtual]

Push a Message Signal Unit down the protocol stack

Parameters:
msu MSU data to transmit
Returns:
True if message was successfully queued

Implements SS7Layer2.


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