Collapse all Symbian^3 Application Developer Library

MSensrvChannelConditionListener Class Reference

class MSensrvChannelConditionListener

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

CSensrvChannel::StartConditionListeningL() CSensrvChannel::StopConditionListening() CSensrvChannel::AddConditionL() CSensrvChannel::RemoveConditionL() sensrvclient.lib

Since: S60 5.0

Public Member Functions
void	ConditionError (CSensrvChannel &, TSensrvErrorSeverity )
void	ConditionMet (CSensrvChannel &, CSensrvChannelConditionSet &, TDesC8 &)
void	GetChannelConditionListenerInterfaceL ( TUid , TAny *&)

Member Functions Documentation

ConditionError(CSensrvChannel &, TSensrvErrorSeverity)

void	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

CSensrvChannel & aChannel	Channel associated with the listener
TSensrvErrorSeverity aError	The error severity

ConditionMet(CSensrvChannel &, CSensrvChannelConditionSet &, TDesC8 &)

void	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

CSensrvChannel::GetData() for example on how to retrive data from aValue

Parameters

CSensrvChannel & aChannel	Channel associated with the listener
CSensrvChannelConditionSet & aChannelConditionSet	Channel ConditionSet that is met
TDesC8 & aValue	Channel data value that met the condition

GetChannelConditionListenerInterfaceL(TUid, TAny *&)

void	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

leave: One of the system-wide error codes

Parameters

TUid aInterfaceUid	Identifier for the interface to be retrieved
TAny *& 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.