CMceCsSubSession Class Reference

aTransaction

)

[virtual]

Returns ETrue, if session accepts transaction

Parameters

CSIPServerTransaction & aTransaction

new (incoming) transaction

AcceptMethod(RStringF)

TBool

AcceptMethod

(

RStringF

aMethod

)

[pure virtual]

Checks if session accepts method of incoming request

Parameters

RStringF aMethod

the method

AcceptStandAloneTransaction(CSIPServerTransaction &)

TBool

AcceptStandAloneTransaction

(

aTransaction

)

[virtual]

Returns ETrue, if session accepts stand-alone transaction

Parameters

CSIPServerTransaction & aTransaction

new (incoming) stand-alone transaction

AutoEvent()

TBool

AutoEvent

(

)

Checks whether the session should automatically generate an event at next state change.

CanDispose()

TBool

CanDispose

(

)

[pure virtual]

Returns ETrue, if session can be deleted

CancelClientReceiveL()

void

CancelClientReceiveL

(

)

[private]

Canceled()

void

Canceled

(

)

[pure virtual]

Handles situation where incoming INVITE was canceled with the CANCEL

Client()

CMceCsSessionImplementation &

Client

(

)

const

Returns client

ClientExists()

TBool

ClientExists

(

)

Returns ETrue, if client has called ready to receive

ClientReadyToReceiveL(const RMessage2 &)

void

ClientReadyToReceiveL

(

const RMessage2 &

aMessage

)

[private]

Parameters

const RMessage2 & aMessage

ClientType()

TMceCsSessionType

ClientType

(

)

const

Returns client type of session. The type represents type of dialog used in session.

ConnectionStateChanged(CSIPConnection::TState)

void

ConnectionStateChanged

(

CSIPConnection::TState

aState

)

Handles situation where SIP connection state has changed. If connection state has changed to EInactive or EUnavailable, SIP stack terminates all pending SIP client transactions and no errors are reported back to the client about the terminated transactions.

Parameters

CSIPConnection::TState aState

indicates the current connection state

ConstructL(CMceCsSession &)

void

ConstructL

(

CMceCsSession &

aClientSession

)

[protected]

Parameters

CMceCsSession & aClientSession

Consumes(CSIPDialog &, CSIPServerTransaction &, TBool &)

TBool	Consumes	(	CSIPDialog &	aDialog,
			CSIPServerTransaction &	aTransaction,
			TBool &	aAssociatesWithDialog
		)	[virtual]

Returns ETrue, if session will consume the transaction

Parameters

CSIPDialog & aDialog	SIP dialog
CSIPServerTransaction & aTransaction	the pending transaction
TBool & aAssociatesWithDialog

Consumes(CSIPTransactionBase &)

TBool

Consumes

(

CSIPTransactionBase &

aTransaction

)

[virtual]

Returns ETrue, if session will consume the transaction

Parameters

CSIPTransactionBase & aTransaction

pending or new (incoming) transaction

CreateIncomingDialogL(CSIPServerTransaction &)

CreateIncomingDialogL

(

aInitialRequest

)

[pure virtual]

Creates new incoming dialog (association)

Parameters

CSIPServerTransaction & aInitialRequest

request causing creation

CreateOutgoingDialogL(TMceDialogType, CDesC8Array &, CSIPDialog &)

CSIPDialogAssocBase *	CreateOutgoingDialogL	(	TMceDialogType	aDialogType,
			CDesC8Array &	aParams,
			CSIPDialog &	aExistingDialog
		)	[pure virtual]

Creates new outgoing dialog (association) from existing dialog

Parameters

TMceDialogType aDialogType	type of new dialog
CDesC8Array & aParams	parameters for creation
CSIPDialog & aExistingDialog	existing dialog

CreateOutgoingDialogL(TMceDialogType, CDesC8Array &)

CSIPDialogAssocBase *	CreateOutgoingDialogL	(	TMceDialogType	aDialogType,
			CDesC8Array &	aParams
		)	[pure virtual]

Creates outgoing dialog (association) based on given parameters

Parameters

TMceDialogType aDialogType	type of new dialog
CDesC8Array & aParams	parameters for creation

