SIPEvent Class Reference

#include <yatesip.h>

List of all members.

Public Member Functions

 SIPEvent (SIPMessage *message, SIPTransaction *transaction=0)
SIPEnginegetEngine () const
const SIPMessagegetMessage () const
SIPTransactiongetTransaction () const
bool isOutgoing () const
bool isIncoming () const
SIPParty * getParty () const
void * getUserData () const
int getState () const
bool isActive () const

Protected Attributes

SIPMessagem_message
SIPTransactionm_transaction
int m_state

Friends

class SIPTransaction


Detailed Description

This object is an event that will be taken from SIPEngine

Member Function Documentation

SIPEngine* getEngine (  )  const [inline]

The SIP engine this event belongs to, if any

const SIPMessage* getMessage (  )  const [inline]

The SIP message this event is supposed to handle

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]

The SIP transaction that gererated the event, if any

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


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

Generated on Sun Dec 7 21:36:14 2008 for Yate by  doxygen 1.5.7.1