SIPHandler Class Reference

#include <handlers.h>

Inheritance diagram for SIPHandler:
SIPMessageHandler SIPNotifyHandler SIPPingHandler SIPPublishHandler SIPRegisterHandler SIPSubscribeHandler

List of all members.

Public Types

enum  State {
  Subscribed, Subscribing, Unavailable, Refreshing,
  Restoring, Unsubscribing, Unsubscribed
}

Public Member Functions

 ~SIPHandler ()
virtual bool ShutDown ()
void SetState (SIPHandler::State s)
SIPHandler::State GetState ()
virtual OpalTransportGetTransport ()
virtual SIPAuthenticationGetAuthentication ()
virtual const SIPURLGetAddressOfRecord ()
virtual PBoolean OnReceivedNOTIFY (SIP_PDU &response)
virtual void SetExpire (int e)
virtual int GetExpire ()
virtual PString GetCallID ()
virtual void SetBody (const PString &b)
virtual bool IsDuplicateCSeq (unsigned)
virtual SIPTransactionCreateTransaction (OpalTransport &t)=0
virtual SIP_PDU::Methods GetMethod ()=0
virtual SIPSubscribe::EventPackage GetEventPackage () 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 OnReceivedOK (SIPTransaction &transaction, SIP_PDU &response)
virtual void OnTransactionFailed (SIPTransaction &transaction)
virtual void OnFailed (SIP_PDU::StatusCodes)
bool ActivateState (SIPHandler::State state, unsigned msecs=1000)
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

Protected Member Functions

 SIPHandler (SIPEndPoint &ep, const PString &target, const PString &remote, int expireTime=0, int offlineExpire=30, const PTimeInterval &retryMin=PMaxTimeInterval, const PTimeInterval &retryMax=PMaxTimeInterval)
virtual PBoolean SendRequest (SIPHandler::State state)
 PDECLARE_NOTIFIER (PTimer, SIPHandler, OnExpireTimeout)
bool WriteSIPHandler (OpalTransport &transport)

Static Protected Member Functions

static PBoolean WriteSIPHandler (OpalTransport &transport, void *info)

Protected Attributes

SIPEndPointendpoint
SIPAuthenticationauthentication
PString m_username
PString m_password
PString m_realm
PSafeList< SIPTransactiontransactions
OpalTransportm_transport
SIPURL m_addressOfRecord
SIPURL m_remoteAddress
PString callID
int expire
int originalExpire
int offlineExpire
PString body
unsigned authenticationAttempts
State state
PTimer expireTimer
PTimeInterval retryTimeoutMin
PTimeInterval retryTimeoutMax
SIPURL m_proxy
OpalProductInfo m_productInfo

Member Enumeration Documentation

Enumerator:
Subscribed 
Subscribing 
Unavailable 
Refreshing 
Restoring 
Unsubscribing 
Unsubscribed 

Constructor & Destructor Documentation

SIPHandler::SIPHandler ( SIPEndPoint ep,
const PString &  target,
const PString &  remote,
int  expireTime = 0,
int  offlineExpire = 30,
const PTimeInterval &  retryMin = PMaxTimeInterval,
const PTimeInterval &  retryMax = PMaxTimeInterval 
) [protected]
SIPHandler::~SIPHandler (  ) 

Member Function Documentation

bool SIPHandler::ActivateState ( SIPHandler::State  state,
unsigned  msecs = 1000 
)
virtual SIPTransaction* SIPHandler::CreateTransaction ( OpalTransport t  )  [pure virtual]
virtual const SIPURL& SIPHandler::GetAddressOfRecord (  )  [inline, virtual]

References m_addressOfRecord.

virtual SIPAuthentication* SIPHandler::GetAuthentication (  )  [inline, virtual]

References authentication.

virtual PString SIPHandler::GetCallID (  )  [inline, virtual]

References callID.

SIPEndPoint& SIPHandler::GetEndPoint (  )  const [inline]

References endpoint.

