S60 3rd Edition API Reference: MSIPConnectionObserver Class Reference

MSIPConnectionObserver Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <sipconnectionobserver.h>

Detailed Description

PublishedAll
Released
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.


Public Member Functions

virtual void IncomingRequest (CSIPServerTransaction *aTransaction)=0
 A SIP request outside a dialog has been received from the network.
virtual void IncomingRequest (CSIPServerTransaction *aTransaction, CSIPDialog &aDialog)=0
 A SIP request within a dialog has been received from the network.
virtual void IncomingResponse (CSIPClientTransaction &aTransaction)=0
 A SIP response received from the network.
virtual void IncomingResponse (CSIPClientTransaction &aTransaction, CSIPDialogAssocBase &aDialogAssoc)=0
 A SIP response received from the network that is within a dialog association or creates a dialog association.
virtual void IncomingResponse (CSIPClientTransaction &aTransaction, CSIPInviteDialogAssoc *aDialogAssoc)=0
 Multiple SIP responses have been received to the single INVITE due to the forking proxy.
virtual void IncomingResponse (CSIPClientTransaction &aTransaction, CSIPRegistrationBinding &aRegistration)=0
 A SIP response related a registration binding or an error response that is related to registration binding has been received from the network.
virtual void ErrorOccured (TInt aError, CSIPTransactionBase &aTransaction)=0
 An asynchronous error has occurred in the stack related to the request indicated by the given transaction.
virtual void ErrorOccured (TInt aError, CSIPClientTransaction &aTransaction, CSIPRegistrationBinding &aRegistration)=0
 An asynchronous error has occurred in the stack related to the request indicated by the given transaction.
virtual void ErrorOccured (TInt aError, CSIPTransactionBase &aTransaction, CSIPDialogAssocBase &aDialogAssoc)=0
 An asynchronous error has occured related to a request within an existing dialog.
virtual void ErrorOccured (TInt aError, CSIPRefresh &aSIPRefresh)=0
 An asynchronous error has occured related to a refresh.
virtual void ErrorOccured (TInt aError, CSIPRegistrationBinding &aRegistration)=0
 An asynchronous error has occured related to a periodical refresh that relates to a registration.
virtual void ErrorOccured (TInt aError, CSIPDialogAssocBase &aDialogAssoc)=0
 An asynchronous error has occured related to a periodical refresh that belongs to SIP dialog association.
virtual void InviteCompleted (CSIPClientTransaction &aTransaction)=0
 SIP stack has completed UAC core INVITE transaction 64*T1 seconds after the reception of the first 2xx response.
virtual void InviteCanceled (CSIPServerTransaction &aTransaction)=0
 Invite was canceled with the CANCEL.
virtual void ConnectionStateChanged (CSIPConnection::TState aState)=0
 Connection state has changed.

Member Function Documentation

virtual void MSIPConnectionObserver::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.

Parameters:
aState indicates the current connection state
virtual void MSIPConnectionObserver::ErrorOccured ( TInt  aError,
CSIPDialogAssocBase &  aDialogAssoc
)  [pure virtual]
 

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

Parameters:
aError system wide or SIP error code; KErrCouldNotConnect if the refresh has failed due to the suspended connection.
aDialogAssoc SIP dialog association.
virtual void MSIPConnectionObserver::ErrorOccured ( TInt  aError,
CSIPRegistrationBinding &  aRegistration
)  [pure virtual]
 

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

Parameters:
aError system wide or SIP error code; KErrCouldNotConnect if the refresh has failed due to the suspended connection.
aRegistration associated registration binding
virtual void MSIPConnectionObserver::ErrorOccured ( TInt  aError,
CSIPRefresh &  aSIPRefresh
)  [pure virtual]
 

An asynchronous error has occured related to a refresh.

Parameters:
aError system wide or SIP error code
aSIPRefresh original refresh object.
virtual void MSIPConnectionObserver::ErrorOccured ( TInt  aError,
CSIPTransactionBase &  aTransaction,
CSIPDialogAssocBase &  aDialogAssoc
)  [pure virtual]
 

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

Parameters:
aError system wide or SIP error code
aTransaction the failed transaction.
aDialogAssoc the failed dialog associoation.
virtual void MSIPConnectionObserver::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.

Parameters:
aError system wide or SIP error code
aTransaction the failed transaction
aRegistration the failed registration binding
virtual void MSIPConnectionObserver::ErrorOccured ( TInt  aError,
CSIPTransactionBase &  aTransaction
)  [pure virtual]
 

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

Parameters:
aError system wide or SIP error code
aTransaction failed transaction
aSIPConnection a SIP connection
virtual void MSIPConnectionObserver::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.

Precondition:
aTransaction != 0
Parameters:
aTransaction SIP server transaction. The ownership is transferred.
aDialog the dialog that this transaction belongs to.
virtual void MSIPConnectionObserver::IncomingRequest ( CSIPServerTransaction *  aTransaction  )  [pure virtual]
 

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

Precondition:
aTransaction != 0
Parameters:
aTransaction SIP server transaction. The ownership is transferred.
virtual void MSIPConnectionObserver::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.

Parameters:
aTransaction contains response elements
aRegistration registration binding this transaction belongs to
virtual void MSIPConnectionObserver::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.

Parameters:
aTransaction contains response elements
aDialogAssoc INVITE dialog association; the ownership is transferred
virtual void MSIPConnectionObserver::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.

Parameters:
aTransaction contains response elements.
aDialogAssoc a dialog association.
virtual void MSIPConnectionObserver::IncomingResponse ( CSIPClientTransaction &  aTransaction  )  [pure virtual]
 

A SIP response received from the network.

Parameters:
aTransaction contains response elements.
virtual void MSIPConnectionObserver::InviteCanceled ( CSIPServerTransaction &  aTransaction  )  [pure virtual]
 

Invite was canceled with the CANCEL.

Parameters:
aTransaction a canceled INVITE UAS transaction
virtual void MSIPConnectionObserver::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.

Parameters:
aTransaction a complete UAC core INVITE transaction
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top