CSIPRefresh Class Reference

#include <mw/siprefresh.h>

Link against: sipclient.lib

class CSIPRefresh : public CBase

Inherits from

CSIPRefresh
- CBase

Public Member Enumerations
enum	TState { EInactive, EActive, ETerminated, EConstructing }

Public Member Functions
	~CSIPRefresh()
void	AddTransaction(CSIPClientTransaction &)
void	ChangeState(CSIPRefresh::TState)
TBool	DoesMatch(TUint32)
IMPORT_C TUint	IntervalL()
IMPORT_C TBool	IsStandAlone()
IMPORT_C CSIPRefresh *	NewL()
IMPORT_C CSIPRefresh *	NewLC()
TUint32	RefreshId()
void	RemoveRefreshOwner(const MSIPRefreshAssociation &)
void	RemoveTransaction()
RStringF	RequestType()
IMPORT_C const CSIPClientTransaction *	SIPTransaction()
IMPORT_C void	SetIntervalL(TUint)
void	SetRefreshIdIfEmpty(TUint32)
void	SetRefreshOwner(MSIPRefreshAssociation &)
void	SetRequestType(RStringF)
IMPORT_C CSIPRefresh::TState	State()
IMPORT_C CSIPClientTransaction *	TerminateL(CSIPMessageElements *)
CSIPClientTransaction *	Transaction()
IMPORT_C CSIPClientTransaction *	UpdateL(CSIPMessageElements *)
void	UpdateRefreshState(TUint)
IMPORT_C TBool	operator==(const CSIPRefresh &)

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()

Detailed Description

Class for managing SIP refresh. It provides functions for getting associated sip transaction and state. Class also provides functions for updating and terminating stand-alone refreshes.

Note that only stand-alone refreshes (i.e. refreshes that are not associated with registration binding or dialog associations) can be terminated or updated using functions defined in this class.

Member Enumeration Documentation

Enum TState

SIP refresh states

Enumerator	Value	Description
EInactive		SIP refresh is inactive
EActive		SIP refresh active
ETerminated		SIP refresh is terminated
EConstructing		Object is being constructed and is not yet ready for use

Constructor & Destructor Documentation

~CSIPRefresh ( )

IMPORT_C

~CSIPRefresh

(

)

Destructor

Member Function Documentation

AddTransaction ( CSIPClientTransaction & )

void

AddTransaction

(

CSIPClientTransaction &

aTransaction

)

ChangeState ( CSIPRefresh::TState )

void

ChangeState

(

CSIPRefresh::TState

aNextState

)

DoesMatch ( TUint32 )

TBool

DoesMatch

(

TUint32

aRefreshId

)

const

IntervalL ( )

IMPORT_C TUint

IntervalL

(

)

const

Gets current refresh interval

Pre-condition: State()==CSIPRefresh::EActive

Return Value: current refresh interval in seconds

Leave Codes
KErrSIPResourceNotAvailable	if SIP server can't be contacted because a required resource has been deleted.

IsStandAlone ( )

IMPORT_C TBool

IsStandAlone

(

)

const

Tests if the refresh is a stand-alone refresh

Return Value: ETrue if refresh is a stand-alone; EFalse otherwise

NewL ( )

IMPORT_C CSIPRefresh *

NewL

(

)

[static]

Two-phased constructor

Return Value: New object. Ownership is transferred.

NewLC ( )

IMPORT_C CSIPRefresh *

NewLC

(

)

[static]

Two-phased constructor

Return Value: New object. Ownership is transferred.

RefreshId ( )

TUint32

RefreshId

(

)

const

RemoveRefreshOwner ( const MSIPRefreshAssociation & )

void

RemoveRefreshOwner

(

const MSIPRefreshAssociation &

aAssoc

)

RemoveTransaction ( )

void

RemoveTransaction

(

)

RequestType ( )

RStringF

RequestType

(

)

const

SIPTransaction ( )

IMPORT_C const CSIPClientTransaction *

SIPTransaction

(

)

const

Gets the associated SIP transaction with this refresh.

Return Value: Associated SIP transaction or 0-pointer. Ownership is not transferred.

SetIntervalL ( TUint )

IMPORT_C void

SetIntervalL

(

TUint

aInterval

)

Sets refresh interval. Note that SIP server choses the refresh interval. This function should be used only if SIP server has indicated new refresh interval using SIP messages that are not associated to the refresh needing the update.

Pre-condition: State()==CSIPRefresh::EActive
aInterval > 0

Parameters
aInterval	a new interval in seconds

Leave Codes
KErrArgument	if aInterval == 0
KErrSIPInvalidTransactionState	if
KErrSIPResourceNotAvailable	if SIP server can't be contacted because a required resource has been deleted.

SetRefreshIdIfEmpty ( TUint32 )

void

SetRefreshIdIfEmpty

(

TUint32

aRefreshId

)

SetRefreshOwner ( MSIPRefreshAssociation & )

void

SetRefreshOwner

(

MSIPRefreshAssociation &

aAssoc

)

Associate the CSIPRefresh with another object.

Parameters
aAssoc	Object associated with the CSIPRefresh

Return Value: ETrue if the objects are equal otherwise EFalse

SetRequestType ( RStringF )

void

SetRequestType

(

RStringF

aType

)

State ( )

IMPORT_C CSIPRefresh::TState

State

(

)

const

Gets the state of the refresh

Return Value: refresh state

TerminateL ( CSIPMessageElements * )

IMPORT_C CSIPClientTransaction *

TerminateL

(

CSIPMessageElements *

aElements = 0

)

Terminates the refresh by sending SIP request to the remote destination. The new client transactation will be of the same type as the first transaction associated with this request.

Pre-condition: State()==EActive
IsStandAlone()==ETrue

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

Return Value: SIP client transaction. Ownership is transferred.

Leave Codes
KErrSIPInvalidTransactionState	if

Capability
NetworkServices

Transaction ( )

CSIPClientTransaction *

Transaction

(

)

UpdateL ( CSIPMessageElements * )

IMPORT_C CSIPClientTransaction *

UpdateL

(

CSIPMessageElements *

aElements = 0

)

Updates the refresh by sending SIP request to the remote destination. The new client transactation will be of the same type as the first transaction associated with this request.

Pre-condition: State()==EActive
IsStandAlone()==ETrue

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

Return Value: SIP client transaction. Ownership is transferred.

Leave Codes
KErrSIPInvalidTransactionState	if

Capability
NetworkServices

UpdateRefreshState ( TUint )

void

UpdateRefreshState

(

TUint

aStatusCode

)

operator== ( const CSIPRefresh & )

IMPORT_C TBool

operator==

(

const CSIPRefresh &

aRefresh

)

const

Compares this object to another object

Parameters
aRefresh	a CSIPRefresh type object to compare

Return Value: ETrue if the objects are equal otherwise EFalse