MSIPConnectionObserver Class Reference

#include <mw/sipconnectionobserver.h>

Link against: n/a

class MSIPConnectionObserver

Public Member Functions
pure virtual void	ConnectionStateChanged(CSIPConnection::TState)
pure virtual void	ErrorOccured(TInt, CSIPTransactionBase &)
pure virtual void	ErrorOccured(TInt, CSIPClientTransaction &, CSIPRegistrationBinding &)
pure virtual void	ErrorOccured(TInt, CSIPTransactionBase &, CSIPDialogAssocBase &)
pure virtual void	ErrorOccured(TInt, CSIPRefresh &)
pure virtual void	ErrorOccured(TInt, CSIPRegistrationBinding &)
pure virtual void	ErrorOccured(TInt, CSIPDialogAssocBase &)
pure virtual void	IncomingRequest(CSIPServerTransaction *)
pure virtual void	IncomingRequest(CSIPServerTransaction *, CSIPDialog &)
pure virtual void	IncomingResponse(CSIPClientTransaction &)
pure virtual void	IncomingResponse(CSIPClientTransaction &, CSIPDialogAssocBase &)
pure virtual void	IncomingResponse(CSIPClientTransaction &, CSIPInviteDialogAssoc *)
pure virtual void	IncomingResponse(CSIPClientTransaction &, CSIPRegistrationBinding &)
pure virtual void	InviteCanceled(CSIPServerTransaction &)
pure virtual void	InviteCompleted(CSIPClientTransaction &)

Detailed Description

An interface to be implemented by users of CSIPConnection. Interface allows to be able to receive requests, responses, connection state notifications and error notifications from sip stack.

Note: The client must not delete related CSIPConnection object during the execution of the interface function.

Member Function Documentation

ConnectionStateChanged ( CSIPConnection::TState )

void

ConnectionStateChanged

(

CSIPConnection::TState

aState

)

[pure virtual]

Connection state has changed. If connection state has changed to EInactive or EUnavailable, SIP stack has removed all stand-alone SIP refreshes, registrations and dialog associations that client requested to refresh. Client may re-issue refresh requests (stand-alone, registration or dialog association related) when connection becomes EActive again. SIP stack also terminates all pending SIP client transactions and no errors are reported back to the client about the terminated transactions nor about removed refreshes in order to avoid event flood.

Parameter	Description
aState	indicates the current connection state

ErrorOccured ( TInt, CSIPTransactionBase & )

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

An asynchronous error has occurred in the stack related to the request indicated by the given transaction.

Parameter	Description
aError	system wide or SIP error code
aTransaction	failed transaction

ErrorOccured ( TInt, CSIPClientTransaction &, CSIPRegistrationBinding & )

void	ErrorOccured	(	TInt	aError,
			CSIPClientTransaction &	aTransaction,
			CSIPRegistrationBinding &	aRegistration
		)	[pure virtual]

An asynchronous error has occurred in the stack related to the request indicated by the given transaction.

Parameter	Description
aError	system wide or SIP error code
aTransaction	the failed transaction
aRegistration	the failed registration binding

ErrorOccured ( TInt, CSIPTransactionBase &, CSIPDialogAssocBase & )

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

An asynchronous error has occured related to a request within an existing dialog.

Parameter	Description
aError	system wide or SIP error code
aTransaction	the failed transaction.
aDialogAssoc	the failed dialog associoation.

ErrorOccured ( TInt, CSIPRefresh & )

void	ErrorOccured	(	TInt	aError,
			CSIPRefresh &	aSIPRefresh
		)	[pure virtual]

An asynchronous error has occured related to a refresh

Parameter	Description
aError	system wide or SIP error code
aSIPRefresh	original refresh object.

ErrorOccured ( TInt, CSIPRegistrationBinding & )

void	ErrorOccured	(	TInt	aError,
			CSIPRegistrationBinding &	aRegistration
		)	[pure virtual]

An asynchronous error has occured related to a periodical refresh that relates to a registration.

