Public Member Functions | Private Member Functions | Private Attributes | List of all members
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler Class Reference

Default implementation of comms fault handler. This class attempts to reconnect if the connection is lost. More...

#include <simple_comms_fault_handler.h>

Inheritance diagram for industrial::simple_comms_fault_handler::SimpleCommsFaultHandler:
Inheritance graph
[legend]

Public Member Functions

void connectionFailCB ()
 Connection failure callback method: On a connection failure a blocking reconnection is attempted. More...
 
bool init (industrial::smpl_msg_connection::SmplMsgConnection *connection)
 Initializes default communications fault handler. More...
 
void receiveFailCB ()
 Receive failure callback method: Nothing is performed. More...
 
void sendFailCB ()
 Send failure callback method: Nothing is performed. More...
 
 SimpleCommsFaultHandler ()
 Default constructor. More...
 
 ~SimpleCommsFaultHandler ()
 Destructor. More...
 

Private Member Functions

industrial::smpl_msg_connection::SmplMsgConnectiongetConnection ()
 Gets connection for manager. More...
 
void setConnection (industrial::smpl_msg_connection::SmplMsgConnection *connection)
 Sets connection manager. More...
 

Private Attributes

industrial::smpl_msg_connection::SmplMsgConnectionconnection_
 Reference to reply connection (called if incoming message requires a reply) More...
 

Detailed Description

Default implementation of comms fault handler. This class attempts to reconnect if the connection is lost.

THIS CLASS IS NOT THREAD-SAFE

Definition at line 57 of file simple_comms_fault_handler.h.

Constructor & Destructor Documentation

industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::SimpleCommsFaultHandler ( )

Default constructor.

Definition at line 45 of file simple_comms_fault_handler.cpp.

industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::~SimpleCommsFaultHandler ( )

Destructor.

Definition at line 51 of file simple_comms_fault_handler.cpp.

Member Function Documentation

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::connectionFailCB ( )
virtual

Connection failure callback method: On a connection failure a blocking reconnection is attempted.

Implements industrial::comms_fault_handler::CommsFaultHandler.

Definition at line 73 of file simple_comms_fault_handler.cpp.

industrial::smpl_msg_connection::SmplMsgConnection* industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::getConnection ( )
inlineprivate

Gets connection for manager.

Returns
connection reference

Definition at line 126 of file simple_comms_fault_handler.h.

bool industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::init ( industrial::smpl_msg_connection::SmplMsgConnection connection)

Initializes default communications fault handler.

Parameters
messageconnection to use for reconnecting
Returns
true on success, false otherwise

Definition at line 55 of file simple_comms_fault_handler.cpp.

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::receiveFailCB ( )
inlinevirtual

Receive failure callback method: Nothing is performed.

Implements industrial::comms_fault_handler::CommsFaultHandler.

Definition at line 93 of file simple_comms_fault_handler.h.

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::sendFailCB ( )
inlinevirtual

Send failure callback method: Nothing is performed.

Implements industrial::comms_fault_handler::CommsFaultHandler.

Definition at line 87 of file simple_comms_fault_handler.h.

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::setConnection ( industrial::smpl_msg_connection::SmplMsgConnection connection)
inlineprivate

Sets connection manager.

Parameters
connectionconnection reference

Definition at line 115 of file simple_comms_fault_handler.h.

Member Data Documentation

industrial::smpl_msg_connection::SmplMsgConnection* industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::connection_
private

Reference to reply connection (called if incoming message requires a reply)

Definition at line 108 of file simple_comms_fault_handler.h.


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


simple_message
Author(s): Shaun Edwards
autogenerated on Sat Sep 21 2019 03:30:09