SIPEvent Class Reference

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

#include <yatesip.h>

Public Member Functions
	SIPEvent (SIPMessage *message, SIPTransaction *transaction=0)
SIPEngine *	getEngine () const
SIPMessage *	getMessage () const
SIPTransaction *	getTransaction () const
bool	isOutgoing () const
bool	isIncoming () const
SIPParty *	getParty () const
void *	getUserData () const
int	getState () const
bool	isActive () const
const String &	traceId () const

Protected Attributes
SIPMessage *	m_message
SIPTransaction *	m_transaction
int	m_state

Friends
class	SIPTransaction

Detailed Description

A SIP event as retrieved from engine.

This object is an event that will be taken from SIPEngine

Member Function Documentation

getEngine()

SIPEngine * getEngine ( ) const

inline

Get the SIP engine this event belongs to, if any

Returns

Pointer to owning SIP engine or NULL

getMessage()

SIPMessage * getMessage ( ) const

inline

Get the SIP message this event is supposed to handle

Returns

Pointer to SIP message causing the event

getParty()

SIPParty * getParty ( ) const

inline

Get the pointer to the endpoint this event uses

getState()

int getState ( ) const

inline

The state of the transaction when the event was generated

getTransaction()

SIPTransaction * getTransaction ( ) const

inline

Get the SIP transaction that generated the event, if any

Returns

Pointer to owning SIP transaction or NULL

getUserData()

void * getUserData ( ) const

inline

Return the opaque user data stored in the transaction

isActive()

bool isActive ( ) const

inline

Check if the transaction was active when the event was generated

Returns

True if the transaction was active, false if it finished

isIncoming()

bool isIncoming ( ) const

inline

Check if the message is an incoming message

Returns

True if the message is coming from remote

isOutgoing()

bool isOutgoing ( ) const

inline

Check if the message is an outgoing message

Returns

True if the message should be sent to remote

traceId()

const String & traceId ( ) const

inline

Retrieve the trace ID associated with this event

Returns

The trace ID, it can be empty.

References String::empty(), and GenObject::traceId().

---

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

• yatesip.h