Parameter	Description
aError	system wide or SIP error code; KErrCouldNotConnect if the refresh has failed due to the suspended connection.
aRegistration	associated registration binding

ErrorOccured ( TInt, CSIPDialogAssocBase & )

void	ErrorOccured	(	TInt	aError,
			CSIPDialogAssocBase &	aDialogAssoc
		)	[pure virtual]

An asynchronous error has occured related to a periodical refresh that belongs to SIP dialog association.

Parameter	Description
aError	system wide or SIP error code; KErrCouldNotConnect if the refresh has failed due to the suspended connection.
aDialogAssoc	SIP dialog association.

IncomingRequest ( CSIPServerTransaction * )

void

IncomingRequest

(

CSIPServerTransaction *

aTransaction

)

[pure virtual]

A SIP request outside a dialog has been received from the network.

Pre-condition: aTransaction != 0

Parameter	Description
aTransaction	SIP server transaction. The ownership is transferred.

IncomingRequest ( CSIPServerTransaction *, CSIPDialog & )

void	IncomingRequest	(	CSIPServerTransaction *	aTransaction,
			CSIPDialog &	aDialog
		)	[pure virtual]

A SIP request within a dialog has been received from the network. The client must resolve the actual dialog association to which this request belongs.

Pre-condition: aTransaction != 0

Parameter	Description
aTransaction	SIP server transaction. The ownership is transferred.
aDialog	the dialog that this transaction belongs to.

IncomingResponse ( CSIPClientTransaction & )

void

IncomingResponse

(

CSIPClientTransaction &

aTransaction

)

[pure virtual]

A SIP response received from the network.

Parameter	Description
aTransaction	contains response elements.

IncomingResponse ( CSIPClientTransaction &, CSIPDialogAssocBase & )

void	IncomingResponse	(	CSIPClientTransaction &	aTransaction,
			CSIPDialogAssocBase &	aDialogAssoc
		)	[pure virtual]

A SIP response received from the network that is within a dialog association or creates a dialog association.

Parameter	Description
aTransaction	contains response elements.
aDialogAssoc	a dialog association.

IncomingResponse ( CSIPClientTransaction &, CSIPInviteDialogAssoc * )

void	IncomingResponse	(	CSIPClientTransaction &	aTransaction,
			CSIPInviteDialogAssoc *	aDialogAssoc
		)	[pure virtual]

Multiple SIP responses have been received to the single INVITE due to the forking proxy. Note that each response creates a separate INVITE dialog association. Multiple responses can arrive until SIP stack completes UAC core INVITE transaction. If clients deletes INVITE transaction after first SIP response other possible responses will be consumed by the implementation.

Parameter	Description
aTransaction	contains response elements
aDialogAssoc	INVITE dialog association; the ownership is transferred

IncomingResponse ( CSIPClientTransaction &, CSIPRegistrationBinding & )

void	IncomingResponse	(	CSIPClientTransaction &	aTransaction,
			CSIPRegistrationBinding &	aRegistration
		)	[pure virtual]

A SIP response related a registration binding or an error response that is related to registration binding has been received from the network.

Parameter	Description
aTransaction	contains response elements
aRegistration	registration binding this transaction belongs to

InviteCanceled ( CSIPServerTransaction & )

void

InviteCanceled

(

CSIPServerTransaction &

aTransaction

)

[pure virtual]

Invite was canceled with the CANCEL

Parameter	Description
aTransaction	a canceled INVITE UAS transaction

InviteCompleted ( CSIPClientTransaction & )

void

InviteCompleted

(

CSIPClientTransaction &

aTransaction

)

[pure virtual]

SIP stack has completed UAC core INVITE transaction 64*T1 seconds after the reception of the first 2xx response. No more 2xx responses can be received to the issued single INVITE.

If the INVITE transaction does not create a dialog, or the INVITE transaction encounters an error, this event will not be sent.

Parameter	Description
aTransaction	a complete UAC core INVITE transaction