Yate
Public Types | Public Member Functions
SignallingCircuitEvent Class Reference

A single signalling circuit related event. More...

#include <yatesig.h>

Inheritance diagram for SignallingCircuitEvent:
NamedList String GenObject

List of all members.

Public Types

enum  Type {
  Unknown = 0, Dtmf = 1, GenericTone = 2, Timeout = 10,
  Polarity = 11, StartLine = 15, LineStarted = 16, DialComplete = 17,
  OnHook = 20, OffHook = 21, RingBegin = 22, RingEnd = 23,
  RingerOn = 30, RingerOff = 31, Wink = 32, Flash = 33,
  PulseStart = 40, PulseDigit = 41, Connect = 50, Disconnect = 51,
  Connected = 52, Disconnected = 53, Alarm = 100, NoAlarm = 101
}

Public Member Functions

 SignallingCircuitEvent (SignallingCircuit *cic, Type type, const char *name=0)
virtual ~SignallingCircuitEvent ()
Type type () const
SignallingCircuitcircuit ()
bool sendEvent ()

Detailed Description

A single signalling circuit related event.

An object holding a signalling circuit event and related references


Member Enumeration Documentation

enum Type

Type of the event


Constructor & Destructor Documentation

SignallingCircuitEvent ( SignallingCircuit cic,
Type  type,
const char *  name = 0 
)

Constructor for a circuit related event

Parameters:
cicThe circuit that generated this event
typeEvent type as enumeration
nameOptional name for the named list
virtual ~SignallingCircuitEvent ( ) [virtual]

Destructor, dereferences any resources


Member Function Documentation

SignallingCircuit* circuit ( ) [inline]

Get the circuit that generated this event

Returns:
The circuit that generated this event
bool sendEvent ( )

Send this event through the circuit. Release (delete) the event

Returns:
True if the operation succeded
Type type ( ) const [inline]

Get the type of this event

Returns:
The type of this event

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