SIPSubscribeHandler Class Reference

#include <handlers.h>

Inheritance diagram for SIPSubscribeHandler:

Collaboration diagram for SIPSubscribeHandler:

Public Member Functions
	SIPSubscribeHandler (SIPEndPoint &ep, const SIPSubscribe::Params &params)
	~SIPSubscribeHandler ()
virtual SIPTransaction *	CreateTransaction (OpalTransport &)
virtual void	OnReceivedOK (SIPTransaction &transaction, SIP_PDU &response)
virtual PBoolean	OnReceivedNOTIFY (SIP_PDU &response)
virtual void	OnFailed (SIP_PDU::StatusCodes)
virtual SIPEventPackage	GetEventPackage () const
void	UpdateParameters (const SIPSubscribe::Params &params)
const SIPSubscribe::Params &	GetParams () const
Public Member Functions inherited from SIPHandler
	~SIPHandler ()
virtual PString	GetAuthID () const
virtual PString	GetPassword () const
void	SetState (SIPHandler::State s)
SIPHandler::State	GetState () const
const PString &	GetCallID () const
virtual const SIPURL &	GetAddressOfRecord () const
virtual void	SetExpire (int e)
virtual int	GetExpire () const
virtual void	SetBody (const PString &)
virtual bool	IsDuplicateCSeq (unsigned)
SIP_PDU::Methods	GetMethod () const
virtual void	OnReceivedResponse (SIPTransaction &transaction, SIP_PDU &response)
virtual void	OnReceivedIntervalTooBrief (SIPTransaction &transaction, SIP_PDU &response)
virtual void	OnReceivedTemporarilyUnavailable (SIPTransaction &transaction, SIP_PDU &response)
virtual void	OnReceivedForbidden (SIPTransaction &transaction, SIP_PDU &response)
virtual void	OnReceivedAuthenticationRequired (SIPTransaction &transaction, SIP_PDU &response)
virtual void	OnTransactionFailed (SIPTransaction &transaction)
bool	ActivateState (SIPHandler::State state, bool resetInterface=false)
virtual bool	SendNotify (const PObject *)
SIP_PDU::StatusCodes	GetLastResponseStatus () const
const OpalProductInfo &	GetProductInfo () const
const PString &	GetRealm () const
virtual bool	ShutDown ()
Public Member Functions inherited from SIPTransactionOwner
	SIPTransactionOwner (PSafeObject &object, SIPEndPoint &endpoint)
virtual	~SIPTransactionOwner ()
virtual unsigned	GetAllowedMethods () const
virtual void	OnStartTransaction (SIPTransaction &)
void	FinaliseForking (SIPTransaction &transaction, SIP_PDU &response)
bool	CleanPendingTransactions ()
void	AbortPendingTransactions (bool all=true)
virtual SIP_PDU::StatusCodes	StartTransaction (const OpalTransport::WriteConnectCallback &function)
SIP_PDU::StatusCodes	SwitchTransportProto (const char *proto, SIP_PDU *pdu)
SIP_PDU::StatusCodes	HandleAuthentication (const SIP_PDU &response)
SIPEndPoint &	GetEndPoint () const
OpalTransportAddress	GetRemoteTransportAddress () const
const SIPURL &	GetRequestURI () const
const SIPURL &	GetRemoteURI () const
const SIPURL &	GetProxy () const
const PString &	GetInterface () const
PINDEX	GetDNSEntry () const
SIPAuthentication *	GetAuthenticator () const
SIPDialogContext &	GetDialog ()
const SIPDialogContext &	GetDialog () const

Protected Member Functions
virtual void	WriteTransaction (OpalTransport &transport, bool &succeeded)
virtual void	SendStatus (SIP_PDU::StatusCodes code, State state)
bool	DispatchNOTIFY (SIP_PDU &request, SIP_PDU &response)
Protected Member Functions inherited from SIPHandler
	SIPHandler (SIP_PDU::Methods method, SIPEndPoint &ep, const SIPParameters &params, const PString &callID=SIPTransaction::GenerateCallID())
