CSIPSubscribeDialogAssoc Class Reference

#include <mw/sipsubscribedialogassoc.h>

Link against: sipclient.lib

class CSIPSubscribeDialogAssoc : public CSIPDialogAssocBase

Inherits from

CSIPSubscribeDialogAssoc
- CSIPDialogAssocBase
  - CBase

Public Member Functions
	~CSIPSubscribeDialogAssoc()
void	ConnectionLost()
virtual void	DeletingRefresh(CSIPRefresh &, TUint32)
CSIPClientTransaction *	DoSendSubscribeL(CSIPMessageElements , CSIPRefresh , TBool)
CSIPClientTransaction *	DoSendUnsubscribeL(CSIPMessageElements *)
IMPORT_C const CSIPEventHeader &	Event()
virtual CSIPRefresh *	FindRefresh(TUint32)
IMPORT_C CSIPSubscribeDialogAssoc *	NewL(CSIPDialog &, CSIPEventHeader *)
IMPORT_C CSIPSubscribeDialogAssoc *	NewL(CSIPConnection &, CSIPFromHeader , CUri8 , CSIPEventHeader , CSIPToHeader , CSIPContactHeader *)
IMPORT_C CSIPSubscribeDialogAssoc *	NewL(CSIPConnection &, CUri8 , const MSIPRegistrationContext &, CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader *)
IMPORT_C CSIPSubscribeDialogAssoc *	NewLC(CSIPDialog &, CSIPEventHeader *)
IMPORT_C CSIPSubscribeDialogAssoc *	NewLC(CSIPConnection &, CSIPFromHeader , CUri8 , CSIPEventHeader , CSIPToHeader , CSIPContactHeader *)
IMPORT_C CSIPSubscribeDialogAssoc *	NewLC(CSIPConnection &, CUri8 , const MSIPRegistrationContext &, CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader *)
CSIPSubscribeDialogAssoc *	NewLC(CSIPConnection &, CUri8 , CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader , const MSIPRegistrationContext )
IMPORT_C const CSIPRefresh *	SIPRefresh()
IMPORT_C CSIPClientTransaction *	SendSubscribeL(CSIPMessageElements , CSIPRefresh )
IMPORT_C CSIPClientTransaction *	SendUnsubscribeL(CSIPMessageElements *)
IMPORT_C CSIPClientTransaction *	UpdateL(CSIPMessageElements *)

Inherited Attributes
	CSIPDialogAssocBase::iImplementation

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CSIPDialogAssocBase::CSIPDialogAssocBase()
	CSIPDialogAssocBase::ConstructL(RStringF,CSIPDialog &)
	CSIPDialogAssocBase::ConstructL(RStringF,CSIPDialog &,CSIPServerTransaction &)
	CSIPDialogAssocBase::Dialog()
	CSIPDialogAssocBase::Dialog()const
	CSIPDialogAssocBase::Implementation()
	CSIPDialogAssocBase::IsNonTargetRefreshRequest(RStringF)const
	CSIPDialogAssocBase::SendNonTargetRefreshRequestL(RStringF,CSIPMessageElements *)
	CSIPDialogAssocBase::Type()const
	CSIPDialogAssocBase::~CSIPDialogAssocBase()

Detailed Description

Class for managing SIP SUBSCRIBE dialog associations. It provides services for creating, using and terminating SIP SUBSCRIBE dialog associations. The client can have multiple SUBSRIBE dialog associations per same SIP dialog. Implementation handles SUBSCRIBE on the dialog level defined by Call-Id, local and remote tags; "Event" header semantics are client's responsibility

Constructor & Destructor Documentation

~CSIPSubscribeDialogAssoc ( )

IMPORT_C

~CSIPSubscribeDialogAssoc

(

)

Destructor

Member Function Documentation

ConnectionLost ( )

void

ConnectionLost

(

)

DeletingRefresh ( CSIPRefresh &, TUint32 )

void	DeletingRefresh	(	CSIPRefresh &	aRefresh,
			TUint32	aRefreshId
		)	[virtual]

Reimplemented from CSIPDialogAssocBase::DeletingRefresh(CSIPRefresh &,TUint32)

DoSendSubscribeL ( CSIPMessageElements , CSIPRefresh , TBool )

