iv::comms::api::IApiCommunicationProtocol Class Reference

#include <IApiCommunicationProtocol.hpp>

Inheritance diagram for iv::comms::api::IApiCommunicationProtocol:

Classes
struct	ValuesApi

Public Member Functions
virtual	~IApiCommunicationProtocol ()=default
virtual void	registerValue (const std::shared_ptr< iv::comms::api::ILoggerMessage > &message)=0
	Registers an API message without blocking the thread.
virtual bool	sendValues ()=0
	Send all registered messages to the API.
virtual iv::comms::api::ApiResponse	getValues (const IApiQueryParamsBuilder &queryParams) const =0
	Get values from the API.
virtual iv::comms::api::ApiDeleteResponse	deleteValues (const IApiQueryParamsBuilder &queryParams) const =0
	Delete values from the API.
iv::comms::api::ApiPingResponse	ping () const
bool	wipe () const
bool	isEnabled () const

Protected Attributes
bool	m_sendToCloud {false}
bool	m_isEnabled {true}
std::shared_ptr< iv::model::comms::NetworkData >	m_networkData
std::weak_ptr< iv::comms::api::ApiCommunicationDriver >	m_apiDriver
std::weak_ptr< iv::channels::AbstractChannel >	m_heartbeatChannel
std::weak_ptr< iv::diamar::AppFailuresLoggerManager >	m_appFailuresLoggerManager

Constructor & Destructor Documentation

~IApiCommunicationProtocol()

virtual iv::comms::api::IApiCommunicationProtocol::~IApiCommunicationProtocol ( )

virtualdefault

Member Function Documentation

deleteValues()

virtual iv::comms::api::ApiDeleteResponse iv::comms::api::IApiCommunicationProtocol::deleteValues ( const IApiQueryParamsBuilder & queryParams ) const

nodiscardpure virtual

Delete values from the API.

Parameters

queryParams

Returns

Implemented in iv::comms::api::dataLogger::ApiDataLoggerCommunicationProtocol, iv::comms::api::eventLogger::ApiEventLoggerCommunicationProtocol, and iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol.

getValues()

virtual iv::comms::api::ApiResponse iv::comms::api::IApiCommunicationProtocol::getValues ( const IApiQueryParamsBuilder & queryParams ) const

nodiscardpure virtual

Get values from the API.

Parameters

queryParams

Returns

Implemented in iv::comms::api::dataLogger::ApiDataLoggerCommunicationProtocol, iv::comms::api::eventLogger::ApiEventLoggerCommunicationProtocol, and iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol.

isEnabled()

bool iv::comms::api::IApiCommunicationProtocol::isEnabled ( ) const

nodiscard

ping()

iv::comms::api::ApiPingResponse iv::comms::api::IApiCommunicationProtocol::ping ( ) const

nodiscard

registerValue()

virtual void iv::comms::api::IApiCommunicationProtocol::registerValue ( const std::shared_ptr< iv::comms::api::ILoggerMessage > & message )

pure virtual

Registers an API message without blocking the thread.

Parameters

message

Implemented in iv::comms::api::dataLogger::ApiDataLoggerCommunicationProtocol, iv::comms::api::eventLogger::ApiEventLoggerCommunicationProtocol, and iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol.

sendValues()

virtual bool iv::comms::api::IApiCommunicationProtocol::sendValues ( )

pure virtual

Send all registered messages to the API.

Returns

Implemented in iv::comms::api::dataLogger::ApiDataLoggerCommunicationProtocol, iv::comms::api::eventLogger::ApiEventLoggerCommunicationProtocol, and iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol.

wipe()

bool iv::comms::api::IApiCommunicationProtocol::wipe ( ) const

nodiscard

Member Data Documentation

m_apiDriver

std::weak_ptr<iv::comms::api::ApiCommunicationDriver> iv::comms::api::IApiCommunicationProtocol::m_apiDriver

protected

m_appFailuresLoggerManager

std::weak_ptr<iv::diamar::AppFailuresLoggerManager> iv::comms::api::IApiCommunicationProtocol::m_appFailuresLoggerManager

protected

m_heartbeatChannel

std::weak_ptr<iv::channels::AbstractChannel> iv::comms::api::IApiCommunicationProtocol::m_heartbeatChannel

protected

m_isEnabled

bool iv::comms::api::IApiCommunicationProtocol::m_isEnabled {true}

protected

m_networkData

std::shared_ptr<iv::model::comms::NetworkData> iv::comms::api::IApiCommunicationProtocol::m_networkData

protected

m_sendToCloud

bool iv::comms::api::IApiCommunicationProtocol::m_sendToCloud {false}

protected

Boolean that determines if the API should send data to the cloud on request.

---

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

• src/comms/apis/IApiCommunicationProtocol.hpp
• src/comms/apis/IApiCommunicationProtocol.cpp