virtual PBoolean	SendRequest (SIPHandler::State state)
void	RetryLater (unsigned after)
void	OnExpireTimeout ()
	PDECLARE_WriteConnectCallback (SIPHandler, WriteTransaction)
Protected Member Functions inherited from SIPTransactionOwner
	PDECLARE_MUTEX (m_forkMutex)

Protected Attributes
SIPSubscribe::Params	m_parameters
bool	m_unconfirmed
SIPEventPackageHandler *	m_packageHandler
Protected Attributes inherited from SIPHandler
const PString	m_callID
PString	m_username
PString	m_password
PString	m_realm
const SIP_PDU::Methods	m_method
const SIPURL	m_addressOfRecord
SIPMIMEInfo	m_mime
unsigned	m_lastCseq
SIP_PDU::StatusCodes	m_lastResponseStatus
int	m_currentExpireTime
int	m_originalExpireTime
int	m_offlineExpireTime
State	m_state
std::queue< State >	m_stateQueue
bool	m_receivedResponse
SIPPoolTimer< SIPHandler >	m_expireTimer
OpalProductInfo	m_productInfo
bool	m_retryForbidden
std::pair< IndexMap::iterator, bool >	m_byAorAndPackage
std::pair< IndexMap::iterator, bool >	m_byAuthIdAndRealm
std::pair< IndexMap::iterator, bool >	m_byAorUserAndRealm
Protected Attributes inherited from SIPTransactionOwner
PSafeObject &	m_object
SIPEndPoint &	m_sipEndpoint
SIPDialogContext	m_dialog
PINDEX	m_dnsEntry
SIPAuthentication *	m_authentication
unsigned	m_authenticateErrors
PSafeArray< SIPTransaction >	m_transactions

Additional Inherited Members
Public Types inherited from SIPHandler
enum	State {   Subscribed, Subscribing, Unavailable, Refreshing,   Restoring, Unsubscribing, Unsubscribed, NumStates }
Protected Types inherited from SIPHandler
typedef std::map< PString, PSafePtr< SIPHandler > >	IndexMap

Constructor & Destructor Documentation

SIPSubscribeHandler::SIPSubscribeHandler	(	SIPEndPoint &	ep,
		const SIPSubscribe::Params &	params
	)

SIPSubscribeHandler::~SIPSubscribeHandler

(

)

Member Function Documentation

virtual SIPTransaction* SIPSubscribeHandler::CreateTransaction ( OpalTransport &  )

virtual

Reimplemented from SIPHandler.

bool SIPSubscribeHandler::DispatchNOTIFY ( SIP_PDU &  request, SIP_PDU &  response  )

protected

virtual SIPEventPackage SIPSubscribeHandler::GetEventPackage ( ) const

inlinevirtual

Reimplemented from SIPHandler.

References SIPSubscribe::Params::m_eventPackage, and m_parameters.

const SIPSubscribe::Params& SIPSubscribeHandler::GetParams ( ) const

inline

References m_parameters.

virtual void SIPSubscribeHandler::OnFailed ( SIP_PDU::StatusCodes  )

virtual

Reimplemented from SIPHandler.

virtual PBoolean SIPSubscribeHandler::OnReceivedNOTIFY ( SIP_PDU &  response )

virtual

Reimplemented from SIPHandler.

virtual void SIPSubscribeHandler::OnReceivedOK ( SIPTransaction &  transaction, SIP_PDU &  response  )

virtual

Reimplemented from SIPHandler.

virtual void SIPSubscribeHandler::SendStatus ( SIP_PDU::StatusCodes  code, State  state  )

protectedvirtual

Reimplemented from SIPHandler.

void SIPSubscribeHandler::UpdateParameters

(

const SIPSubscribe::Params &

params

)

virtual void SIPSubscribeHandler::WriteTransaction ( OpalTransport &  transport, bool &  succeeded  )

protectedvirtual

Field Documentation

SIPEventPackageHandler* SIPSubscribeHandler::m_packageHandler

protected

SIPSubscribe::Params SIPSubscribeHandler::m_parameters

protected

Referenced by GetEventPackage(), and GetParams().

bool SIPSubscribeHandler::m_unconfirmed

protected

---

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

• handlers.h