M_BuiltInTestCtrl::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportBitCtrlSettings (M_BuiltInTestCtrl::BitCtrlSettingsType const &Settings)
virtual void	ReportBitCtrlStatus (M_BuiltInTestCtrl::BitCtrlStatusType const &Status, bool IsRemoved)
virtual void	ResponseHistoricalRecords (M_BuiltInTestCtrl::HistoricalBitRecordParamsType const &RecordParams, M_BuiltInTestCtrl::BitRecordListType const &RecordList, uint32_t TotalNoFilteredRecords)

Detailed Description

BITE Control Client interface. Contains callback operations from the BITE Control Service to the Client.

Constructor & Destructor Documentation

~IClient()

M_BuiltInTestCtrl::IClient::~IClient ( )

virtual

Member Function Documentation

ReportBitCtrlSettings()

void M_BuiltInTestCtrl::IClient::ReportBitCtrlSettings ( M_BuiltInTestCtrl::BitCtrlSettingsType const &  Settings )

virtual

Report with BITE Control Service settings. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters

Settings

BITE Control Service settings data.

ReportBitCtrlStatus()

void M_BuiltInTestCtrl::IClient::ReportBitCtrlStatus ( M_BuiltInTestCtrl::BitCtrlStatusType const &  Status, bool  IsRemoved  )

virtual

Reports the status of the Service.

Parameters

Status
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.

ResponseHistoricalRecords()

void M_BuiltInTestCtrl::IClient::ResponseHistoricalRecords ( M_BuiltInTestCtrl::HistoricalBitRecordParamsType const &  RecordParams, M_BuiltInTestCtrl::BitRecordListType const &  RecordList, uint32_t  TotalNoFilteredRecords  )

virtual

Response with historical records provided in response to a specific request.

Note: If no matching historical records can be found in the service, then the Service should respond with an empty record list.

Parameters

RecordParams	Parameters of the requested reports.
RecordList	The list of requested historical records.
TotalNoFilteredRecords	The total number of records stored in the service which matches the requested filter expression.