simple_comms_fault_handler.h
Go to the documentation of this file.
1 /*
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2011, Southwest Research Institute
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * * Neither the name of the Southwest Research Institute, nor the names
16 * of its contributors may be used to endorse or promote products derived
17 * from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31 
32 #ifndef DEFAULT_COMMS_FAULT_HANDLER_H
33 #define DEFAULT_COMMS_FAULT_HANDLER_H
34 
35 #ifndef FLATHEADERS
39 #else
40 #include "comms_fault_handler.h"
41 #include "smpl_msg_connection.h"
42 #include "log_wrapper.h"
43 #endif
44 
45 namespace industrial
46 {
47 namespace simple_comms_fault_handler
48 {
49 
58 
59 {
60 public:
61 
67 
81 
82 
87  void sendFailCB() {LOG_WARN("Send failure, no callback support");};
88 
93  void receiveFailCB() {LOG_WARN("Receive failure, no callback support");};
94 
100  void connectionFailCB();
101 
102 private:
103 
104 
109 
116  {
117  this->connection_ = connection;
118  }
119  ;
120 
127  {
128  return this->connection_;
129  }
130 };
131 
132 } //namespace default_comms_fault_handler
133 } //namespace industrial
134 
135 #endif /* DEFAULT_COMMS_FAULT_HANDLER_H */
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::connection_
industrial::smpl_msg_connection::SmplMsgConnection * connection_
Reference to reply connection (called if incoming message requires a reply)
Definition: simple_comms_fault_handler.h:108
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::sendFailCB
void sendFailCB()
Send failure callback method: Nothing is performed.
Definition: simple_comms_fault_handler.h:87
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::connectionFailCB
void connectionFailCB()
Connection failure callback method: On a connection failure a blocking reconnection is attempted.
Definition: simple_comms_fault_handler.cpp:73
LOG_WARN
#define LOG_WARN(format,...)
Definition: log_wrapper.h:133
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::init
bool init(industrial::smpl_msg_connection::SmplMsgConnection *connection)
Initializes default communications fault handler.
Definition: simple_comms_fault_handler.cpp:55
industrial
Definition: byte_array.h:45
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::~SimpleCommsFaultHandler
~SimpleCommsFaultHandler()
Destructor.
Definition: simple_comms_fault_handler.cpp:51
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::setConnection
void setConnection(industrial::smpl_msg_connection::SmplMsgConnection *connection)
Sets connection manager.
Definition: simple_comms_fault_handler.h:115
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::getConnection
industrial::smpl_msg_connection::SmplMsgConnection * getConnection()
Gets connection for manager.
Definition: simple_comms_fault_handler.h:126
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler
Default implementation of comms fault handler. This class attempts to reconnect if the connection is ...
Definition: simple_comms_fault_handler.h:57
log_wrapper.h
industrial::smpl_msg_connection::SmplMsgConnection
Defines an interface and common methods for sending simple messages (see simple_message)....
Definition: smpl_msg_connection.h:61
comms_fault_handler.h
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::receiveFailCB
void receiveFailCB()
Receive failure callback method: Nothing is performed.
Definition: simple_comms_fault_handler.h:93
industrial::comms_fault_handler::CommsFaultHandler
Interface definition for communications fault handler. Defines the type of communcations faults that ...
Definition: comms_fault_handler.h:46
industrial::simple_comms_fault_handler::SimpleCommsFaultHandler::SimpleCommsFaultHandler
SimpleCommsFaultHandler()
Default constructor.
Definition: simple_comms_fault_handler.cpp:45
smpl_msg_connection.h


simple_message
Author(s): Shaun Edwards
autogenerated on Wed Mar 2 2022 00:24:53