iv::comms::api::ApiCommunicationController Class Reference

#include <ApiCommunicationController.hpp>

Inheritance diagram for iv::comms::api::ApiCommunicationController:

Collaboration diagram for iv::comms::api::ApiCommunicationController:

Public Member Functions
	ApiCommunicationController ()=delete
	ApiCommunicationController (const std::shared_ptr< iv::comms::ICommunicationDriver > &driver, const std::shared_ptr< iv::model::comms::NetworkData > &networkData)
	ApiCommunicationController (const ApiCommunicationController &other)=delete
	ApiCommunicationController (ApiCommunicationController &&other)=delete
	~ApiCommunicationController () override=default
ApiCommunicationController &	operator= (const ApiCommunicationController &other)=delete
ApiCommunicationController &	operator= (ApiCommunicationController &&other)=delete
void	registerDataLog (const std::shared_ptr< iv::comms::api::ILoggerMessage > &message) const
void	registerEventLog (const std::shared_ptr< iv::comms::api::ILoggerMessage > &message) const
void	registerHistoryLog (const std::shared_ptr< iv::comms::api::ILoggerMessage > &message) const
iv::comms::api::ApiResponse	requestDataLog (const IApiQueryParamsBuilder &queryParams) const
iv::comms::api::ApiResponse	requestEventLog (const IApiQueryParamsBuilder &queryParams) const
iv::comms::api::ApiResponse	requestHistoryLog (const IApiQueryParamsBuilder &queryParams) const
iv::comms::api::ApiDeleteResponse	deleteDataLogs (const IApiQueryParamsBuilder &queryParams) const
iv::comms::api::ApiDeleteResponse	deleteEventLogs (const IApiQueryParamsBuilder &queryParams) const
iv::comms::api::ApiDeleteResponse	deleteHistoryLogs (const IApiQueryParamsBuilder &queryParams) const
iv::comms::api::ApiPingResponse	ping () const
bool	wipe () const
void	pause () const
void	resume () const
iv::types::networkId	getNetworkId () const
std::shared_ptr< iv::model::comms::NetworkData >	getCommConfig () const
std::shared_ptr< iv::comms::ICommunicationDriver >	getDriver () const
bool	hasChannel (const iv::types::channelId &channelId) const
bool	isEnabled ()

Protected Attributes
iv::types::networkId	m_networkId
std::shared_ptr< bool >	m_isEnabled
std::shared_ptr< iv::model::comms::NetworkData >	m_commConfig
std::shared_ptr< iv::comms::ICommunicationProtocol >	m_protocol
std::shared_ptr< iv::comms::ICommunicationDriver >	m_driver
std::map< iv::types::channelId, std::shared_ptr< iv::channels::AbstractChannel > >	m_channels
std::weak_ptr< iv::channels::AbstractChannel >	m_errorChannel
std::weak_ptr< iv::channels::AbstractChannel >	m_heartbeatChannel
std::weak_ptr< iv::comms::ICommunicationController >	m_fallbackComm
std::weak_ptr< iv::diamar::AppFailuresLoggerManager >	m_appFailuresLoggerManager

Private Member Functions
void	addChannel (const std::shared_ptr< iv::channels::AbstractChannel > &channel) override
bool	frame () override
void	initialize () override

Static Private Member Functions
static bool	shouldSendToCloud (const std::shared_ptr< iv::model::comms::NetworkData > &networkData)

Private Attributes
std::shared_ptr< iv::comms::ICommunicationProtocol >	m_dataLoggerProtocol
std::shared_ptr< iv::comms::ICommunicationProtocol >	m_eventLoggerProtocol
std::shared_ptr< iv::comms::ICommunicationProtocol >	m_historyLoggerProtocol
std::mutex	m_commControllerMutex

Friends
class	ApiCommunicationControllerFrame

Constructor & Destructor Documentation

ApiCommunicationController() [1/4]

iv::comms::api::ApiCommunicationController::ApiCommunicationController ( )

delete

ApiCommunicationController() [2/4]

iv::comms::api::ApiCommunicationController::ApiCommunicationController	(	const std::shared_ptr< iv::comms::ICommunicationDriver > &	driver,
		const std::shared_ptr< iv::model::comms::NetworkData > &	networkData )

ApiCommunicationController() [3/4]

iv::comms::api::ApiCommunicationController::ApiCommunicationController ( const ApiCommunicationController & other )

delete

ApiCommunicationController() [4/4]

iv::comms::api::ApiCommunicationController::ApiCommunicationController ( ApiCommunicationController && other )

delete

~ApiCommunicationController()

iv::comms::api::ApiCommunicationController::~ApiCommunicationController ( )

overridedefault

Member Function Documentation

addChannel()

void iv::comms::api::ApiCommunicationController::addChannel ( const std::shared_ptr< iv::channels::AbstractChannel > & channel )

overrideprivatevirtual

Implements iv::comms::ICommunicationController.

deleteDataLogs()

iv::comms::api::ApiDeleteResponse iv::comms::api::ApiCommunicationController::deleteDataLogs

(

const IApiQueryParamsBuilder &

queryParams

)

const

deleteEventLogs()

iv::comms::api::ApiDeleteResponse iv::comms::api::ApiCommunicationController::deleteEventLogs

(

const IApiQueryParamsBuilder &

queryParams

)

const

deleteHistoryLogs()

