MSenServiceConsumer Class Reference

Link against: SenServConn.LIB SenUtils.LIB

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData


#include <
MSenServiceConsumer.h>

Detailed Description

Callback interface for service consumers.

Public Member Functions

virtual void HandleMessageL (const TDesC8 &aMessage)=0
 Callback, which is invoked when a message is received from invoked service.
virtual void HandleErrorL (const TInt aErrorCode, const TDesC8 &aErrorMessage)=0
 Callback, which is invoked when an error message is received from invoked service.
virtual void SetStatus (const TInt aStatus)=0
 This method is called when the status of the connection to the service changes.

Member Function Documentation

virtual void MSenServiceConsumer::HandleErrorL const TInt  aErrorCode,
const TDesC8 &  aErrorMessage
[pure virtual]
 

Callback, which is invoked when an error message is received from invoked service.

Inside this method, it is guarenteed, that the TxnId() getter provided by CSenServiceConnection class will return valid transaction ID. This allows one to map the ID of sent request, returned from CSenServiceConnection::SendL with the response that is provided in this callback.

Parameters:
aErrorCode is the error code (negative number) Error codes are some of the following: KErrSenNotInitialized Connection hasn't been initialized. KErrConnectionInitializing Connection is still initializing. KErrSubmitting Submitting a message failed, e.g. tried to send a NULL message. KErrConnectionExpired Connection has expired and needs to be renewed. KErrSenSoapFault A SOAP fault occurred, aErrorMessage should contain more detailed information. KErrSenInternal Internal error in Web Services framework KErrUnknown An unexpected major error has occurred and cause is unknown. Other possible error codes can be HTTP error codes or system-wide Symbian error codes.
aErrorMessage contains the error message data; with SOAP based services, possibly a SOAP fault as XML.
virtual void MSenServiceConsumer::HandleMessageL const TDesC8 &  aMessage  )  [pure virtual]
 

Callback, which is invoked when a message is received from invoked service.

Inside this method, it is guarenteed, that the TxnId() getter provided by CSenServiceConnection class will return valid transaction ID. This allows one to map the ID of sent request, returned from CSenServiceConnection::SendL with the response that is provided in this callback.

Parameters:
aMessage incoming message.
virtual void MSenServiceConsumer::SetStatus const TInt  aStatus  )  [pure virtual]
 

This method is called when the status of the connection to the service changes.

Parameters:
aStatus is connection state indicator, which could be specified by the actual service invocation framework implementation. The following status codes are possible for any installed framework: KSenConnectionStatusNew Connection is being initialized, but not yet ready. KSenConnectionStatusReady Connection is ready to be used. For example, SubmitL() and SendL() methods (depending of framework) are in invocable state. KSenConnectionStatusExpired Connection is expired. Typically, a new connection needs next to be initialized in order to communicate with the underlying service behind this service connection.

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top