ot::GuiAPIManager Class Reference

The GuiAPIManager singleton manages the frontend information and provides a message sending method. More...

#include "GuiAPIManager.h"

Public Member Functions
void	frontendConnected (const ServiceBase &_serviceInformation)
	Apply frontend information, enable message sending and forward frontend connected state to other GuiAPI managers.
void	frontendDisconnected (void)
	Clear frontend information, disable message sending and forward frontend disconnected state to other GuiAPI managers.
bool	isFrontendConnected (void) const
	Returns true if the frontend information was set.
bool	sendQueuedRequestToFrontend (const std::string &_message)
	Send the provided message to the frontend. If no frontend is connected a warning log is generated and the method returns false.

Static Public Member Functions
static GuiAPIManager &	instance (void)
	Returns global instance.

Detailed Description

The GuiAPIManager singleton manages the frontend information and provides a message sending method.

Member Function Documentation

frontendConnected()

void ot::GuiAPIManager::frontendConnected

(

const ServiceBase &

_serviceInformation

)

Apply frontend information, enable message sending and forward frontend connected state to other GuiAPI managers.

Parameters

_serviceInformation

Frontend service information to set.

frontendDisconnected()

void ot::GuiAPIManager::frontendDisconnected

(

void

)

Clear frontend information, disable message sending and forward frontend disconnected state to other GuiAPI managers.

instance()

ot::GuiAPIManager & ot::GuiAPIManager::instance ( void )

static

Returns global instance.

isFrontendConnected()

bool ot::GuiAPIManager::isFrontendConnected ( void ) const

inline

Returns true if the frontend information was set.

sendQueuedRequestToFrontend()

bool ot::GuiAPIManager::sendQueuedRequestToFrontend

(

const std::string &

_message

)

Send the provided message to the frontend. If no frontend is connected a warning log is generated and the method returns false.

---

The documentation for this class was generated from the following files:

• Libraries/OTGuiAPI/include/OTGuiAPI/GuiAPIManager.h
• Libraries/OTGuiAPI/src/GuiAPIManager.cpp