|
|
This class holds an event generated by a transaction
enum Type { Invalid = 0, Terminated, Timeout, NotImplemented, New, AuthReq, AuthRep, Accept, Hangup, Reject, Busy, Text, Dtmf, Noise, Answer, Quelch, Unquelch, Progressing, Ringing, } | Type |
Event type as enumeration
~IAXEvent ()
| ~IAXEvent |
Destructor Dereferences the transaction possibly causing its destruction
inline Type type ()
| type |
[const]
Get the type of this event
Returns: The type of the event as enumeratio
inline bool local ()
| local |
[const]
Check if this is a locally generated event
Returns: True if it is a locally generated event
inline bool final ()
| final |
[const]
Check if this is a transaction finalization event
Returns: True if the transaction has finalized and will be destroyed
inline void setFinal ()
| setFinal |
Set the final flag.
inline u_int8_t frameType ()
| frameType |
Get the type of the frame that generated the event If 0 (internal event), the event consumer must delete the event
Returns: Frame type
inline u_int32_t subclass ()
| subclass |
Get the subclass of the frame that generated the event
Returns: Frame subclass
inline IAXEngine* getEngine ()
| getEngine |
[const]
Get the IAX engine this event belongs to, if any
Returns: The IAX engine this event belongs to, if any
inline IAXTransaction* getTransaction ()
| getTransaction |
[const]
Get the IAX transaction that generated the event, if any
Returns: The IAX transaction that generated the event, if any
inline void* getUserData ()
| getUserData |
[const]
Get the opaque user data stored in the transaction
Returns: The opaque user data stored in the transaction
inline IAXIEList& getList ()
| getList |
Get the IE list
Returns: IE list reference
IAXEvent (Type type, bool local, bool final, IAXTransaction* transaction, u_int8_t frameType = 0, u_int32_t subclass = 0)
| IAXEvent |
[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, const IAXFullFrame* frame = 0)
| IAXEvent |
[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 |
Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54. |