iv::comms::api::ApiDeleteResponse iv::comms::api::ApiCommunicationController::deleteHistoryLogs

(

const IApiQueryParamsBuilder &

queryParams

)

const

frame()

bool iv::comms::api::ApiCommunicationController::frame ( )

overrideprivatevirtual

Implements iv::comms::ICommunicationController.

getCommConfig()

std::shared_ptr< iv::model::comms::NetworkData > iv::comms::ICommunicationController::getCommConfig ( ) const

inlinenodiscardinherited

getDriver()

std::shared_ptr< iv::comms::ICommunicationDriver > iv::comms::ICommunicationController::getDriver ( ) const

inlinenodiscardinherited

getNetworkId()

iv::types::networkId iv::comms::ICommunicationController::getNetworkId ( ) const

inlinenodiscardinherited

hasChannel()

bool iv::comms::ICommunicationController::hasChannel ( const iv::types::channelId & channelId ) const

inlinenodiscardinherited

initialize()

void iv::comms::api::ApiCommunicationController::initialize ( )

overrideprivatevirtual

Implements iv::comms::ICommunicationController.

isEnabled()

bool iv::comms::ICommunicationController::isEnabled ( )

inlinenodiscardinherited

operator=() [1/2]

ApiCommunicationController & iv::comms::api::ApiCommunicationController::operator= ( ApiCommunicationController && other )

delete

operator=() [2/2]

ApiCommunicationController & iv::comms::api::ApiCommunicationController::operator= ( const ApiCommunicationController & other )

delete

pause()

void iv::comms::ICommunicationController::pause ( ) const

inlineinherited

ping()

iv::comms::api::ApiPingResponse iv::comms::api::ApiCommunicationController::ping

(

)

const

registerDataLog()

void iv::comms::api::ApiCommunicationController::registerDataLog

(

const std::shared_ptr< iv::comms::api::ILoggerMessage > &

message

)

const

registerEventLog()

void iv::comms::api::ApiCommunicationController::registerEventLog

(

const std::shared_ptr< iv::comms::api::ILoggerMessage > &

message

)

const

registerHistoryLog()

void iv::comms::api::ApiCommunicationController::registerHistoryLog

(

const std::shared_ptr< iv::comms::api::ILoggerMessage > &

message

)

const

requestDataLog()

iv::comms::api::ApiResponse iv::comms::api::ApiCommunicationController::requestDataLog

(

const IApiQueryParamsBuilder &

queryParams

)

const

requestEventLog()

iv::comms::api::ApiResponse iv::comms::api::ApiCommunicationController::requestEventLog

(

const IApiQueryParamsBuilder &

queryParams

)

const

requestHistoryLog()

iv::comms::api::ApiResponse iv::comms::api::ApiCommunicationController::requestHistoryLog

(

const IApiQueryParamsBuilder &

queryParams

)

const

resume()

void iv::comms::ICommunicationController::resume ( ) const

inlineinherited

shouldSendToCloud()

bool iv::comms::api::ApiCommunicationController::shouldSendToCloud ( const std::shared_ptr< iv::model::comms::NetworkData > & networkData )

staticprivate

wipe()

bool iv::comms::api::ApiCommunicationController::wipe

(

)

const

Friends And Related Symbol Documentation

ApiCommunicationControllerFrame

friend class ApiCommunicationControllerFrame

friend

Member Data Documentation

m_appFailuresLoggerManager

std::weak_ptr<iv::diamar::AppFailuresLoggerManager> iv::comms::ICommunicationController::m_appFailuresLoggerManager

protectedinherited

m_channels

std::map<iv::types::channelId, std::shared_ptr<iv::channels::AbstractChannel> > iv::comms::ICommunicationController::m_channels

protectedinherited

m_commConfig

std::shared_ptr<iv::model::comms::NetworkData> iv::comms::ICommunicationController::m_commConfig

protectedinherited

m_commControllerMutex

std::mutex iv::comms::api::ApiCommunicationController::m_commControllerMutex

mutableprivate

m_dataLoggerProtocol

std::shared_ptr<iv::comms::ICommunicationProtocol> iv::comms::api::ApiCommunicationController::m_dataLoggerProtocol

private

m_driver

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

protectedinherited

m_errorChannel

std::weak_ptr<iv::channels::AbstractChannel> iv::comms::ICommunicationController::m_errorChannel

protectedinherited

m_eventLoggerProtocol

std::shared_ptr<iv::comms::ICommunicationProtocol> iv::comms::api::ApiCommunicationController::m_eventLoggerProtocol

private

m_fallbackComm

std::weak_ptr<iv::comms::ICommunicationController> iv::comms::ICommunicationController::m_fallbackComm

protectedinherited

m_heartbeatChannel

std::weak_ptr<iv::channels::AbstractChannel> iv::comms::ICommunicationController::m_heartbeatChannel

protectedinherited

m_historyLoggerProtocol

std::shared_ptr<iv::comms::ICommunicationProtocol> iv::comms::api::ApiCommunicationController::m_historyLoggerProtocol

private

m_isEnabled

std::shared_ptr<bool> iv::comms::ICommunicationController::m_isEnabled

protectedinherited

m_networkId

iv::types::networkId iv::comms::ICommunicationController::m_networkId

protectedinherited

m_protocol

std::shared_ptr<iv::comms::ICommunicationProtocol> iv::comms::ICommunicationController::m_protocol

protectedinherited

---

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

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