SIPHandler Class Reference

#include <handlers.h>

Inheritance diagram for SIPHandler:

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 OpalTransport &	GetTransport ()
virtual SIPAuthentication &	GetAuthentication ()
virtual const SIPURL &	GetTargetAddress ()
virtual const PString	GetRemotePartyAddress ()
virtual BOOL	OnReceivedNOTIFY (SIP_PDU &response)
virtual void	SetExpire (int e)
virtual int	GetExpire ()
virtual PString	GetCallID ()
virtual BOOL	CanBeDeleted ()
virtual void	SetAuthUser (const PString &u)
virtual PString	GetAuthUser () const
virtual void	SetPassword (const PString &p)
virtual void	SetAuthRealm (const PString &r)
virtual void	SetBody (const PString &b)
virtual SIPTransaction *	CreateTransaction (OpalTransport &t)=0
virtual SIP_PDU::Methods	GetMethod ()=0
virtual SIPSubscribe::SubscribeType	GetSubscribeType ()
virtual void	OnReceivedOK (SIP_PDU &response)
virtual void	OnTransactionTimeout (SIPTransaction &transaction)
virtual void	OnFailed (SIP_PDU::StatusCodes)
virtual BOOL	SendRequest (SIPHandler::State s=Subscribing)
int	GetAuthenticationAttempts ()
void	SetAuthenticationAttempts (unsigned attempts)
const PStringList &	GetRouteSet () const
Protected Member Functions
	SIPHandler (SIPEndPoint &ep, const PString &to, const PTimeInterval &retryMin=PMaxTimeInterval, const PTimeInterval &retryMax=PMaxTimeInterval)
Protected Attributes
SIPEndPoint &	endpoint
SIPAuthentication	authentication
PSafePtr< SIPTransaction >	transaction
OpalTransport *	transport
SIPURL	targetAddress
PString	callID
int	originalExpire
int	expire
PString	authRealm
PString	authUser
PString	password
PStringList	routeSet
PString	body
unsigned	authenticationAttempts
State	state
PTimer	expireTimer
PTimeInterval	retryTimeoutMin
PTimeInterval	retryTimeoutMax
PString	remotePartyAddress

---

Member Enumeration Documentation

enum SIPHandler::State

Enumerator:

Subscribed
Subscribing
Refreshing
Unsubscribing
Unsubscribed

---

Constructor & Destructor Documentation

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

SIPHandler::~SIPHandler

(

)

---

Member Function Documentation

void SIPHandler::SetState

(

SIPHandler::State

s

)

[inline]

SIPHandler::State SIPHandler::GetState

(

)

[inline]

virtual OpalTransport& SIPHandler::GetTransport

(

)

[inline, virtual]

virtual SIPAuthentication& SIPHandler::GetAuthentication

(

)

[inline, virtual]

virtual const SIPURL& SIPHandler::GetTargetAddress

(

)

[inline, virtual]

virtual const PString SIPHandler::GetRemotePartyAddress

(

)

[virtual]

virtual BOOL 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 BOOL SIPHandler::CanBeDeleted

(

)

[virtual]

virtual void SIPHandler::SetAuthUser

(

const PString &

u

)

[inline, virtual]

virtual PString SIPHandler::GetAuthUser

(

)

const [inline, virtual]

virtual void SIPHandler::SetPassword

(

const PString &

p

)

[inline, virtual]

virtual void SIPHandler::SetAuthRealm

(

const PString &

r

)

[inline, 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::OnReceivedOK

(

SIP_PDU &

response

)

[virtual]

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

virtual void SIPHandler::OnTransactionTimeout

(

SIPTransaction &

transaction

)

[virtual]

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

virtual void SIPHandler::OnFailed

(

SIP_PDU::StatusCodes

)

[virtual]

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

virtual BOOL SIPHandler::SendRequest

(

SIPHandler::State

s = Subscribing

)

[virtual]

int SIPHandler::GetAuthenticationAttempts

(

)

[inline]

void SIPHandler::SetAuthenticationAttempts

(

unsigned

attempts

)

[inline]

const PStringList& SIPHandler::GetRouteSet

(

)

const [inline]

---

Member Data Documentation

SIPEndPoint& SIPHandler::endpoint [protected]

SIPAuthentication SIPHandler::authentication [protected]

PSafePtr<SIPTransaction> SIPHandler::transaction [protected]

OpalTransport* SIPHandler::transport [protected]

SIPURL SIPHandler::targetAddress [protected]

PString SIPHandler::callID [protected]

int SIPHandler::originalExpire [protected]

int SIPHandler::expire [protected]

PString SIPHandler::authRealm [protected]

PString SIPHandler::authUser [protected]

PString SIPHandler::password [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]

---

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

• handlers.h

---