iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol Class Reference

#include <ApiHistoryLoggerCommunicationProtocol.hpp>

Inheritance diagram for iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol:

Collaboration diagram for iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol:

Classes
struct	ValuesApi

Public Member Functions
	ApiHistoryLoggerCommunicationProtocol ()=delete
	ApiHistoryLoggerCommunicationProtocol (const std::shared_ptr< iv::comms::ICommunicationDriver > &driver, const std::shared_ptr< iv::model::comms::NetworkData > &networkData, const std::weak_ptr< iv::channels::AbstractChannel > &heartbeatChannel, const std::weak_ptr< iv::diamar::AppFailuresLoggerManager > &appFailuresLoggerManager, bool sendToCloud)
	~ApiHistoryLoggerCommunicationProtocol () override=default
void	registerValue (const std::shared_ptr< iv::comms::api::ILoggerMessage > &message) override
	Registers an API message without blocking the thread.
bool	sendValues () override
	Send all registered messages to the API.
iv::comms::api::ApiResponse	getValues (const IApiQueryParamsBuilder &queryParams) const override
	Get values from the API.
iv::comms::api::ApiDeleteResponse	deleteValues (const IApiQueryParamsBuilder &queryParams) const override
	Delete values from the API.
iv::comms::api::ApiPingResponse	ping () const
bool	wipe () const
bool	isEnabled () const

Protected Attributes
std::shared_ptr< iv::comms::ICommunicationDriver >	m_driver
bool	m_sendToCloud {false}
bool	m_isEnabled {true}
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

Private Member Functions
bool	isOnline () override

Private Attributes
std::shared_ptr< iv::model::comms::NetworkData >	m_networkData
std::unique_ptr< iv::containers::CircularQueue< std::shared_ptr< iv::comms::api::historyLogger::HistoryLoggerMessage >, m_sendQueueSize > >	m_sendQueue

Static Private Attributes
static constexpr std::size_t	m_sendQueueSize {5000}

Constructor & Destructor Documentation

ApiHistoryLoggerCommunicationProtocol() [1/2]

iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::ApiHistoryLoggerCommunicationProtocol ( )

delete

ApiHistoryLoggerCommunicationProtocol() [2/2]

iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::ApiHistoryLoggerCommunicationProtocol ( const std::shared_ptr< iv::comms::ICommunicationDriver > & driver, const std::shared_ptr< iv::model::comms::NetworkData > & networkData, const std::weak_ptr< iv::channels::AbstractChannel > & heartbeatChannel, const std::weak_ptr< iv::diamar::AppFailuresLoggerManager > & appFailuresLoggerManager, bool sendToCloud )

explicit

~ApiHistoryLoggerCommunicationProtocol()

iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::~ApiHistoryLoggerCommunicationProtocol ( )

overridedefault

Member Function Documentation

deleteValues()

iv::comms::api::ApiDeleteResponse iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::deleteValues ( const IApiQueryParamsBuilder & queryParams ) const

nodiscardoverridevirtual

Delete values from the API.

Parameters

queryParams

Returns

Implements iv::comms::api::IApiCommunicationProtocol.

getValues()

iv::comms::api::ApiResponse iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::getValues ( const IApiQueryParamsBuilder & queryParams ) const

nodiscardoverridevirtual

Get values from the API.

Parameters

queryParams

Returns

Implements iv::comms::api::IApiCommunicationProtocol.

isEnabled()

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

nodiscardinherited

isOnline()

bool iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::isOnline ( )

inlinenodiscardoverrideprivatevirtual

Implements iv::comms::ICommunicationProtocol.

ping()

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

nodiscardinherited

registerValue()

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

overridevirtual

Registers an API message without blocking the thread.

Parameters

message

Implements iv::comms::api::IApiCommunicationProtocol.

sendValues()

bool iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::sendValues ( )

overridevirtual

Send all registered messages to the API.

Returns

Implements iv::comms::api::IApiCommunicationProtocol.

wipe()

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

nodiscardinherited

Member Data Documentation

m_apiDriver

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

protectedinherited

m_appFailuresLoggerManager

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

protectedinherited

m_driver

std::shared_ptr<iv::comms::ICommunicationDriver> iv::comms::ICommunicationProtocol::m_driver

protectedinherited

m_heartbeatChannel

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

protectedinherited

m_isEnabled

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

protectedinherited

m_networkData

std::shared_ptr<iv::model::comms::NetworkData> iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::m_networkData

private

m_sendQueue

std::unique_ptr<iv::containers::CircularQueue<std::shared_ptr<iv::comms::api::historyLogger::HistoryLoggerMessage>, m_sendQueueSize> > iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::m_sendQueue

private

m_sendQueueSize

std::size_t iv::comms::api::historyLogger::ApiHistoryLoggerCommunicationProtocol::m_sendQueueSize {5000}

staticconstexprprivate

m_sendToCloud

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

protectedinherited

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/historyLogger/ApiHistoryLoggerCommunicationProtocol.hpp
• src/comms/apis/historyLogger/ApiHistoryLoggerCommunicationProtocol.cpp