# class SignallingCircuitEvent | A single signalling circuit related event. More...
Full name | `TelEngine::SignallingCircuitEvent`
Definition | `#include <libs/ysig/yatesig.h>`
Inherits | TelEngine::NamedList [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### 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 Methods

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

## Detailed Description

An object holding a signalling circuit event and related references

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, } | ### Type

Type of the event

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

Constructor for a circuit related event

Parameters:

cic | The circuit that generated this event
type | Event type as enumeration
name | Optional name for the named list

~SignallingCircuitEvent () | ### ~SignallingCircuitEvent

[virtual]

Destructor, dereferences any resources

inline Type type () | ### type

[const]

Get the type of this event

Returns: The type of this event

inline SignallingCircuit* circuit () | ### circuit

Get the circuit that generated this event

Returns: The circuit that generated this event

bool sendEvent () | ### sendEvent

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

Returns: True if the operation succeded

Generated by: paulc on bussard on Mon Feb 10 13:15:47 2014, using kdoc 2.0a54.