IAXEvent Class Reference

Event class. More...

#include <yateiax.h>

List of all members.

Public Types
enum	Type {   Invalid = 0, 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

enum Type

Event type as enumeration

---

Constructor & Destructor Documentation

~IAXEvent

(

)

Destructor Dereferences the transaction possibly causing its destruction

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

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

---

Member Function Documentation

bool final

(

)

const [inline]

Check if this is a transaction finalization event

Returns:

True if the transaction has finalized and will be destroyed

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

IAXEngine* getEngine

(

)

const [inline]

Get the IAX engine this event belongs to, if any

Returns:

The IAX engine this event belongs to, if any

IAXIEList& getList

(

)

[inline]

Get the IE list

Returns:

IE list reference

IAXTransaction* getTransaction

(

)

const [inline]

Get the IAX transaction that generated the event, if any

Returns:

The IAX transaction that generated the event, if any

void* getUserData

(

)

const [inline]

Get the opaque user data stored in the transaction

Returns:

The opaque user data stored in the transaction

References IAXTransaction::getUserData().

bool local

(

)

const [inline]

Check if this is a locally generated event

Returns:

True if it is a locally generated event

void setFinal

(

)

[inline]

Set the final flag.

u_int32_t subclass

(

)

[inline]

Get the subclass of the frame that generated the event

Returns:

Frame subclass

Type type

(

)

const [inline]

Get the type of this event

Returns:

The type of the event as enumeratio

---

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

• yateiax.h