#include <sippdu.h>

Inheritance diagram for SIPSubscribe:

Collaboration diagram for SIPSubscribe:

Data Structures
class	EventPackage

struct	NotifyCallbackInfo

struct	Params

struct	SubscriptionStatus

Public Types
enum	PredefinedPackages { MessageSummary, Presence, Dialog, Reg, Conference, NumPredefinedPackages, Watcher = 0x8000, MessageSummaryWatcher = Watcher\|MessageSummary, PresenceWatcher = Watcher\|Presence, DialogWatcher = Watcher\|Dialog, PackageMask = Watcher-1 }

Public Member Functions
	SIPSubscribe (SIPTransactionOwner &owner, OpalTransport &transport, SIPDialogContext &dialog, const Params &params)

virtual SIPTransaction *	CreateDuplicate () const

Public Member Functions inherited from SIPTransaction
	~SIPTransaction ()

bool	Start ()

bool	IsTrying () const

bool	IsProceeding () const

bool	IsInProgress () const

bool	IsFailed () const

bool	IsCompleted () const

bool	IsCanceled () const

bool	IsTerminated () const

void	WaitForCompletion ()

PBoolean	Cancel ()

void	Abort ()

virtual PBoolean	OnReceivedResponse (SIP_PDU &response)

virtual PBoolean	OnCompleted (SIP_PDU &response)

SIPEndPoint &	GetEndPoint () const

SIPConnection *	GetConnection () const

PString	GetInterface () const

Public Member Functions inherited from SIPTransactionBase
	SIPTransactionBase (const PString &transactionID)

Comparison	Compare (const PObject &other) const

Public Member Functions inherited from SIP_PDU
	SIP_PDU (Methods method=SIP_PDU::NumMethods, const OpalTransportPtr &transport=NULL, const PString &transactionID=PString::Empty())

	SIP_PDU (const SIP_PDU &request, StatusCodes code, const SDPSessionDescription *sdp=NULL)

	SIP_PDU (const SIP_PDU &)

SIP_PDU &	operator= (const SIP_PDU &)

	~SIP_PDU ()

void	PrintOn (ostream &strm) const

void	InitialiseHeaders (const SIPURL &dest, const SIPURL &to, const SIPURL &from, const PString &callID, unsigned cseq)

void	InitialiseHeaders (SIPDialogContext &dialog, unsigned cseq=0)

void	InitialiseHeaders (SIPConnection &connection, unsigned cseq=0)

void	InitialiseHeaders (const SIP_PDU &request)

bool	SetRoute (const SIPURLList &routeSet)

bool	SetRoute (const SIPURL &proxy)

void	SetAllow (unsigned bitmask)

StatusCodes	Read ()

StatusCodes	Parse (istream &strm, bool truncated)

virtual bool	Send ()

bool	SendResponse (StatusCodes code)

void	Build (PString &pduStr, PINDEX &pduLen)

const PString &	GetTransactionID () const

Methods	GetMethod () const

StatusCodes	GetStatusCode () const

void	SetStatusCode (StatusCodes c)

const SIPURL &	GetURI () const

void	SetURI (const SIPURL &newuri)

unsigned	GetVersionMajor () const

unsigned	GetVersionMinor () const

void	SetCSeq (unsigned cseq)

const PString &	GetEntityBody () const

void	SetEntityBody (const PString &body)

void	SetEntityBody ()

const PString &	GetInfo () const

void	SetInfo (const PString &info)

const SIPMIMEInfo &	GetMIME () const

SIPMIMEInfo &	GetMIME ()

SDPSessionDescription *	GetSDP ()

void	SetSDP (SDPSessionDescription *sdp)

bool	DecodeSDP (SIPEndPoint &endpoint, const OpalMediaFormatList &masterList)

bool	IsContentSDP (bool emptyOK=false) const

const PString &	GetExternalTransportAddress () const

OpalTransportPtr	GetTransport () const

void	SetTransport (const OpalTransportPtr &transport)

Friends
PredefinedPackages	operator\| (PredefinedPackages p1, PredefinedPackages p2)

Additional Inherited Members
Static Public Member Functions inherited from SIPTransaction
static PString	GenerateCallID ()

Protected Types inherited from SIPTransaction
typedef SIPPoolTimer < SIPTransaction >	PoolTimer

Protected Member Functions inherited from SIPTransaction
	SIPTransaction (Methods method, SIPTransactionOwner owner, OpalTransport transport, bool deleteOwner=false, const PString &transactionID=PString::Empty())

bool	ResendCANCEL ()

void	SetParameters (const SIPParameters &params)

void	OnRetry ()

void	OnTimeout ()

	P_DECLARE_TRACED_ENUM (States, NotStarted, Trying, Proceeding, Cancelling, Completed, Terminated_Success, Terminated_Timeout, Terminated_RetriesExceeded, Terminated_TransportError, Terminated_Cancelled, Terminated_Aborted)

virtual void	SetTerminated (States newState)

Protected Attributes inherited from SIPTransaction
SIPTransactionOwner *	m_owner

bool	m_deleteOwner

PTimeInterval	m_retryTimeoutMin

PTimeInterval	m_retryTimeoutMax

States	m_state

unsigned	m_retry

PoolTimer	m_retryTimer

PoolTimer	m_completionTimer

PSyncPoint	m_completed

bool	m_pduSizeOK

PString	m_localInterface

Member Enumeration Documentation

enum SIPSubscribe::PredefinedPackages

Valid types for an event package

Enumerator
MessageSummary
Presence
Dialog
Reg
Conference
NumPredefinedPackages
Watcher
MessageSummaryWatcher
PresenceWatcher
DialogWatcher
PackageMask

Constructor & Destructor Documentation

SIPSubscribe::SIPSubscribe	(	SIPTransactionOwner &	owner,
		OpalTransport &	transport,
		SIPDialogContext &	dialog,
		const Params &	params
	)

Member Function Documentation

virtual SIPTransaction* SIPSubscribe::CreateDuplicate ( ) const

virtual

Implements SIPTransaction.

Friends And Related Function Documentation

PredefinedPackages operator\|	(	PredefinedPackages	p1,
		PredefinedPackages	p2
	)

friend

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

sippdu.h

Data Structures

Public Types

Public Member Functions

Friends

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation