#include <yateiax.h>
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, const IAXFullFrame *frame=0) | |
Friends | |
class | IAXTransaction |
class | IAXConnectionlessTransaction |
This class holds an event generated by a transaction
enum Type |
Event type as enumeration
~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
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, | |||
const IAXFullFrame * | frame = 0 | |||
) | [protected] |
Constructor
type | Event type | |
local | Local flag | |
final | Final flag | |
transaction | IAX transaction that generated the event | |
frame | The frame that generated the event |
Type type | ( | ) | const [inline] |
Get the type of this event
bool local | ( | ) | const [inline] |
Check if this is a locally generated event
bool final | ( | ) | const [inline] |
Check if this is a transaction finalization event
void setFinal | ( | ) | [inline] |
Set the final flag.
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
u_int32_t subclass | ( | ) | [inline] |
Get the subclass of the frame that generated the event
IAXEngine* getEngine | ( | ) | const [inline] |
Get the IAX engine this event belongs to, if any
IAXTransaction* getTransaction | ( | ) | const [inline] |
Get the IAX transaction that generated the event, if any
void* getUserData | ( | ) | const [inline] |
Get the opaque user data stored in the transaction
IAXIEList& getList | ( | ) | [inline] |
Get the IE list