Public Member Functions | List of all members
industrial::comms_fault_handler::CommsFaultHandler Class Referenceabstract

Interface definition for communications fault handler. Defines the type of communcations faults that can be handled and the function callbacks that should be executed under the specific fault conditions. More...

#include <comms_fault_handler.h>

Inheritance diagram for industrial::comms_fault_handler::CommsFaultHandler:
Inheritance graph
[legend]

Public Member Functions

virtual void connectionFailCB ()=0
 Connection failure callback method. This method will be exectured in the event that a comms connection is lost. More...
 
virtual void receiveFailCB ()=0
 Receive failure callback method. This method will be executed in the event that a comms receive fails. More...
 
virtual void sendFailCB ()=0
 Send failure callback method. This method will be executed in the event that a comms send fails. More...
 

Detailed Description

Interface definition for communications fault handler. Defines the type of communcations faults that can be handled and the function callbacks that should be executed under the specific fault conditions.

Definition at line 46 of file comms_fault_handler.h.

Member Function Documentation

◆ connectionFailCB()

virtual void industrial::comms_fault_handler::CommsFaultHandler::connectionFailCB ( )
pure virtual

Connection failure callback method. This method will be exectured in the event that a comms connection is lost.

Implemented in industrial::simple_comms_fault_handler::SimpleCommsFaultHandler.

◆ receiveFailCB()

virtual void industrial::comms_fault_handler::CommsFaultHandler::receiveFailCB ( )
pure virtual

Receive failure callback method. This method will be executed in the event that a comms receive fails.

Implemented in industrial::simple_comms_fault_handler::SimpleCommsFaultHandler.

◆ sendFailCB()

virtual void industrial::comms_fault_handler::CommsFaultHandler::sendFailCB ( )
pure virtual

Send failure callback method. This method will be executed in the event that a comms send fails.

Implemented in industrial::simple_comms_fault_handler::SimpleCommsFaultHandler.


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


simple_message
Author(s): Shaun Edwards
autogenerated on Mon Feb 28 2022 22:34:36