Yate
Public Member Functions | Protected Member Functions | Friends
ISDNQ931Call Class Reference

A Q.931 ISDN call. More...

#include <yatesig.h>

Inheritance diagram for ISDNQ931Call:
ISDNQ931State SignallingCall RefObject Mutex GenObject Lockable

List of all members.

Public Member Functions

virtual ~ISDNQ931Call ()
u_int32_t callRef () const
u_int32_t callRefLen () const
u_int8_t callTei () const
SignallingCircuitcircuit ()
void setTerminate (bool destroy, const char *reason)
virtual bool sendEvent (SignallingEvent *event)
virtual SignallingEventgetEvent (const Time &when)
void dataLinkState (bool up)
virtual void * getObject (const String &name) const

Protected Member Functions

 ISDNQ931Call (ISDNQ931 *controller, bool outgoing, u_int32_t callRef, u_int8_t callRefLen, u_int8_t tei=0)
SignallingEventreleaseComplete (const char *reason=0, const char *diag=0)
SignallingEventgetCircuitEvent (const Time &when)

Friends

class ISDNQ931

Detailed Description

A Q.931 ISDN call.

Q.931 ISDN call


Constructor & Destructor Documentation

virtual ~ISDNQ931Call ( ) [virtual]

Destructor

ISDNQ931Call ( ISDNQ931 controller,
bool  outgoing,
u_int32_t  callRef,
u_int8_t  callRefLen,
u_int8_t  tei = 0 
) [protected]

Constructor

Parameters:
controllerThe call controller
outgoingThe call direction
callRefThe call reference
callRefLenThe call reference length in bytes
teiThe Terminal Equipment Identifier used in this call

Member Function Documentation

u_int32_t callRef ( ) const [inline]

Get the id of this call

Returns:
The call reference

Referenced by ISDNQ931::sendRelease(), and ISDNQ931::sendStatus().

u_int32_t callRefLen ( ) const [inline]

Get the length of the call reference

Returns:
The length of the call reference

Referenced by ISDNQ931::sendRelease(), and ISDNQ931::sendStatus().

u_int8_t callTei ( ) const [inline]

Get the Terminal Equipment Indicator for this call

Returns:
Value of TEI used in this call
SignallingCircuit* circuit ( ) [inline]

Get the circuit this call had reserved

Returns:
The circuit reserved by this call
void dataLinkState ( bool  up)

Data link (interface) state notification This method is thread safe

Parameters:
upThe data link state
SignallingEvent* getCircuitEvent ( const Time when) [protected]

Get an event from the circuit reserved for this call

Parameters:
whenThe current time
Returns:
SignallingEvent pointer or 0 if no events
virtual SignallingEvent* getEvent ( const Time when) [virtual]

Get an event from this call This method is thread safe

Parameters:
whenThe current time
Returns:
SignallingEvent pointer or 0 if no events

Implements SignallingCall.

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

Get a pointer to a data member or this call

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

Reimplemented from RefObject.

SignallingEvent* releaseComplete ( const char *  reason = 0,
const char *  diag = 0 
) [protected]

Send RELEASE COMPLETE if not in Null state. Clear all call data. Remove from controller's queue. Decrease the object's refence count

Parameters:
reasonOptional release reason. If missing, the last reason is used
diagOptional hexified string for the cause diagnostic
Returns:
Pointer to an SignallingEvent of type Release, with no message
virtual bool sendEvent ( SignallingEvent event) [virtual]

Send an event to this call This method is thread safe

Parameters:
eventThe sent event
Returns:
True if the operation succedded

Reimplemented from SignallingCall.

void setTerminate ( bool  destroy,
const char *  reason 
)

Set termination (and destroy) flags This method is thread safe

Parameters:
destroyThe destroy flag. If true, the call will be destroyed
reasonTerminate reason

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