DefaultHeaders(TInt)

CDesC8Array &

DefaultHeaders

(

TInt

aMethodInd

)

Returns the default headers

Parameters

TInt aMethodInd

the methond index in SIP strings

Dialog()

Dialog

(

)

const [virtual]

Returns SIP dialog (assoc)

DialogId()

TUint32

DialogId

(

)

const

Returns dialog id

DialogRequestReceived(CSIPServerTransaction *, CSIPDialog &)

TBool	DialogRequestReceived	(	CSIPServerTransaction *	aTransaction,
			CSIPDialog &	aDialog
		)

Handles SIP request, which has been received inside a dialog

Parameters

CSIPServerTransaction * aTransaction	server transaction representing a request
CSIPDialog & aDialog	dialog to wich transaction belongs

DialogResponseReceived(CSIPClientTransaction &)

void

DialogResponseReceived

(

aTransaction

)

Handles SIP response, which has been received inside a dialog

Parameters

CSIPClientTransaction & aTransaction

client transaction representing a response

DoConnectionStateChanged(TBool)

void

DoConnectionStateChanged

(

TBool

aIsActive

)

[pure virtual]

Parameters

TBool aIsActive

indicates if the current connection is active

DoErrorOccured(TInt, CSIPTransactionBase &)

void	DoErrorOccured	(	TInt	aError,
			CSIPTransactionBase &	aTransaction
		)	[pure virtual]

Handles situation where an asynchronous error has occured related to a request within an existing dialog.

Parameters

TInt aError	error code
CSIPTransactionBase & aTransaction	the transaction

DoInitializeIncomingDialogL(CSIPServerTransaction &)

void

DoInitializeIncomingDialogL

(

aTransaction

)

[pure virtual]

Initializes incoming dialog

Parameters

CSIPServerTransaction & aTransaction

server transaction representing a request, which caused dialog creation

DoServiceL(TMceIds &, TMceItcFunctions)

HBufC8 *	DoServiceL	(	TMceIds &	aIds,
			TMceItcFunctions	aFunction
		)	[virtual]

Executes ITC function called by client. Default implementation leaves with KErrNotSupported

Parameters

TMceIds & aIds	set of ids defining ITC call context
TMceItcFunctions aFunction	ITC function to be executed

DoServiceL(TMceIds &, TMceItcFunctions, const TDesC8 &)

void	DoServiceL	(	TMceIds &	aIds,
			TMceItcFunctions	aFunction,
			const TDesC8 &	aMessage
		)	[virtual]

Executes ITC function called by client. Default implementation leaves with KErrNotSupported

Parameters

TMceIds & aIds	set of ids defining ITC call context
TMceItcFunctions aFunction	ITC function to be executed
const TDesC8 & aMessage	message context from client

DoServiceL(TMceIds &, TMceItcFunctions, TPtr8 &)

void	DoServiceL	(	TMceIds &	aIds,
			TMceItcFunctions	aFunction,
			TPtr8 &	aMessage
		)	[virtual]

Executes ITC function called by client. Default implementation leaves with KErrNotSupported

Parameters

TMceIds & aIds	set of ids defining ITC call context
TMceItcFunctions aFunction	ITC function to be executed
TPtr8 & aMessage	message context from client

DoServiceL(TMceIds &, TMceItcFunctions, CMceMsgBase &)

void	DoServiceL	(	TMceIds &	aIds,
			TMceItcFunctions	aFunction,
			CMceMsgBase &	aMessage
		)	[virtual]

Executes ITC function called by client. Default implementation leaves with KErrNotSupported

Parameters

TMceIds & aIds	set of ids defining ITC call context
TMceItcFunctions aFunction	ITC function to be executed
CMceMsgBase & aMessage	decoded message context from client

DoServiceL(TMceIds &, TMceItcFunctions, const RMessage2 &)

void	DoServiceL	(	TMceIds &	aIds,
			TMceItcFunctions	aFunction,
			const RMessage2 &	aMessage
		)	[private]

Parameters

TMceIds & aIds
TMceItcFunctions aFunction
const RMessage2 & aMessage

ErrorOccured(TInt, CSIPTransactionBase &)

