Class MSIPConnectionObserver

class MSIPConnectionObserver;

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.

n/a

Members

Defined in MSIPConnectionObserver:
ConnectionStateChanged(), ErrorOccured(), ErrorOccured(), ErrorOccured(), ErrorOccured(), ErrorOccured(), ErrorOccured(), IncomingRequest(), IncomingRequest(), IncomingResponse(), IncomingResponse(), IncomingResponse(), IncomingResponse(), InviteCanceled(), InviteCompleted()

virtual void IncomingRequest(CSIPServerTransaction *aTransaction)=0;

Pre-Condition

aTransaction != 0

Description

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

Parameters

CSIPServerTransaction *aTransaction SIP server transaction. The ownership is transferred.

virtual void IncomingRequest(CSIPServerTransaction *aTransaction, CSIPDialog &aDialog)=0;

Pre-Condition

aTransaction != 0

Description

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.

Parameters

CSIPServerTransaction *aTransaction SIP server transaction. The ownership is transferred. CSIPDialog &aDialog the dialog that this transaction belongs to.

virtual void IncomingResponse(CSIPClientTransaction &aTransaction)=0;

Description

A SIP response received from the network.

Parameters

CSIPClientTransaction &aTransaction contains response elements.

virtual void IncomingResponse(CSIPClientTransaction &aTransaction, CSIPDialogAssocBase &aDialogAssoc)=0;

Description

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

Parameters

CSIPClientTransaction &aTransaction contains response elements. CSIPDialogAssocBase &aDialogAssoc a dialog association.

virtual void IncomingResponse(CSIPClientTransaction &aTransaction, CSIPInviteDialogAssoc *aDialogAssoc)=0;

Description

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.

Parameters

CSIPClientTransaction &aTransaction contains response elements CSIPInviteDialogAssoc *aDialogAssoc INVITE dialog association; the ownership is transferred

virtual void IncomingResponse(CSIPClientTransaction &aTransaction, CSIPRegistrationBinding &aRegistration)=0;

Description

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

Parameters

CSIPClientTransaction &aTransaction contains response elements CSIPRegistrationBinding &aRegistration registration binding this transaction belongs to

virtual void ErrorOccured(TInt aError, CSIPTransactionBase &aTransaction)=0;

Description

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

Parameters

TInt aError system wide or SIP error code CSIPTransactionBase &aTransaction failed transaction

virtual void ErrorOccured(TInt aError, CSIPClientTransaction &aTransaction, CSIPRegistrationBinding &aRegistration)=0;

Description

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

Parameters

TInt aError system wide or SIP error code CSIPClientTransaction &aTransaction the failed transaction CSIPRegistrationBinding &aRegistration the failed registration binding

virtual void ErrorOccured(TInt aError, CSIPTransactionBase &aTransaction, CSIPDialogAssocBase &aDialogAssoc)=0;

Description

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

Parameters

TInt aError system wide or SIP error code CSIPTransactionBase &aTransaction the failed transaction. CSIPDialogAssocBase &aDialogAssoc the failed dialog associoation.

virtual void ErrorOccured(TInt aError, CSIPRefresh &aSIPRefresh)=0;

Description

An asynchronous error has occured related to a refresh

Parameters

TInt aError system wide or SIP error code CSIPRefresh &aSIPRefresh original refresh object.

virtual void ErrorOccured(TInt aError, CSIPRegistrationBinding &aRegistration)=0;

Description

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

Parameters

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

virtual void ErrorOccured(TInt aError, CSIPDialogAssocBase &aDialogAssoc)=0;

Description

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

Parameters

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

virtual void InviteCompleted(CSIPClientTransaction &aTransaction)=0;

Description

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.

Parameters

CSIPClientTransaction &aTransaction a complete UAC core INVITE transaction

virtual void InviteCanceled(CSIPServerTransaction &aTransaction)=0;

Description

Invite was canceled with the CANCEL

Parameters

CSIPServerTransaction &aTransaction a canceled INVITE UAS transaction

virtual void ConnectionStateChanged(CSIPConnection::TState aState)=0;

Description

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.

Parameters

CSIPConnection::TState aState indicates the current connection state