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:

[legend]

List of all members.

Public Member Functions
void	connectionFailCB ()
	Connection failure callback method: On a connection failure a blocking reconnection is attempted.
bool	init (industrial::smpl_msg_connection::SmplMsgConnection *connection)
	Initializes default communications fault handler.
void	receiveFailCB ()
	Receive failure callback method: Nothing is performed.
void	sendFailCB ()
	Send failure callback method: Nothing is performed.
	SimpleCommsFaultHandler ()
	Default constructor.
	~SimpleCommsFaultHandler ()
	Destructor.
Private Member Functions
industrial::smpl_msg_connection::SmplMsgConnection *	getConnection ()
	Gets connection for manager.
void	setConnection (industrial::smpl_msg_connection::SmplMsgConnection *connection)
	Sets connection manager.
Private Attributes
industrial::smpl_msg_connection::SmplMsgConnection *	connection_
	Reference to reply connection (called if incoming message requires a reply).

---

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 64 of file simple_comms_fault_handler.h.

---

Constructor & Destructor Documentation

industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::SimpleCommsFaultHandler

(

)

Default constructor.

Definition at line 48 of file simple_comms_fault_handler.cpp.

industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::~SimpleCommsFaultHandler

(

)

Destructor.

Definition at line 54 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 76 of file simple_comms_fault_handler.cpp.

industrial::smpl_msg_connection::SmplMsgConnection* industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::getConnection

(

)

[inline, private]

Gets connection for manager.

Returns:

connection reference

Definition at line 133 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:

message

connection to use for reconnecting

Returns:

true on success, false otherwise

Definition at line 58 of file simple_comms_fault_handler.cpp.

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::receiveFailCB

(

)

[inline, virtual]

Receive failure callback method: Nothing is performed.

Implements industrial::comms_fault_handler::CommsFaultHandler.

Definition at line 100 of file simple_comms_fault_handler.h.

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::sendFailCB

(

)

[inline, virtual]

Send failure callback method: Nothing is performed.

Implements industrial::comms_fault_handler::CommsFaultHandler.

Definition at line 94 of file simple_comms_fault_handler.h.

void industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::setConnection

(

industrial::smpl_msg_connection::SmplMsgConnection *

connection

)

[inline, private]

Sets connection manager.

Parameters:

connection

connection reference

Definition at line 122 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 115 of file simple_comms_fault_handler.h.

---

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

• simple_comms_fault_handler.h
• simple_comms_fault_handler.cpp