S60 3rd Edition SDK for Symbian OS Example Applications Guide

MSIPExSIPEngineObserver Class Reference

#include <SIPExSIPEngineObserver.h>

Inheritance diagram for MSIPExSIPEngineObserver:

List of all members.

Public Member Functions
virtual void	InviteReceived (const TDesC8 &aFrom, const TUint32 aIapId)=0
virtual void	InviteReceivedByRemote (const TInt aResponse)=0
virtual void	InviteAcceptedByRemote (const TInetAddr &aIPAddr, const TUint32 aIapId)=0
virtual void	InviteDeclinedByRemote (const TInt aResponse)=0
virtual void	InviteAcceptedByUs ()=0
virtual void	InvitationCancelled ()=0
virtual void	CancelFailed ()=0
virtual void	SessionEnded ()=0
virtual void	ConnectionLost ()=0
virtual void	EngineError (TInt aError)=0
virtual void	ProfileEnabled (TUint32 aSIPProfileId)=0
virtual void	ProfileError (TInt aError)=0
virtual void	IMReceived (const TDesC8 &aFrom, const TDesC8 &aMessage)=0
virtual void	WriteLog (const TDesC8 &aLog)=0

---

Detailed Description

The observer class for monitoring the SIP Engine. Class must be implemented by the user in order to observe changes in the SIP Engine.

Definition at line 31 of file SIPExSIPEngineObserver.h.

---

Member Function Documentation

virtual void MSIPExSIPEngineObserver::InviteReceived (  const TDesC8 &  aFrom, const TUint32  aIapId )  [pure virtual]

InviteReceived Called when an INVITE is received by the SIP Client. Parameters: aFrom  The sender of the INVITE aIapId  The access point id of used conection Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::InviteReceivedByRemote (  const TInt  aResponse  )  [pure virtual]

InviteReceivedByRemote Called when a provisional response (1xx, not 100 (Trying)) is received after sending INVITE. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::InviteAcceptedByRemote (  const TInetAddr &  aIPAddr, const TUint32  aIapId )  [pure virtual]

InviteAcceptedByRemote Called when the response 200 (OK) is received after sending INVITE. Parameters: aIPAddr  The IP Address of the remote party. aIapId  iap id used. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::InviteDeclinedByRemote (  const TInt  aResponse  )  [pure virtual]

InviteDeclinedByRemote Called when a 4xx, 5xx, or 6xx response is received after sending INVITE. As the session isn't established, the engine should be deleted. Parameters: aResponse  Value of the received response. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::InviteAcceptedByUs (   )  [pure virtual]

InviteAcceptedByUs Called when the response ACK is received after responding with 200 (OK) to an invitation. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::InvitationCancelled (   )  [pure virtual]

InvitationCancelled Called when an INVITE has been successfully cancelled. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::CancelFailed (   )  [pure virtual]

CancelFailed Called when the cancellation of an INVITE fails. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::SessionEnded (   )  [pure virtual]

SessionEnded Called when the session has been closed, ie. when the the response 200 (OK) is received after sending BYE, or after 200 (OK) has been sent after receiving BYE. Or we have declined a received INVITE. The observer should delete the engine. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::ConnectionLost (   )  [pure virtual]

ConnectionLost Called when the connection is lost because of an error. The observer should delete the engine. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::EngineError (  TInt  aError  )  [pure virtual]

EngineError Called when an error occurs in the SIP Example SIP Engine. Parameters: aError  Error number Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::ProfileEnabled (  TUint32  aSIPProfileId  )  [pure virtual]

ProfileEnabled Called when the EnableProfile method has completed successfully. Parameters: aSIPProfileId  ID of the enabled profile Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::ProfileError (  TInt  aError  )  [pure virtual]

ProfileError An error has occurred during a profile operation Parameters: aError  Error number Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::IMReceived (  const TDesC8 &  aFrom, const TDesC8 &  aMessage )  [pure virtual]

IMReceived Called when an Instant Message is received. Parameters: aFrom  The sender of the IM. aMessage  The message received. Implemented in CSIPExEngine.

virtual void MSIPExSIPEngineObserver::WriteLog (  const TDesC8 &  aLog  )  [pure virtual]

WriteLog Parameters: aLog,log  entry. Implemented in CSIPExEngine.

---

© Nokia 2006