SIPHandler Class Reference

#include <handlers.h>

Inheritance diagram for SIPHandler:

SIPMessageHandler SIPPingHandler SIPPublishHandler SIPRegisterHandler SIPSubscribeHandler List of all members.

Public Types

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

Public Member Functions

 ~SIPHandler ()
void SetState (SIPHandler::State s)
SIPHandler::State GetState ()
virtual OpalTransportGetTransport ()
virtual const SIPAuthenticationGetAuthentication ()
virtual const SIPURLGetTargetAddress ()
virtual const PString GetRemotePartyAddress ()
virtual PBoolean OnReceivedNOTIFY (SIP_PDU &response)
virtual void SetExpire (int e)
virtual int GetExpire ()
virtual PString GetCallID ()
virtual PBoolean CanBeDeleted ()
virtual void SetBody (const PString &b)
virtual SIPTransactionCreateTransaction (OpalTransport &t)=0
virtual SIP_PDU::Methods GetMethod ()=0
virtual SIPSubscribe::SubscribeType GetSubscribeType ()
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 PBoolean SendRequest (SIPHandler::State state)
const PStringList & GetRouteSet () const

Protected Member Functions

 SIPHandler (SIPEndPoint &ep, const PString &to, int expireTime, const PTimeInterval &retryMin=PMaxTimeInterval, const PTimeInterval &retryMax=PMaxTimeInterval)
void CollapseFork (SIPTransaction &transaction)
 PDECLARE_NOTIFIER (PTimer, SIPHandler, OnExpireTimeout)
bool WriteSIPHandler (OpalTransport &transport)

Static Protected Member Functions

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

Protected Attributes

SIPEndPointendpoint
SIPAuthentication authentication
PSafeList< SIPTransactiontransactions
OpalTransporttransport
SIPURL targetAddress
PString callID
int expire
int originalExpire
PStringList routeSet
PString body
unsigned authenticationAttempts
State state
PTimer expireTimer
PTimeInterval retryTimeoutMin
PTimeInterval retryTimeoutMax
PString remotePartyAddress
SIPURL proxy

Member Enumeration Documentation

enum SIPHandler::State

Enumerator:
Subscribed 
Subscribing 
Refreshing 
Unsubscribing 
Unsubscribed 


Constructor & Destructor Documentation

SIPHandler::SIPHandler ( SIPEndPoint ep,
const PString &  to,
int  expireTime,
const PTimeInterval &  retryMin = PMaxTimeInterval,
const PTimeInterval &  retryMax = PMaxTimeInterval 
) [protected]

SIPHandler::~SIPHandler (  ) 


Member Function Documentation

void SIPHandler::SetState ( SIPHandler::State  s  ) 

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

virtual OpalTransport& SIPHandler::GetTransport (  )  [inline, virtual]

virtual const SIPAuthentication& SIPHandler::GetAuthentication (  )  [inline, virtual]

virtual const SIPURL& SIPHandler::GetTargetAddress (  )  [inline, virtual]

virtual const PString SIPHandler::GetRemotePartyAddress (  )  [virtual]

virtual PBoolean SIPHandler::OnReceivedNOTIFY ( SIP_PDU response  )  [virtual]

Reimplemented in SIPSubscribeHandler.

virtual void SIPHandler::SetExpire ( int  e  )  [virtual]

virtual int SIPHandler::GetExpire (  )  [inline, virtual]

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

virtual PBoolean SIPHandler::CanBeDeleted (  )  [virtual]

virtual void SIPHandler::SetBody ( const PString &  b  )  [inline, virtual]

Reimplemented in SIPPublishHandler.

virtual SIPTransaction* SIPHandler::CreateTransaction ( OpalTransport t  )  [pure virtual]

Implemented in SIPRegisterHandler, SIPSubscribeHandler, SIPPublishHandler, SIPMessageHandler, and SIPPingHandler.

virtual SIP_PDU::Methods SIPHandler::GetMethod (  )  [pure virtual]

Implemented in SIPRegisterHandler, SIPSubscribeHandler, SIPPublishHandler, SIPMessageHandler, and SIPPingHandler.

virtual SIPSubscribe::SubscribeType SIPHandler::GetSubscribeType (  )  [inline, virtual]

Reimplemented in SIPSubscribeHandler.

virtual void SIPHandler::OnReceivedAuthenticationRequired ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]

virtual void SIPHandler::OnReceivedOK ( SIPTransaction transaction,
SIP_PDU response 
) [virtual]

Reimplemented in SIPRegisterHandler, SIPSubscribeHandler, and SIPPublishHandler.

virtual void SIPHandler::OnTransactionFailed ( SIPTransaction transaction  )  [virtual]

virtual void SIPHandler::OnFailed ( SIP_PDU::StatusCodes   )  [virtual]

Reimplemented in SIPRegisterHandler, and SIPMessageHandler.

virtual PBoolean SIPHandler::SendRequest ( SIPHandler::State  state  )  [virtual]

const PStringList& SIPHandler::GetRouteSet (  )  const [inline]

void SIPHandler::CollapseFork ( SIPTransaction transaction  )  [protected]

SIPHandler::PDECLARE_NOTIFIER ( PTimer  ,
SIPHandler  ,
OnExpireTimeout   
) [protected]

static PBoolean SIPHandler::WriteSIPHandler ( OpalTransport transport,
void *  info 
) [static, protected]

bool SIPHandler::WriteSIPHandler ( OpalTransport transport  )  [protected]


Member Data Documentation

SIPEndPoint& SIPHandler::endpoint [protected]

SIPAuthentication SIPHandler::authentication [protected]

PSafeList<SIPTransaction> SIPHandler::transactions [protected]

OpalTransport* SIPHandler::transport [protected]

SIPURL SIPHandler::targetAddress [protected]

PString SIPHandler::callID [protected]

int SIPHandler::expire [protected]

int SIPHandler::originalExpire [protected]

PStringList SIPHandler::routeSet [protected]

PString SIPHandler::body [protected]

unsigned SIPHandler::authenticationAttempts [protected]

State SIPHandler::state [protected]

PTimer SIPHandler::expireTimer [protected]

PTimeInterval SIPHandler::retryTimeoutMin [protected]

PTimeInterval SIPHandler::retryTimeoutMax [protected]

PString SIPHandler::remotePartyAddress [protected]

SIPURL SIPHandler::proxy [protected]


The documentation for this class was generated from the following file:
Generated on Fri Mar 7 07:37:05 2008 for OPAL by  doxygen 1.5.1