SIPTransaction Class Reference

#include <sippdu.h>

Inheritance diagram for SIPTransaction:

List of all members.

Public Member Functions
	SIPTransaction (SIPEndPoint &endpoint, OpalTransport &transport, const PTimeInterval &minRetryTime=PMaxTimeInterval, const PTimeInterval &maxRetryTime=PMaxTimeInterval)
	SIPTransaction (SIPConnection &connection, OpalTransport &transport, Methods method=NumMethods)
	~SIPTransaction ()
BOOL	Start ()
BOOL	IsInProgress () const
BOOL	IsFailed () const
BOOL	IsCompleted () const
BOOL	IsCanceled () const
BOOL	IsTerminated () const
void	WaitForCompletion ()
BOOL	Cancel ()
void	Abort ()
virtual BOOL	OnReceivedResponse (SIP_PDU &response)
virtual BOOL	OnCompleted (SIP_PDU &response)
OpalTransport &	GetTransport () const
SIPConnection *	GetConnection () const
const OpalTransportAddress &	GetLocalAddress () const
Protected Types
enum	States {   NotStarted, Trying, Aborting, Proceeding,   Cancelling, Completed, Terminated_Success, Terminated_Timeout,   Terminated_RetriesExceeded, Terminated_TransportError, Terminated_Cancelled, Terminated_Aborted,   NumStates }
Protected Member Functions
void	Construct (const PTimeInterval &minRetryTime=PMaxTimeInterval, const PTimeInterval &maxRetryTime=PMaxTimeInterval)
BOOL	ResendCANCEL ()
	PDECLARE_NOTIFIER (PTimer, SIPTransaction, OnRetry)
	PDECLARE_NOTIFIER (PTimer, SIPTransaction, OnTimeout)
virtual void	SetTerminated (States newState)
Protected Attributes
SIPEndPoint &	endpoint
OpalTransport &	transport
PSafePtr< SIPConnection >	connection
States	state
unsigned	retry
PTimer	retryTimer
PTimer	completionTimer
PSyncPoint	completed
PTimeInterval	retryTimeoutMin
PTimeInterval	retryTimeoutMax
OpalTransportAddress	localAddress

---

Detailed Description

Session Initiation Protocol transaction. A transaction is a stateful independent entity that provides services to a connection (Transaction User). Transactions are contained within connections. A client transaction handles sending a request and receiving its responses. A server transaction handles sending responses to a received request. In either case the SIP_PDU ancestor is the sent or received request.

---

Member Enumeration Documentation

enum SIPTransaction::States [protected]

Enumerator:

NotStarted
Trying
Aborting
Proceeding
Cancelling
Completed
Terminated_Success
Terminated_Timeout
Terminated_RetriesExceeded
Terminated_TransportError
Terminated_Cancelled
Terminated_Aborted
NumStates

---

Constructor & Destructor Documentation

SIPTransaction::SIPTransaction	(	SIPEndPoint &	endpoint,
		OpalTransport &	transport,
		const PTimeInterval &	minRetryTime = PMaxTimeInterval,
		const PTimeInterval &	maxRetryTime = PMaxTimeInterval
	)

SIPTransaction::SIPTransaction	(	SIPConnection &	connection,
		OpalTransport &	transport,
		Methods	method = NumMethods
	)

Construct a transaction for requests in a dialog. The transport is used to determine the local address

SIPTransaction::~SIPTransaction

(

)

---

Member Function Documentation

BOOL SIPTransaction::Start

(

)

BOOL SIPTransaction::IsInProgress

(

)

const [inline]

BOOL SIPTransaction::IsFailed

(

)

const [inline]

BOOL SIPTransaction::IsCompleted

(

)

const [inline]

BOOL SIPTransaction::IsCanceled

(

)

const [inline]

BOOL SIPTransaction::IsTerminated

(

)

const [inline]

void SIPTransaction::WaitForCompletion

(

)

BOOL SIPTransaction::Cancel

(

)

void SIPTransaction::Abort

(

)

virtual BOOL SIPTransaction::OnReceivedResponse

(

SIP_PDU &

response

)

[virtual]

Reimplemented in SIPInvite.

virtual BOOL SIPTransaction::OnCompleted

(

SIP_PDU &

response

)

[virtual]

OpalTransport& SIPTransaction::GetTransport

(

)

const [inline]

SIPConnection* SIPTransaction::GetConnection

(

)

const [inline]

const OpalTransportAddress& SIPTransaction::GetLocalAddress

(

)

const [inline]

void SIPTransaction::Construct	(	const PTimeInterval &	minRetryTime = PMaxTimeInterval,
		const PTimeInterval &	maxRetryTime = PMaxTimeInterval
	)			[protected]

BOOL SIPTransaction::ResendCANCEL

(

)

[protected]

SIPTransaction::PDECLARE_NOTIFIER	(	PTimer	,
		SIPTransaction	,
		OnRetry
	)			[protected]

SIPTransaction::PDECLARE_NOTIFIER	(	PTimer	,
		SIPTransaction	,
		OnTimeout
	)			[protected]

virtual void SIPTransaction::SetTerminated

(

States

newState

)

[protected, virtual]

---

Member Data Documentation

SIPEndPoint& SIPTransaction::endpoint [protected]

OpalTransport& SIPTransaction::transport [protected]

PSafePtr<SIPConnection> SIPTransaction::connection [protected]

States SIPTransaction::state [protected]

unsigned SIPTransaction::retry [protected]

PTimer SIPTransaction::retryTimer [protected]

PTimer SIPTransaction::completionTimer [protected]

PSyncPoint SIPTransaction::completed [protected]

PTimeInterval SIPTransaction::retryTimeoutMin [protected]

PTimeInterval SIPTransaction::retryTimeoutMax [protected]

OpalTransportAddress SIPTransaction::localAddress [protected]

---

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

• sippdu.h

---