OPAL  Version 3.10.4
SIPSubscribeHandler Class Reference

#include <handlers.h>

Inheritance diagram for SIPSubscribeHandler:
SIPHandler

Public Member Functions

 SIPSubscribeHandler (SIPEndPoint &ep, const SIPSubscribe::Params &params)
 ~SIPSubscribeHandler ()
virtual SIPTransactionCreateTransaction (OpalTransport &)
virtual void OnReceivedOK (SIPTransaction &transaction, SIP_PDU &response)
virtual PBoolean OnReceivedNOTIFY (SIP_PDU &response)
virtual void OnFailed (const SIP_PDU &response)
virtual SIPEventPackage GetEventPackage () const
void UpdateParameters (const SIPSubscribe::Params &params)
virtual bool IsDuplicateCSeq (unsigned sequenceNumber)
const SIPSubscribe::ParamsGetParams () const
- Public Member Functions inherited from SIPHandler
 ~SIPHandler ()
virtual Comparison Compare (const PObject &other) const
virtual bool ShutDown ()
void SetState (SIPHandler::State s)
SIPHandler::State GetState ()
virtual OpalTransportGetTransport ()
virtual SIPAuthenticationGetAuthentication ()
virtual const SIPURLGetAddressOfRecord ()
virtual void SetExpire (int e)
virtual int GetExpire ()
virtual const PString & GetCallID () const
virtual void SetBody (const PString &)
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 OnReceivedAuthenticationRequired (SIPTransaction &transaction, SIP_PDU &response)
virtual void OnTransactionFailed (SIPTransaction &transaction)
virtual void OnFailed (SIP_PDU::StatusCodes)
bool ActivateState (SIPHandler::State state)
virtual bool SendNotify (const PObject *)
SIPEndPointGetEndPoint () const
const OpalProductInfoGetProductInfo () const
const PString & GetUsername () const
const PString & GetPassword () const
const PString & GetRealm () const
const SIPURLGetRemoteAddress () const
const SIPURLGetProxy () const

Protected Member Functions

virtual PBoolean SendRequest (SIPHandler::State state)
virtual bool WriteSIPHandler (OpalTransport &transport, bool forked)
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)
void RetryLater (unsigned after)
 PDECLARE_NOTIFIER (PTimer, SIPHandler, OnExpireTimeout)

Protected Attributes

SIPSubscribe::Params m_parameters
SIPDialogContext m_dialog
bool m_unconfirmed
SIPEventPackageHandlerm_packageHandler
SIP_PDUm_previousResponse
- Protected Attributes inherited from SIPHandler
SIPEndPointendpoint
SIPAuthenticationauthentication
PString m_username
PString m_password
PString m_realm
PSafeList< SIPTransactionm_transactions
OpalTransportm_transport
SIP_PDU::Methods m_method
SIPURL m_addressOfRecord
SIPURL m_remoteAddress
PString m_callID
unsigned m_lastCseq
int m_currentExpireTime
int m_originalExpireTime
int m_offlineExpireTime
State m_state
queue< Statem_stateQueue
bool m_receivedResponse
PTimer m_expireTimer
SIPURL m_proxy
OpalProductInfo m_productInfo
std::pair< IndexMap::iterator,
bool > 
m_byCallID
std::pair< IndexMap::iterator,
bool > 
m_byAorAndPackage
std::pair< IndexMap::iterator,
bool > 
m_byAuthIdAndRealm
std::pair< IndexMap::iterator,
bool > 
m_byAorUserAndRealm

Additional Inherited Members

- Public Types inherited from SIPHandler
enum  State {
  Subscribed, Subscribing, Unavailable, Refreshing,
  Restoring, Unsubscribing, Unsubscribed, NumStates
}
- Data Fields inherited from SIPHandler
SIPMIMEInfo m_mime
- Protected Types inherited from SIPHandler
typedef std::map< PString,
PSafePtr< SIPHandler > > 
IndexMap
- Static Protected Member Functions inherited from SIPHandler
static PBoolean WriteSIPHandler (OpalTransport &transport, void *info)

Constructor & Destructor Documentation

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

Member Function Documentation

virtual SIPTransaction* SIPSubscribeHandler::CreateTransaction ( OpalTransport )
virtual

Implements 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 bool SIPSubscribeHandler::IsDuplicateCSeq ( unsigned  sequenceNumber)
inlinevirtual

Reimplemented from SIPHandler.

References SIPDialogContext::IsDuplicateCSeq(), and m_dialog.

virtual void SIPSubscribeHandler::OnFailed ( const SIP_PDU response)
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 PBoolean SIPSubscribeHandler::SendRequest ( SIPHandler::State  state)
protectedvirtual

Reimplemented from SIPHandler.

void SIPSubscribeHandler::SendStatus ( SIP_PDU::StatusCodes  code,
State  state 
)
protected
void SIPSubscribeHandler::UpdateParameters ( const SIPSubscribe::Params params)
virtual bool SIPSubscribeHandler::WriteSIPHandler ( OpalTransport transport,
bool  forked 
)
protectedvirtual

Reimplemented from SIPHandler.

Field Documentation

SIPDialogContext SIPSubscribeHandler::m_dialog
protected

Referenced by IsDuplicateCSeq().

SIPEventPackageHandler* SIPSubscribeHandler::m_packageHandler
protected
SIPSubscribe::Params SIPSubscribeHandler::m_parameters
protected

Referenced by GetEventPackage(), and GetParams().

SIP_PDU* SIPSubscribeHandler::m_previousResponse
protected
bool SIPSubscribeHandler::m_unconfirmed
protected

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