ISDNQ921 Class Reference

ISDN Q.921 implementation on top of a hardware interface. More...

#include <yatesig.h>

Inheritance diagram for ISDNQ921:

ISDNLayer2 SignallingReceiver SignallingComponent SignallingComponent GenObject DebugEnabler GenObject DebugEnabler

List of all members.

Public Member Functions

 ISDNQ921 (const NamedList &params, const char *name=0)
virtual ~ISDNQ921 ()
u_int64_t dataTimeout () const
virtual bool multipleFrame (bool establish, bool force)
virtual bool sendData (const DataBlock &data, bool ack)
virtual void cleanup ()
virtual void * getObject (const String &name) const
virtual void destruct ()
void setDebug (bool printFrames, bool extendedDebug)
void setDumper (SignallingDumper *dumper=0)

Protected Member Functions

virtual void timerTick (const Time &when)
virtual bool receivedPacket (const DataBlock &packet)
virtual bool notify (SignallingInterface::Notification event)
void reset ()


Detailed Description

ISDN Q.921 implementation on top of a hardware interface.

Q.921 ISDN Layer 2 implementation on top of a hardware HDLC interface


Constructor & Destructor Documentation

ISDNQ921 ( const NamedList params,
const char *  name = 0 
)

Constructor Initialize this object and the component

Parameters:
params Layer's and TelEngine::ISDNLayer2 parameters
name Name of this component

virtual ~ISDNQ921 (  )  [virtual]

Destructor


Member Function Documentation

u_int64_t dataTimeout (  )  const [inline]

Get the timeout of a data frame. After that, a higher layer may retransmit data

Returns:
The timeout of a data frame

virtual bool multipleFrame ( bool  establish,
bool  force 
) [virtual]

Implements Q.921 DL-ESTABLISH and DL-RELEASE request primitives If accepted, the primitive is enqueued for further processing This method is thread safe

Parameters:
establish True to establish. False to release
force True to establish even if we already are in this mode. This parameter is ignored if establish is false
Returns:
True if the request was accepted

Reimplemented from ISDNLayer2.

virtual bool sendData ( const DataBlock data,
bool  ack 
) [virtual]

Implements Q.921 DL-DATA and DL-UNIT DATA request primitives Send data through the HDLC interface This method is thread safe

Parameters:
data Data to send
ack True to send an acknoledged frame, false to send an unacknoledged one
Returns:
False if the request was not accepted or send operation failed

Reimplemented from ISDNLayer2.

virtual void cleanup (  )  [virtual]

Emergency release. Send 'disconnect' command. Reset all data. Set state to 'Released' This method is thread safe

Implements ISDNLayer2.

virtual void* getObject ( const String name  )  const [virtual]

Get a pointer to a data member or this layer

Parameters:
name Object name
Returns:
The requested pointer or 0 if not exists

Reimplemented from GenObject.

virtual void destruct (  )  [inline, virtual]

Detach links. Disposes memory

Reimplemented from GenObject.

References SignallingReceiver::attach(), ISDNLayer2::attach(), and GenObject::destruct().

void setDebug ( bool  printFrames,
bool  extendedDebug 
) [inline]

Set debug data of this layer

Parameters:
printFrames Enable/disable frame printing on output
extendedDebug Enable/disable hex data dump if print frames is enabled

void setDumper ( SignallingDumper dumper = 0  ) 

Set or remove a data dumper

Parameters:
dumper Pointer to the data dumper object, 0 to remove

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

Method called periodically to check timeouts This method is thread safe

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

Reimplemented from SignallingComponent.

virtual bool receivedPacket ( const DataBlock packet  )  [protected, virtual]

Process a packet received by the receiver's interface This method is thread safe

Parameters:
packet The received packet
Returns:
True if message was successfully processed

Implements SignallingReceiver.

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

Process a notification generated by the attached interface This method is thread safe

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

Reimplemented from SignallingReceiver.

void reset (  )  [protected]

Reset object if not in Released state. Drop all frames This method is thread safe


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

Generated on Mon Aug 11 16:17:54 2008 for Yate by  doxygen 1.5.6