void	ErrorOccured	(	TInt	aError,
			CSIPTransactionBase &	aTransaction
		)	[virtual]

Handles situation where an asynchronous error has occured related to a request within an existing dialog.

Parameters

TInt aError	error code
CSIPTransactionBase & aTransaction	the transaction

ErrorOccured(TInt)

void

ErrorOccured

(

TInt

aError

)

[pure virtual]

Called when error has been occured within dialog

Parameters

TInt aError

error code

ErrorResponseReceived()

void

ErrorResponseReceived

(

)

[pure virtual]

Called when error response (4XX-7XX) has been received to pending transaction. Response can be obtained by calling Response() method

FCSession()

const CFCSession *

FCSession

(

)

const

Returns floor control session instance

HasInitialInviteTransactionBeenCompleted()

TBool

HasInitialInviteTransactionBeenCompleted

(

)

const [protected]

InitialRequest()

InitialRequest

(

)

const

Returns initial request which caused session creation.

InitializeIncomingDialogL(CSIPServerTransaction *)

void

InitializeIncomingDialogL

(

aTransaction

)

Initializes incoming dialog

Parameters

CSIPServerTransaction * aTransaction

server transaction representing a request, which caused dialog creation

InviteCompleted(CSIPClientTransaction &)

void

InviteCompleted

(

aTransaction

)

[virtual]

Parameters

CSIPClientTransaction & aTransaction

IsOrphan()

TBool

IsOrphan

(

)

[protected]

IsProfileContactSecureL()

TBool

IsProfileContactSecureL

(

)

Check Profile contact secure status

Manager()

CMceSipManager &

Manager

(

)

const

Returns SIP manager instance

MessageRequestReceived(CSIPServerTransaction *)

TBool

MessageRequestReceived

(

aTransaction

)

Handles SIP request, which has been received outside a dialog

Parameters

CSIPServerTransaction * aTransaction

server transaction representing a request

MessageResponseReceived(CSIPClientTransaction &)

void

MessageResponseReceived

(

aTransaction

)

Handles SIP response, which has been received outside a dialog

Parameters

CSIPClientTransaction & aTransaction

client transaction representing a response

NextHopL(TInetAddr &)

TInetAddr *

NextHopL

(

TInetAddr &

aNextHop

)

Return NextHop

Parameters

TInetAddr & aNextHop

PendingReceivedRequests()

const RPointerArray< CSIPServerTransaction > &

PendingReceivedRequests

(

)

PendingTransaction(RStringF)

PendingTransaction

(

RStringF

aType

)

Returns pending transaction based on type

Parameters

RStringF aType

type of transaction

PendingTransactions()

const RPointerArray< CSIPClientTransaction > &

PendingTransactions

(

)

Returns all pending transactions

PopClientContent()

HBufC8 *

PopClientContent

(

)

Transferes ownership of client message content

PopRequest()

PopRequest

(

)

Transferes ownership of current (pending) request

PopResponse()

PopResponse

(

)

Transferes ownership of current (pending) response

Profile()

CSIPProfile &

Profile

(

)

const

Return profile

ProfileConfigured()

TBool

ProfileConfigured

(

)

const

Checks if profile configured.

ProvisionalResponseReceived()

void

ProvisionalResponseReceived

(

)

[pure virtual]

Called when response (1XX) has been received to pending transaction. Response can be obtained by calling Response() method

ReceiveL(const RMessage2 &)

void

ReceiveL

(

const RMessage2 &

aMessage

)

[private]

Parameters

const RMessage2 & aMessage

RedirectionResponseReceived()

void

RedirectionResponseReceived

(

)

[pure virtual]

Called when response (3XX) has been received to pending transaction. Response can be obtained by calling Response() method

RegisterDialogAssoc(CSIPDialogAssocBase &)

void

RegisterDialogAssoc

(

CSIPDialogAssocBase &

aDialogAssoc

)

[private]

Parameters

CSIPDialogAssocBase & aDialogAssoc

RemoveCompletedRequests(TBool)

void

RemoveCompletedRequests

(

TBool

aAll = EFalse

)

Parameters

