MSIPConnectionObserver Class Reference

#include <mw/sipconnectionobserver.h>

Link against: n/a

class MSIPConnectionObserver

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 )

voidConnectionStateChanged(CSIPConnection::TStateaState)[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.

ParameterDescription
aStateindicates the current connection state

ErrorOccured ( TInt, CSIPTransactionBase & )

voidErrorOccured(TIntaError,
CSIPTransactionBase &aTransaction
)[pure virtual]

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

ParameterDescription
aErrorsystem wide or SIP error code
aTransactionfailed transaction

ErrorOccured ( TInt, CSIPClientTransaction &, CSIPRegistrationBinding & )

voidErrorOccured(TIntaError,
CSIPClientTransaction &aTransaction,
CSIPRegistrationBinding &aRegistration
)[pure virtual]

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

ParameterDescription
aErrorsystem wide or SIP error code
aTransactionthe failed transaction
aRegistrationthe failed registration binding

ErrorOccured ( TInt, CSIPTransactionBase &, CSIPDialogAssocBase & )

voidErrorOccured(TIntaError,
CSIPTransactionBase &aTransaction,
CSIPDialogAssocBase &aDialogAssoc
)[pure virtual]

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

ParameterDescription
aErrorsystem wide or SIP error code
aTransactionthe failed transaction.
aDialogAssocthe failed dialog associoation.

ErrorOccured ( TInt, CSIPRefresh & )

voidErrorOccured(TIntaError,
CSIPRefresh &aSIPRefresh
)[pure virtual]

An asynchronous error has occured related to a refresh

ParameterDescription
aErrorsystem wide or SIP error code
aSIPRefreshoriginal refresh object.

ErrorOccured ( TInt, CSIPRegistrationBinding & )

voidErrorOccured(TIntaError,
CSIPRegistrationBinding &aRegistration
)[pure virtual]

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

ParameterDescription
aErrorsystem wide or SIP error code; KErrCouldNotConnect if the refresh has failed due to the suspended connection.
aRegistrationassociated registration binding

ErrorOccured ( TInt, CSIPDialogAssocBase & )

voidErrorOccured(TIntaError,
CSIPDialogAssocBase &aDialogAssoc
)[pure virtual]

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

ParameterDescription
aErrorsystem wide or SIP error code; KErrCouldNotConnect if the refresh has failed due to the suspended connection.
aDialogAssocSIP dialog association.

IncomingRequest ( CSIPServerTransaction * )

voidIncomingRequest(CSIPServerTransaction *aTransaction)[pure virtual]

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

Pre-condition
aTransaction != 0
ParameterDescription
aTransactionSIP server transaction. The ownership is transferred.

IncomingRequest ( CSIPServerTransaction *, CSIPDialog & )

voidIncomingRequest(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
ParameterDescription
aTransactionSIP server transaction. The ownership is transferred.
aDialogthe dialog that this transaction belongs to.

IncomingResponse ( CSIPClientTransaction & )

voidIncomingResponse(CSIPClientTransaction &aTransaction)[pure virtual]

A SIP response received from the network.

ParameterDescription
aTransactioncontains response elements.

IncomingResponse ( CSIPClientTransaction &, CSIPDialogAssocBase & )

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

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

ParameterDescription
aTransactioncontains response elements.
aDialogAssoca dialog association.

IncomingResponse ( CSIPClientTransaction &, CSIPInviteDialogAssoc * )

voidIncomingResponse(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.

ParameterDescription
aTransactioncontains response elements
aDialogAssocINVITE dialog association; the ownership is transferred

IncomingResponse ( CSIPClientTransaction &, CSIPRegistrationBinding & )

voidIncomingResponse(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.

ParameterDescription
aTransactioncontains response elements
aRegistrationregistration binding this transaction belongs to

InviteCanceled ( CSIPServerTransaction & )

voidInviteCanceled(CSIPServerTransaction &aTransaction)[pure virtual]

Invite was canceled with the CANCEL

ParameterDescription
aTransactiona canceled INVITE UAS transaction

InviteCompleted ( CSIPClientTransaction & )

voidInviteCompleted(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.

ParameterDescription
aTransactiona complete UAC core INVITE transaction