CSIPClientTransaction *	DoSendSubscribeL	(	CSIPMessageElements *	aElements,
			CSIPRefresh *	aRefresh,
			TBool	aWithinDialog
		)

DoSendUnsubscribeL ( CSIPMessageElements * )

CSIPClientTransaction *

DoSendUnsubscribeL

(

CSIPMessageElements *

aElements

)

Event ( )

IMPORT_C const CSIPEventHeader &

Event

(

)

const

Gets an event to which the subscription is done

Return Value: an event

FindRefresh ( TUint32 )

CSIPRefresh *

FindRefresh

(

TUint32

aRefreshId

)

[virtual]

Reimplemented from CSIPDialogAssocBase::FindRefresh(TUint32)

NewL ( CSIPDialog &, CSIPEventHeader * )

IMPORT_C CSIPSubscribeDialogAssoc *	NewL	(	CSIPDialog &	aDialog,
			CSIPEventHeader *	aEvent
		)	[static]

Two-phased constructor. Should be used if response to the SIP request to be sent will create a SIP dialog association.

Pre-condition: aEvent != 0

Parameters
aDialog	a dialog to be associated with
aEvent	an event to subscribe to; the ownership is transferred

Return Value: New object; the ownership is transferred

Leave Codes
KErrArgument	if aEvent == 0
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

NewL ( CSIPConnection &, CSIPFromHeader , CUri8 , CSIPEventHeader , CSIPToHeader , CSIPContactHeader * )

IMPORT_C CSIPSubscribeDialogAssoc *	NewL	(	CSIPConnection &	aConnection,
			CSIPFromHeader *	aFrom,
			CUri8 *	aRemoteUri,
			CSIPEventHeader *	aEvent,
			CSIPToHeader *	aTo = 0,
			CSIPContactHeader *	aContact = 0
		)	[static]

Two-phased constructor

Pre-condition: aFrom != 0
aRemoteUri != 0 aEvent != 0 The user of the class must not define tags in From-header and To-header.

Parameters
aConnection	a SIP connection to be used with dialog association
aFrom	originator's address; the ownership is transfered
aRemoteUri	a remote target URI that identifies a resource that the request is addressed to.
aEvent	an event to subscribe to; the ownership is transferred
aTo	logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered
aContact	a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered

Return Value: New object; the ownership is transferred.

Leave Codes
KErrArgument	if aFrom == 0, aRemoteUri == 0 or aEvent == 0
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

NewL ( CSIPConnection &, CUri8 , const MSIPRegistrationContext &, CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader * )

IMPORT_C CSIPSubscribeDialogAssoc *	NewL	(	CSIPConnection &	aConnection,
			CUri8 *	aRemoteUri,
			const MSIPRegistrationContext &	aContext,
			CSIPEventHeader *	aEvent,
			CSIPFromHeader *	aFrom = 0,
			CSIPToHeader *	aTo = 0,
			CSIPContactHeader *	aContact = 0
		)	[static]

Two-phased constructor

Pre-condition: aRemoteUri != 0
aEvent != 0 The user of the class must not define tags in From-header and To-header. aContext.IsContextActive()==ETrue

Parameters
aConnection	a SIP connection to be used with dialog association
aRemoteUri	a remote target URI that identifies a resource that the request is targeted to.
aContext	used for selecting outbound proxy and originator's address (AOR) and contact
aEvent	an event to subscribe to; the ownership is transferred
aFrom	originator's address. If not defined it will be constructed using registration context (User's AOR); the ownership is transfered
aTo	logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered
aContact	a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered

Return Value: New object; the ownership is transferred.

Leave Codes
KErrArgument	if aRemoteUri == 0 or aEvent == 0
KErrSIPInvalidRegistrationState	if aContext.IsContextActive()==EFalse
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

NewLC ( CSIPDialog &, CSIPEventHeader * )

IMPORT_C CSIPSubscribeDialogAssoc *	NewLC	(	CSIPDialog &	aDialog,
			CSIPEventHeader *	aEvent
		)	[static]

Two-phased constructor. Must be used if response to the SIP request to be sent will create a SIP dialog association.

