M_OverlayCtrl::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportOverlayCtrlSettings (M_OverlayCtrl::OverlayCtrlSettingsType const &Settings)
virtual void	ReportOverlayStatus (std::string const &KeyOverlayName, M_OverlayCtrl::OverlayCtrlStatusType const &Status, bool IsRemoved)

Detailed Description

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

Constructor & Destructor Documentation

~IClient()

M_OverlayCtrl::IClient::~IClient ( )

virtual

Member Function Documentation

ReportOverlayCtrlSettings()

void M_OverlayCtrl::IClient::ReportOverlayCtrlSettings ( M_OverlayCtrl::OverlayCtrlSettingsType const &  Settings )

virtual

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

Parameters

Settings

Service settings data.

ReportOverlayStatus()

void M_OverlayCtrl::IClient::ReportOverlayStatus ( std::string const &  KeyOverlayName, M_OverlayCtrl::OverlayCtrlStatusType const &  Status, bool  IsRemoved  )

virtual

Report with the current status for an Overlay. This will be reported for every Overlay and updated every time a status is changed.

Parameters

KeyOverlayName	The name of the overlay.
Status	Overlay control 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.