TBool aAll = EFalse

RemovePendingCompletedTrx(CSIPClientTransaction &)

TBool

RemovePendingCompletedTrx

(

aTransaction

)

[private]

Parameters

CSIPClientTransaction & aTransaction

RemovePendingTrx(CSIPClientTransaction &)

TBool

RemovePendingTrx

(

aTransaction

)

Removes the pending transaction.

Parameters

CSIPClientTransaction & aTransaction

the transaction to be removed

Request()

Request

(

)

const

Returns current (pending) request

RequestReceived(TBool, CSIPDialog &)

void	RequestReceived	(	TBool	aInsideDialog,
			CSIPDialog &	aDialog
		)	[pure virtual]

Called when request has been received. Request can be obtained by calling Request() method

Parameters

TBool aInsideDialog	tells whether request was received inside dialog
CSIPDialog & aDialog

ResetInitialInvite()

void

ResetInitialInvite

(

)

Resets the initial INVITE.

Response()

CMceCsSessionImplementation &

Response

(

)

const

Returns current (pending) response

ResponseReceived()

void

ResponseReceived

(

)

[pure virtual]

Called when response (2XX) has been received to pending transaction. Response can be obtained by calling Response() method

ResponseReceivedWithinDialog(CSIPClientTransaction &, CSIPDialogAssocBase &)

void	ResponseReceivedWithinDialog	(	CSIPClientTransaction &	aTransaction,
			CSIPDialogAssocBase &	aDialogAssoc
		)

Handles SIP request, which has been received inside a dialog. this will call DialogResponseReceived

Parameters

CSIPClientTransaction & aTransaction	server transaction representing a request
CSIPDialogAssocBase & aDialogAssoc	the dialog

SIPConnection()

CMceSipConnection &

SIPConnection

(

)

const

Returns SIP connection instance

SendErrorToClient(TMceIds &, TInt)

TInt	SendErrorToClient	(	TMceIds &	aIds,
			TInt	aError
		)

Sends error via callback mechanism to client session

Parameters

TMceIds & aIds	set of ids defining ITC callback context
TInt aError	the error

SendToClient(TMceIds &)

TInt

SendToClient

(

TMceIds &

aIds

)

Sends data via callback mechanism to client session

Parameters

TMceIds & aIds

set of ids defining ITC callback context

SendToClientL(TMceIds &, HBufC8 , HBufC8 )

void	SendToClientL	(	TMceIds &	aIds,
			HBufC8 *	aContext,
			HBufC8 *	aContent
		)

Sends data via callback mechanism to client session

Parameters

TMceIds & aIds	set of ids defining ITC callback context
HBufC8 * aContext	encoded context of message
HBufC8 * aContent	content of message

ServerCore()

CMceServerCore &

ServerCore

(

)

const

Returns server core instance

ServiceL(TMceIds &, TMceItcFunctions, const RMessage2 &)

void	ServiceL	(	TMceIds &	aIds,
			TMceItcFunctions	aFunction,
			const RMessage2 &	aMessage
		)

Executes ITC function called by client

Parameters

TMceIds & aIds	set of ids defining ITC call context
TMceItcFunctions aFunction	ITC function to be executed
const RMessage2 & aMessage	message from the client.

SetAutoEvent(TBool)

void

SetAutoEvent

(

TBool

aIsEnabled

)

Controls whether the session should generate automatically event at next state change.

Parameters

TBool aIsEnabled

SetClient(CMceCsSessionImplementation &)

void

SetClient

(

aClient

)

[private]

Parameters

CMceCsSessionImplementation & aClient

SetDialog(TType, CSIPDialogAssocBase *, TUint32)

void	SetDialog	(	TType	aType,
			CSIPDialogAssocBase *	aDialog,
			TUint32	aDialogId
		)

Stores SIP dialog

Parameters

TType aType	the type of session
CSIPDialogAssocBase * aDialog	SIP dialog
TUint32 aDialogId	generated dialog id

SetPendingTransactionL(CSIPClientTransaction *)

void

SetPendingTransactionL

(

aTransaction

)

Sets client transaction which is waiting response from peer

Parameters

CSIPClientTransaction * aTransaction

