OPAL  Version 3.18.8
SIPNotifyHandler Class Reference

#include <handlers.h>

Inheritance diagram for SIPNotifyHandler:
Collaboration diagram for SIPNotifyHandler:

Public Types

enum  Reasons {
  Deactivated, Probation, Rejected, Timeout,
  GiveUp, NoResource
}
 
- Public Types inherited from SIPHandler
enum  State {
  Subscribed, Subscribing, Unavailable, Refreshing,
  Restoring, Unsubscribing, Unsubscribed, NumStates
}
 

Public Member Functions

 SIPNotifyHandler (SIPEndPoint &ep, const SIPEventPackage &eventPackage, const SIPDialogContext &dialog)
 
 ~SIPNotifyHandler ()
 
virtual SIPTransactionCreateTransaction (OpalTransport &)
 
virtual SIPEventPackage GetEventPackage () const
 
virtual void SetBody (const PString &body)
 
virtual bool SendNotify (const PObject *body)
 
- 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 SIPURLGetAddressOfRecord () const
 
virtual PBoolean OnReceivedNOTIFY (SIP_PDU &response)
 
virtual void SetExpire (int e)
 
virtual int GetExpire () const
 
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 OnReceivedOK (SIPTransaction &transaction, SIP_PDU &response)
 
virtual void OnTransactionFailed (SIPTransaction &transaction)
 
virtual void OnFailed (SIP_PDU::StatusCodes)
 
virtual void SendStatus (SIP_PDU::StatusCodes code, State state)
 
bool ActivateState (SIPHandler::State state, bool resetInterface=false)
 
SIP_PDU::StatusCodes GetLastResponseStatus () const
 
const OpalProductInfoGetProductInfo () 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)
 
SIPEndPointGetEndPoint () const
 
OpalTransportAddress GetRemoteTransportAddress () const
 
const SIPURLGetRequestURI () const
 
const SIPURLGetRemoteURI () const
 
const SIPURLGetProxy () const
 
const PString & GetInterface () const
 
PINDEX GetDNSEntry () const
 
SIPAuthenticationGetAuthenticator () const
 
SIPDialogContextGetDialog ()
 
const SIPDialogContextGetDialog () const
 

Protected Member Functions

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

Protected Attributes

SIPEventPackage m_eventPackage
 
Reasons m_reason
 
SIPEventPackageHandlerm_packageHandler
 
PString m_body
 
- 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< Statem_stateQueue
 
bool m_receivedResponse
 
SIPPoolTimer< SIPHandlerm_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
 
SIPEndPointm_sipEndpoint
 
SIPDialogContext m_dialog
 
PINDEX m_dnsEntry
 
SIPAuthenticationm_authentication
 
unsigned m_authenticateErrors
 
PSafeArray< SIPTransactionm_transactions
 

Additional Inherited Members

- Protected Types inherited from SIPHandler
typedef std::map< PString,
PSafePtr< SIPHandler > > 
IndexMap
 

Member Enumeration Documentation

Enumerator
Deactivated 
Probation 
Rejected 
Timeout 
GiveUp 
NoResource 

Constructor & Destructor Documentation

SIPNotifyHandler::SIPNotifyHandler ( SIPEndPoint ep,
const SIPEventPackage eventPackage,
const SIPDialogContext dialog 
)
SIPNotifyHandler::~SIPNotifyHandler ( )

Member Function Documentation

virtual SIPTransaction* SIPNotifyHandler::CreateTransaction ( OpalTransport )
virtual

Reimplemented from SIPHandler.

virtual SIPEventPackage SIPNotifyHandler::GetEventPackage ( ) const
inlinevirtual

Reimplemented from SIPHandler.

References m_eventPackage.

virtual bool SIPNotifyHandler::SendNotify ( const PObject *  body)
virtual

Reimplemented from SIPHandler.

virtual PBoolean SIPNotifyHandler::SendRequest ( SIPHandler::State  state)
protectedvirtual

Reimplemented from SIPHandler.

virtual void SIPNotifyHandler::SetBody ( const PString &  body)
inlinevirtual

Reimplemented from SIPHandler.

References m_body.

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

Field Documentation

PString SIPNotifyHandler::m_body
protected

Referenced by SetBody().

SIPEventPackage SIPNotifyHandler::m_eventPackage
protected

Referenced by GetEventPackage().

SIPEventPackageHandler* SIPNotifyHandler::m_packageHandler
protected
Reasons SIPNotifyHandler::m_reason
protected

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