Parameters
aDialog	a dialog to be associated with
aEvent	an event to subscribe to; the ownership is transferred

Return Value: New object, ownership is transferred

Leave Codes
KErrArgument	if aEvent == 0
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

NewLC ( CSIPConnection &, CSIPFromHeader , CUri8 , CSIPEventHeader , CSIPToHeader , CSIPContactHeader * )

IMPORT_C CSIPSubscribeDialogAssoc *	NewLC	(	CSIPConnection &	aConnection,
			CSIPFromHeader *	aFrom,
			CUri8 *	aRemoteUri,
			CSIPEventHeader *	aEvent,
			CSIPToHeader *	aTo = 0,
			CSIPContactHeader *	aContact = 0
		)	[static]

Two-phased constructor

Pre-condition: aFrom != 0
aRemoteUri != 0 aEvent != 0 The user of the class must not define tags in From-header and To-header.

Parameters
aConnection	a SIP connection to be used with dialog association
aFrom	originator's address; the ownership is transfered
aRemoteUri	a remote target URI that identifies a resource that the request is addressed to.
aEvent	an event to subscribe to; the ownership is transferred
aTo	logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered
aContact	a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered

Return Value: New object; the ownership is transferred.

Leave Codes
KErrArgument	if aFrom == 0, aRemoteUri == 0 or aEvent == 0
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

NewLC ( CSIPConnection &, CUri8 , const MSIPRegistrationContext &, CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader * )

IMPORT_C CSIPSubscribeDialogAssoc *	NewLC	(	CSIPConnection &	aConnection,
			CUri8 *	aRemoteUri,
			const MSIPRegistrationContext &	aContext,
			CSIPEventHeader *	aEvent,
			CSIPFromHeader *	aFrom = 0,
			CSIPToHeader *	aTo = 0,
			CSIPContactHeader *	aContact = 0
		)	[static]

Two-phased constructor

Pre-condition: aRemoteUri != 0
aEvent != 0 The user of the class must not define tags in From-header and To-header. aContext.IsContextActive()==ETrue

Parameters
aConnection	a SIP connection to be used with dialog association
aRemoteUri	a remote target URI that identifies a resource that the request is targeted to.
aContext	used for selecting outbound proxy and originator's address (AOR) and contact
aEvent	an event to subscribe to; the ownership is transferred
aFrom	originator's address. If not defined it will be constructed using registration context (User's AOR); the ownership is transfered
aTo	logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered
aContact	a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered

Return Value: New object; the ownership is transferred.

Leave Codes
KErrArgument	if aRemoteUri == 0 or aEvent == 0
KErrSIPInvalidRegistrationState	if aContext.IsContextActive()==EFalse
KErrSIPResourceNotAvailable	if a required SIP Client API object has been deleted

NewLC ( CSIPConnection &, CUri8 , CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader , const MSIPRegistrationContext )

CSIPSubscribeDialogAssoc *	NewLC	(	CSIPConnection &	aConnection,
			CUri8 *	aRemoteUri,
			CSIPEventHeader *	aEvent,
			CSIPFromHeader *	aFrom,
			CSIPToHeader *	aTo,
			CSIPContactHeader *	aContact,
			const MSIPRegistrationContext *	aContext
		)	[static]

SIPRefresh ( )

IMPORT_C const CSIPRefresh *

SIPRefresh

(

)

const

Gets associated refresh in case the user has requested the refresh of the SIP subscription. Note that refreshed SUBSCRIBE dialog association cannot be terminated nor updated using the returned object.

Return Value: Associated refresh or 0 pointer if the user has not requested a refresh. Ownership is not transferred.

SendSubscribeL ( CSIPMessageElements , CSIPRefresh )

IMPORT_C CSIPClientTransaction *	SendSubscribeL	(	CSIPMessageElements *	aElements = 0,
			CSIPRefresh *	aRefresh = 0
		)

Creates SUBSCRIBE and sends it to the remote target. 101-199 or 2xx response to SUBSCRIBE will create a dialog association in case of the first SUBSCRIBE request within this dialog. Client must not provide Event-header in the optional message headers.

Pre-condition: Dialog().Connection().State()==EActive
Dialog().State()==CSIPDialog::EInit || Dialog().State()==CSIPDialog::EConfirmed