the pending transaction

SetProfile(CSIPProfile &)

void

SetProfile

(

CSIPProfile &

aProfile

)

Set profile

Parameters

CSIPProfile & aProfile

Profile to be used

SetResponse(CSIPClientTransaction &)

void

SetResponse

(

CMceCsSubSessionReceiver *

aTransaction

)

[private]

Parameters

CSIPClientTransaction & aTransaction

SetSessionReceiver(CMceCsSubSessionReceiver *)

void

SetSessionReceiver

(

aSessionReceiver

)

[private]

Parameters

CMceCsSubSessionReceiver * aSessionReceiver

StandAloneRequestReceived()

void

StandAloneRequestReceived

(

)

[pure virtual]

Called when stand-alone request has been received. Request can be obtained by calling Request() method

StandAloneResponseReceived(TMceSipResponseType)

void

StandAloneResponseReceived

(

TMceSipResponseType

aResponseType

)

[pure virtual]

Called when stand-alone response (any) has been received to pending transaction. Response can be obtained by calling Response() method

Parameters

TMceSipResponseType aResponseType

response type

StoreAutoEventL(TMceStateTransitionEvent , CSIPServerTransaction )

void	StoreAutoEventL	(	TMceStateTransitionEvent *	aEvent,
			CSIPServerTransaction *	aAssociatedRequest
		)

Stores event which will be used when automatic event generation occurs. Request which is associated with the event may be defined.

Parameters

TMceStateTransitionEvent * aEvent
CSIPServerTransaction * aAssociatedRequest

StoreClientContent(HBufC8 *)

void

StoreClientContent

(

HBufC8 *

aClientContent

)

Stores client's message content

Parameters

HBufC8 * aClientContent

the message content

StoredAutoEvent()

TMceStateTransitionEvent *

StoredAutoEvent

(

)

Returns stored automatic event.

Terminate()

TBool

Terminate

(

)

[pure virtual]

Handles situation where session must be forcefully terminated

Type()

TType

Type

(

)

const

Returns type of session

Member Enumerations Documentation

Enum TType

Enumerators

EUnknown = -1
EInSession
EOutSession
EOutSIPSession

Member Data Documentation

TMceStateTransitionEvent * iAutoEvent

TMceStateTransitionEvent *

iAutoEvent

[protected]

CSIPServerTransaction * iAutoEventAssociatedRequest

iAutoEventAssociatedRequest

[protected]

TBool iAutoEventEnabled

TBool

iAutoEventEnabled

[protected]

TMceIds * iAutoEventIds

TMceIds *

iAutoEventIds

[protected]

CMceMsgBase * iAutoEventMsg

CMceMsgBase *

iAutoEventMsg

[protected]

HBufC8 * iClientContent

HBufC8 *

iClientContent

[private]

TBool iClientExists

TBool

iClientExists

[private]

CMceCsSessionImplementation * iClientSession

CMceCsSessionImplementation *

iClientSession

[private]

TMceCsSessionType iClientType

TMceCsSessionType

iClientType

[private]

CSIPDialogAssocBase * iCurrentDialog

iCurrentDialog

[protected]

TMceStateTransitionEvent * iCurrentlyProcessedAutoEvent

TMceStateTransitionEvent *

iCurrentlyProcessedAutoEvent

[protected]

CSIPDialogAssocBase * iDialog

iDialog

[protected]

TUint32 iDialogId

TUint32

iDialogId

[private]

CFCSession * iFCSession

CFCSession *

iFCSession

[protected]

CSIPClientTransaction * iInitialInvite

iInitialInvite

[private]

RPointerArray< CSIPServerTransaction > iPendingReceivedRequests

RPointerArray< CSIPServerTransaction >

iPendingReceivedRequests

[protected]

RPointerArray< CSIPClientTransaction > iPendingTransactions

RPointerArray< CSIPClientTransaction >

iPendingTransactions

[protected]

CSIPProfile * iProfile

CSIPProfile *

iProfile

[private]

CMceCsSubSessionReceiver * iReceiver

CMceCsSubSessionReceiver *

iReceiver

[private]

CSIPClientTransaction * iResponse