M_Device::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportDeviceSettings (M_Device::DeviceSettingsType const &Settings)
virtual void	ReportDeviceStatus (M_Device::DeviceStatusType const &Status, bool IsRemoved)
virtual void	ReportValue (std::string const &KeyId, M_Common::PropertyType const &Value, bool IsRemoved)
virtual void	ResponseValue (std::string const &Id, M_Common::PropertyType const &Value)

Detailed Description

Device client interface. Contains callback operations from the device service to the client.

Constructor & Destructor Documentation

~IClient()

M_Device::IClient::~IClient ( )

virtual

Member Function Documentation

ReportDeviceSettings()

void M_Device::IClient::ReportDeviceSettings ( M_Device::DeviceSettingsType const &  Settings )

virtual

Report the settings of a device service.

Parameters

Settings

Settings data for device service.

ReportDeviceStatus()

void M_Device::IClient::ReportDeviceStatus ( M_Device::DeviceStatusType const &  Status, bool  IsRemoved  )

virtual

Report the current status of a device.

Parameters

Status	Current status data for device.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

ReportValue()

void M_Device::IClient::ReportValue ( std::string const &  KeyId, M_Common::PropertyType const &  Value, bool  IsRemoved  )

virtual

Report a specified value.

Parameters

KeyId	Identifies the component/location. Note: recommended format for e.g. operating hours: KeyId = <subcomponent_name> Value.Name = "OperatingHours"
Value	Value of interest.
IsRemoved	Indicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.

ResponseValue()

void M_Device::IClient::ResponseValue ( std::string const &  Id, M_Common::PropertyType const &  Value  )

virtual

Response to a request to transmit a specified value.

Parameters

Id	Identifies the component/location.
Value	Value of interest.