IAXEvent Class Reference

Event class. More...

#include <yateiax.h>

Public Types
enum	Type {   DontSet = 0 , Invalid , Terminated , Timeout ,   NotImplemented , New , AuthReq , AuthRep ,   Accept , Hangup , Reject , Busy ,   Text , Dtmf , Noise , Answer ,   Quelch , Unquelch , Progressing , Ringing }

Public Member Functions
	~IAXEvent ()
Type	type () const
bool	local () const
bool	final () const
void	setFinal ()
u_int8_t	frameType ()
u_int32_t	subclass ()
IAXEngine *	getEngine () const
IAXTransaction *	getTransaction () const
void *	getUserData () const
IAXIEList &	getList ()

Protected Member Functions
	IAXEvent (Type type, bool local, bool final, IAXTransaction *transaction, u_int8_t frameType=0, u_int32_t subclass=0)
	IAXEvent (Type type, bool local, bool final, IAXTransaction *transaction, IAXFullFrame *frame=0)

Friends
class	IAXTransaction
class	IAXConnectionlessTransaction

Detailed Description

Event class.

This class holds an event generated by a transaction

Member Enumeration Documentation

Type

enum Type

Event type as enumeration

Constructor & Destructor Documentation

~IAXEvent()

~IAXEvent

(

)

Destructor Dereferences the transaction possibly causing its destruction

IAXEvent() [1/2]

IAXEvent ( Type type, bool local, bool final, IAXTransaction * transaction, u_int8_t frameType = 0, u_int32_t subclass = 0 )

protected

Constructor

Parameters

type	Event type
local	Local flag
final	Final flag
transaction	IAX transaction that generated the event
frameType	The type of the frame that generated the event
subclass	The subclass of the frame that generated the event

References frameType(), local(), subclass(), and type().

Referenced by IAXEvent().

IAXEvent() [2/2]

IAXEvent ( Type type, bool local, bool final, IAXTransaction * transaction, IAXFullFrame * frame = 0 )

protected

Constructor

Parameters

type	Event type
local	Local flag
final	Final flag
transaction	IAX transaction that generated the event
frame	The frame that generated the event

References IAXEvent(), local(), and type().

Member Function Documentation

final()

bool final ( ) const

inline

Check if this is a transaction finalization event

Returns

True if the transaction has finalized and will be destroyed

frameType()

u_int8_t frameType ( )

inline

Get the type of the frame that generated the event If 0 (internal event), the event consumer must delete the event

Returns

Frame type

Referenced by IAXEvent().

getEngine()

IAXEngine * getEngine ( ) const

inline

Get the IAX engine this event belongs to, if any

Returns

The IAX engine this event belongs to, if any

getList()

IAXIEList & getList ( )

inline

Get the IE list

Returns

IE list reference

getTransaction()

IAXTransaction * getTransaction ( ) const

inline

Get the IAX transaction that generated the event, if any

Returns

The IAX transaction that generated the event, if any

getUserData()

void * getUserData ( ) const

inline

Get the opaque user data stored in the transaction

Returns

The opaque user data stored in the transaction

local()

bool local ( ) const

inline

Check if this is a locally generated event

Returns

True if it is a locally generated event

Referenced by IAXEvent(), and IAXEvent().

setFinal()

void setFinal ( )

inline

Set the final flag.

subclass()

u_int32_t subclass ( )

inline

Get the subclass of the frame that generated the event

Returns

Frame subclass

Referenced by IAXEvent().

type()

Type type ( ) const

inline

Get the type of this event

Returns

The type of the event as enumeratio

Referenced by IAXEvent(), and IAXEvent().

---

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

• yateiax.h