MSensrvChannelConditionListener Class Reference

Link against: SensrvClient.lib

#include <sensrvchannelconditionlistener.h>

Detailed Description

Condition listener callback interface to indicate when a ConditionSet has been met.

This class is for use with the CSensrvChannel::StartConditionListeningL() method. Clients wishing to use condition listening must inherit from this class and provide a reference to an instance of it in CSensrvChannel::StartConditionListeningL().

See also:
CSensrvChannel::StartConditionListeningL()

CSensrvChannel::StopConditionListening()

CSensrvChannel::AddConditionL()

CSensrvChannel::RemoveConditionL()

Dll sensrvclient.lib
Since:
S60 5.0

Public Member Functions

virtual void ConditionMet (CSensrvChannel &aChannel, CSensrvChannelConditionSet &aChannelConditionSet, TDesC8 &aValue)=0
 Callback implemented by a client so that they can be notified when a channel ConditionSet is met.
virtual void ConditionError (CSensrvChannel &aChannel, TSensrvErrorSeverity aError)=0
 Callback implemented by a client so that they can be notified when condition listening has failed.
virtual void GetChannelConditionListenerInterfaceL (TUid aInterfaceUid, TAny *&aInterface)=0
 Callback to future proof this API so that additional callbacks can be added in the future without breaking binary compatibility.

Member Function Documentation

virtual void MSensrvChannelConditionListener::ConditionError ( CSensrvChannel &  aChannel,
TSensrvErrorSeverity  aError
)  [pure virtual]
 

Callback implemented by a client so that they can be notified when condition listening has failed.

If the error is fatal the channel will be closed, the sensor server session has been terminated and the channel object is no longer useable. If the error is minor, some condition matches have potentially been missed, however listening is still active.

Clients providing an implementation for this callback must ensure that the operation does not leave. If a leave does occur then the behaviour is undefined.

Since:
S60 5.0
Parameters:
aChannel Channel associated with the listener
aError The error severity
virtual void MSensrvChannelConditionListener::ConditionMet ( CSensrvChannel &  aChannel,
CSensrvChannelConditionSet &  aChannelConditionSet,
TDesC8 &  aValue
)  [pure virtual]
 

Callback implemented by a client so that they can be notified when a channel ConditionSet is met.

If a client wants to use same ConditionSet after receiving this notification, the client must add ConditionSet again to the channel object. If the ConditionSet is no longer required the client can destroy it.

If the ConditionSet contains more than one condition, it is not known which of the individual conditions in the set were met.

Clients providing an implementation for this callback must ensure that the operation does not leave. If a leave does occur then the behaviour is undefined.

Since:
S60 5.0
Parameters:
aChannel Channel associated with the listener
aChannelConditionSet Channel ConditionSet that is met
aValue Channel data value that met the condition
See also:
CSensrvChannel::GetData() for example on how to retrive data from aValue
virtual void MSensrvChannelConditionListener::GetChannelConditionListenerInterfaceL ( TUid  aInterfaceUid,
TAny *&  aInterface
)  [pure virtual]
 

Callback to future proof this API so that additional callbacks can be added in the future without breaking binary compatibility.

Since:
S60 5.0
Parameters:
aInterfaceUid Identifier for the interface to be retrieved
aInterface A reference to a pointer for the specified interface. Implementation sets aInterface to a valid pointer if the M-class identified by aInterfaceUid is supported, otherwise it is set to NULL on exit.
Leave:
One of the system-wide error codes
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top