SignallingEvent Class Reference

A single signalling related event. More...

#include <yatesig.h>

List of all members.

Public Types
enum	Type {   Unknown = 0, Generic, NewCall, Accept,   Connect, Complete, Progress, Ringing,   Answer, Transfer, Suspend, Resume,   Release, Info, Message, Facility,   Circuit, Enable, Disable, Reset,   Verify }
Public Member Functions
	SignallingEvent (Type type, SignallingMessage *message, SignallingCall *call)
	SignallingEvent (Type type, SignallingMessage *message, SignallingCallControl *controller=0)
	SignallingEvent (SignallingCircuitEvent *&event, SignallingCall *call)
virtual	~SignallingEvent ()
const char *	name () const
Type	type () const
SignallingCall *	call () const
SignallingMessage *	message () const
SignallingCallControl *	controller () const
SignallingCircuitEvent *	cicEvent () const
bool	sendEvent ()
Static Public Member Functions
static const char *	typeName (Type t)

---

Detailed Description

A single signalling related event.

An object holding a signalling event and related references

---

Member Enumeration Documentation

enum Type

Type of the event

---

Constructor & Destructor Documentation

SignallingEvent	(	Type	type,
		SignallingMessage *	message,
		SignallingCall *	call
	)

Constructor for a call related event

Parameters:

type	Type of the event
message	Message carried by the event
call	Call this event refers to

SignallingEvent	(	Type	type,
		SignallingMessage *	message,
		SignallingCallControl *	controller = 0
	)

Constructor for a controller related event

Parameters:

type	Type of the event
message	Message carried by the event
controller	Controller this event refers to

SignallingEvent	(	SignallingCircuitEvent *&	event,
		SignallingCall *	call
	)

Constructor for a signalling circuit related event

Parameters:

event	The event signaled by the circuit, will be consumed and zeroed
call	Call this event refers to

virtual ~SignallingEvent

(

)

[virtual]

Destructor, dereferences any resources, notify the signalling call of termination

---

Member Function Documentation

SignallingCall* call

(

)

const [inline]

Get the call that generated this event, may be NULL

SignallingCircuitEvent* cicEvent

(

)

const [inline]

Retrieve the circuit event

SignallingCallControl* controller

(

)

const [inline]

Retrieve the controller of the call

SignallingMessage* message

(

)

const [inline]

Get the message that generated this event, may be NULL

const char* name

(

)

const [inline]

Get the string associated with this event's type

Returns:

The string associated with this event's type, if any

bool sendEvent

(

)

Send this event through the call that generated it

Returns:

True if there was a call and the operation succedded

Type type

(

)

const [inline]

Get the type of the event

Returns:

Type of event, may be unknown

static const char* typeName

(

Type

t

)

[inline, static]

Get the text associated with a given event type for debug purposes

Parameters:

t	The requested type

Returns:

The text associated with the given type

References TelEngine::lookup().

---

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

• yatesig.h