virtual SIPSubscribe::EventPackage SIPHandler::GetEventPackage (  )  const [inline, virtual]
virtual int SIPHandler::GetExpire (  )  [inline, virtual]

References expire.

virtual SIP_PDU::Methods SIPHandler::GetMethod (  )  [pure virtual]
const PString& SIPHandler::GetPassword (  )  const [inline]

References m_password.

const OpalProductInfo& SIPHandler::GetProductInfo (  )  const [inline]

References m_productInfo.

const PString& SIPHandler::GetRealm (  )  const [inline]

References m_realm.

const SIPURL& SIPHandler::GetRemoteAddress (  )  const [inline]

References m_remoteAddress.

SIPHandler::State SIPHandler::GetState (  )  [inline]

References state.

virtual OpalTransport* SIPHandler::GetTransport (  )  [virtual]
const PString& SIPHandler::GetUsername (  )  const [inline]

References m_username.

virtual bool SIPHandler::IsDuplicateCSeq ( unsigned   )  [inline, virtual]

Reimplemented in SIPSubscribeHandler, and SIPNotifyHandler.

virtual void SIPHandler::OnFailed ( SIP_PDU::StatusCodes   )  [virtual]
virtual void SIPHandler::OnReceivedAuthenticationRequired ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]
virtual void SIPHandler::OnReceivedIntervalTooBrief ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]
virtual PBoolean SIPHandler::OnReceivedNOTIFY ( SIP_PDU response  )  [virtual]

Reimplemented in SIPSubscribeHandler.

virtual void SIPHandler::OnReceivedOK ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]
virtual void SIPHandler::OnReceivedResponse ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]
virtual void SIPHandler::OnReceivedTemporarilyUnavailable ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]
virtual void SIPHandler::OnTransactionFailed ( SIPTransaction transaction  )  [virtual]
SIPHandler::PDECLARE_NOTIFIER ( PTimer  ,
SIPHandler  ,
OnExpireTimeout   
) [protected]
virtual bool SIPHandler::SendNotify ( const PObject *   )  [inline, virtual]

Reimplemented in SIPNotifyHandler.

virtual PBoolean SIPHandler::SendRequest ( SIPHandler::State  state  )  [protected, virtual]
virtual void SIPHandler::SetBody ( const PString &  b  )  [inline, virtual]

Reimplemented in SIPPublishHandler, and SIPMessageHandler.

References body.

virtual void SIPHandler::SetExpire ( int  e  )  [virtual]
void SIPHandler::SetState ( SIPHandler::State  s  ) 
virtual bool SIPHandler::ShutDown (  )  [virtual]
bool SIPHandler::WriteSIPHandler ( OpalTransport transport  )  [protected]
static PBoolean SIPHandler::WriteSIPHandler ( OpalTransport transport,
void *  info 
) [static, protected]

Member Data Documentation

Referenced by GetAuthentication().

unsigned SIPHandler::authenticationAttempts [protected]
PString SIPHandler::body [protected]

Referenced by SetBody().

PString SIPHandler::callID [protected]

Referenced by GetCallID().

Referenced by GetEndPoint().

int SIPHandler::expire [protected]

Referenced by GetExpire().

PTimer SIPHandler::expireTimer [protected]

Referenced by GetAddressOfRecord().

PString SIPHandler::m_password [protected]

Referenced by GetPassword().

Referenced by GetProductInfo().

PString SIPHandler::m_realm [protected]

Referenced by GetRealm().

Referenced by GetRemoteAddress().

PString SIPHandler::m_username [protected]

Referenced by GetUsername().

int SIPHandler::offlineExpire [protected]
int SIPHandler::originalExpire [protected]
PTimeInterval SIPHandler::retryTimeoutMax [protected]
PTimeInterval SIPHandler::retryTimeoutMin [protected]
State SIPHandler::state [protected]

Referenced by GetState().

PSafeList<SIPTransaction> SIPHandler::transactions [protected]

The documentation for this class was generated from the following file:
Generated on Tue Jun 15 00:29:41 2010 for OPAL by  doxygen 1.6.3