SIPEvent Class Reference

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

#include <yatesip.h>

List of all members.

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
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

SIPEngine* getEngine

(

)

const [inline]

Get the SIP engine this event belongs to, if any

Returns:

Pointer to owning SIP engine or NULL

SIPMessage* getMessage

(

)

const [inline]

Get the SIP message this event is supposed to handle

Returns:

Pointer to SIP message causing the event

SIPParty* getParty

(

)

const [inline]

Get the pointer to the endpoint this event uses

int getState

(

)

const [inline]

The state of the transaction when the event was generated

SIPTransaction* getTransaction

(

)

const [inline]

Get the SIP transaction that generated the event, if any

Returns:

Pointer to owning SIP transaction or NULL

void* getUserData

(

)

const [inline]

Return the opaque user data stored in the transaction

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

bool isIncoming

(

)

const [inline]

Check if the message is an incoming message

Returns:

True if the message is coming from remote

bool isOutgoing

(

)

const [inline]

Check if the message is an outgoing message

Returns:

True if the message should be sent to remote

References SIPTransaction::isOutgoing().

---

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

• yatesip.h