Collapse all Symbian^3 Product Developer Library

MSensrvPropertyListener Class Reference

class MSensrvPropertyListener

Property listener callback interface to indicate when a property has changed or when clients access to setting properties has changed.

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

CSensrvChannel::SetPropertyListenerL() sensrvclient.lib

Since: S60 5.0

Public Member Functions
void	GetPropertyListenerInterfaceL(TUid, TAny *&)
void	PropertyChanged(CSensrvChannel &, const TSensrvProperty &)
void	PropertyError(CSensrvChannel &, TSensrvErrorSeverity)
void	SetPropertySuccessIndicationChanged(TSetPropertySuccessIndicator)

Member Functions Documentation

GetPropertyListenerInterfaceL(TUid, TAny *&)

void	GetPropertyListenerInterfaceL	(	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.

PropertyChanged(CSensrvChannel &, const TSensrvProperty &)

void	PropertyChanged	(	CSensrvChannel &	aChannel,
			const TSensrvProperty &	aChangedProperty
		)	[pure virtual]

Callback implemented by a client so that they can be notified when the value of a property has changed. The client that set the property will not be notified.

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
const TSensrvProperty & aChangedProperty	The property that has changed

PropertyError(CSensrvChannel &, TSensrvErrorSeverity)

void	PropertyError	(	CSensrvChannel &	aChannel,
			TSensrvErrorSeverity	aError
		)	[pure virtual]

Callback implemented by a client so that they can be notified when property 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 property changes 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

SetPropertySuccessIndicationChanged(TSetPropertySuccessIndicator)

void

SetPropertySuccessIndicationChanged

(

TSetPropertySuccessIndicator

aIndication

)

[pure virtual]

Callback implemented by a client so that they can be notified when the clients access for setting properties has changed.

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

TSetPropertySuccessIndicator aIndication

Indication of the clients access for setting of properties