class SIPEvent

A SIP event as retrieved from engine. More...

Full nameTelEngine::SIPEvent
Definition#include <libs/ysip/yatesip.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Members


Detailed Description

This object is an event that will be taken from SIPEngine

 SIPEvent ()

SIPEvent

 SIPEvent (SIPMessage* message, SIPTransaction* transaction = 0)

SIPEvent

 ~SIPEvent ()

~SIPEvent

inline SIPEngine*  getEngine ()

getEngine

[const]

Get the SIP engine this event belongs to, if any

Returns: Pointer to owning SIP engine or NULL

inline SIPMessage*  getMessage ()

getMessage

[const]

Get the SIP message this event is supposed to handle

Returns: Pointer to SIP message causing the event

inline SIPTransaction*  getTransaction ()

getTransaction

[const]

Get the SIP transaction that generated the event, if any

Returns: Pointer to owning SIP transaction or NULL

inline bool  isOutgoing ()

isOutgoing

[const]

Check if the message is an outgoing message

Returns: True if the message should be sent to remote

inline bool  isIncoming ()

isIncoming

[const]

Check if the message is an incoming message

Returns: True if the message is coming from remote

inline SIPParty*  getParty ()

getParty

[const]

Get the pointer to the endpoint this event uses

inline void*  getUserData ()

getUserData

[const]

Return the opaque user data stored in the transaction

inline int  getState ()

getState

[const]

The state of the transaction when the event was generated

inline bool  isActive ()

isActive

[const]

Check if the transaction was active when the event was generated

Returns: True if the transaction was active, false if it finished

SIPMessage* m_message

m_message

[protected]

SIPTransaction* m_transaction

m_transaction

[protected]

int m_state

m_state

[protected]


Generated by: paulc on bussard on Wed Oct 21 01:57:30 2009, using kdoc 2.0a54.