Parameters
aElements	optional SIP message headers and body. Ownership is transferred.
aRefresh	if set the transaction will be refreshed at given interval. Interval must be defined by including Expires-header. Ownership is transferred.

Return Value: SUBSCRIBE SIP transaction. Ownership is transferred.

Leave Codes
KErrSIPInvalidDialogState	if

Capability
NetworkServices

SendUnsubscribeL ( CSIPMessageElements * )

IMPORT_C CSIPClientTransaction *

SendUnsubscribeL

(

CSIPMessageElements *

aElements = 0

)

Creates (un)SUBSCRIBE and sends it to the remote target. Possible associated refresh will be terminated as well. Client must not provide Event-header in the optional message headers.

Pre-condition: Dialog().Connection().State()==EActive
Dialog().State()==CSIPDialog::EConfirmed

Parameters
aElements	optional SIP message headers and body. Ownership is transferred.

Return Value: SUBSCRIBE SIP transaction. Ownership is transferred.

Leave Codes
KErrSIPInvalidDialogState	if

Capability
NetworkServices

UpdateL ( CSIPMessageElements * )

IMPORT_C CSIPClientTransaction *

UpdateL

(

CSIPMessageElements *

aElements

)

Updates the subscription. Note that update can be done when 2xx response is received to the initial SUBSCRIBE or to update. Client must not provide Event-header in the optional message headers.

Pre-condition: aElements != 0
Dialog().Connection().State()==EActive Dialog().State()==CSIPDialog::EConfirmed

Parameters
aElements	contains user SIP headers and content; the ownership is transferred

Return Value: SUBSCRIBE SIP client transaction; the ownership is transferred

Leave Codes
KErrArgument	if aElements == 0 or aElements contain Event-header
KErrSIPInvalidDialogState	if

Capability
NetworkServices

CSIPSubscribeDialogAssoc Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

~CSIPSubscribeDialogAssoc ( )

Member Function Documentation

ConnectionLost ( )

DeletingRefresh ( CSIPRefresh &, TUint32 )

DoSendSubscribeL ( CSIPMessageElements *, CSIPRefresh *, TBool )

DoSendUnsubscribeL ( CSIPMessageElements * )

Event ( )

FindRefresh ( TUint32 )

NewL ( CSIPDialog &, CSIPEventHeader * )

NewL ( CSIPConnection &, CSIPFromHeader *, CUri8 *, CSIPEventHeader *, CSIPToHeader *, CSIPContactHeader * )

NewL ( CSIPConnection &, CUri8 *, const MSIPRegistrationContext &, CSIPEventHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader * )

NewLC ( CSIPDialog &, CSIPEventHeader * )

NewLC ( CSIPConnection &, CSIPFromHeader *, CUri8 *, CSIPEventHeader *, CSIPToHeader *, CSIPContactHeader * )

NewLC ( CSIPConnection &, CUri8 *, const MSIPRegistrationContext &, CSIPEventHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader * )

NewLC ( CSIPConnection &, CUri8 *, CSIPEventHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader *, const MSIPRegistrationContext * )

SIPRefresh ( )

SendSubscribeL ( CSIPMessageElements *, CSIPRefresh * )

SendUnsubscribeL ( CSIPMessageElements * )

UpdateL ( CSIPMessageElements * )

DoSendSubscribeL ( CSIPMessageElements , CSIPRefresh , TBool )

NewL ( CSIPConnection &, CSIPFromHeader , CUri8 , CSIPEventHeader , CSIPToHeader , CSIPContactHeader * )

NewL ( CSIPConnection &, CUri8 , const MSIPRegistrationContext &, CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader * )

NewLC ( CSIPConnection &, CSIPFromHeader , CUri8 , CSIPEventHeader , CSIPToHeader , CSIPContactHeader * )

NewLC ( CSIPConnection &, CUri8 , const MSIPRegistrationContext &, CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader * )

NewLC ( CSIPConnection &, CUri8 , CSIPEventHeader , CSIPFromHeader , CSIPToHeader , CSIPContactHeader , const MSIPRegistrationContext )

SendSubscribeL ( CSIPMessageElements , CSIPRefresh )