message_manager.h
Go to the documentation of this file.
00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  * Copyright (c) 2011, Southwest Research Institute
00005  * All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions are met:
00009  *
00010  *       * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *       * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *       * Neither the name of the Southwest Research Institute, nor the names
00016  *       of its contributors may be used to endorse or promote products derived
00017  *       from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029  * POSSIBILITY OF SUCH DAMAGE.
00030  */
00031 
00032 #ifndef MESSAGE_MANAGER_H
00033 #define MESSAGE_MANAGER_H
00034 
00035 #ifndef FLATHEADERS
00036 #include "simple_message/smpl_msg_connection.h"
00037 #include "simple_message/message_handler.h"
00038 #include "simple_message/ping_handler.h"
00039 #include "simple_message/comms_fault_handler.h"
00040 #include "simple_message/simple_comms_fault_handler.h"
00041 #else
00042 #include "smpl_msg_connection.h"
00043 #include "message_handler.h"
00044 #include "ping_handler.h"
00045 #include "comms_fault_handler.h"
00046 #include "simple_comms_fault_handler.h"
00047 #endif
00048 
00049 
00050 namespace industrial
00051 {
00052 namespace message_manager
00053 {
00054 
00058 //* MessageManager
00074 class MessageManager
00075 {
00076 
00077 public:
00078 
00082   MessageManager();
00083 
00087   ~MessageManager();
00088 
00098   bool init(industrial::smpl_msg_connection::SmplMsgConnection* connection);
00099 
00112   bool init(industrial::smpl_msg_connection::SmplMsgConnection* connection,
00113             industrial::comms_fault_handler::CommsFaultHandler* fault_handler);
00114 
00119   void spinOnce();
00120 
00124   void spin();
00125 
00134   bool add(industrial::message_handler::MessageHandler* handler, bool allow_replace = false);
00135 
00141   unsigned int getNumHandlers()
00142   {
00143     return this->num_handlers_;
00144   }
00145 
00151   unsigned int getMaxNumHandlers()
00152   {
00153     return this->MAX_NUM_HANDLERS;
00154   }
00155 
00156 
00162   industrial::comms_fault_handler::CommsFaultHandler* getCommsFaultHandler()
00163   {
00164     return this->comms_hndlr_;
00165   }
00166 
00172   void setCommsFaultHandler(industrial::comms_fault_handler::CommsFaultHandler* handler)
00173   {
00174     this->comms_hndlr_ = handler;
00175   }
00176 
00177 
00178 private:
00179 
00186   static const unsigned int MAX_NUM_HANDLERS = 64;
00187 
00191   industrial::message_handler::MessageHandler* handlers_[MAX_NUM_HANDLERS];
00192 
00196   industrial::smpl_msg_connection::SmplMsgConnection* connection_;
00197 
00201   industrial::ping_handler::PingHandler ping_hndlr_;
00202 
00207   industrial::simple_comms_fault_handler::SimpleCommsFaultHandler def_comms_hndlr_;
00208 
00212   industrial::comms_fault_handler::CommsFaultHandler* comms_hndlr_;
00213 
00217   unsigned int num_handlers_;
00218 
00226   industrial::message_handler::MessageHandler* getHandler(int msg_type);
00227 
00235   int getHandlerIdx(int msg_type);
00236 
00242   industrial::simple_comms_fault_handler::SimpleCommsFaultHandler& getDefaultCommsFaultHandler()
00243   {
00244     return this->def_comms_hndlr_;
00245   }
00251   industrial::ping_handler::PingHandler& getPingHandler()
00252   {
00253     return this->ping_hndlr_;
00254   }
00255   ;
00256 
00262   void setConnection(industrial::smpl_msg_connection::SmplMsgConnection* connection)
00263   {
00264     this->connection_ = connection;
00265   }
00266   ;
00267 
00273   industrial::smpl_msg_connection::SmplMsgConnection* getConnection()
00274   {
00275     return this->connection_;
00276   }
00277   ;
00278 
00284   void setNumHandlers(unsigned int num_handlers)
00285   {
00286     this->num_handlers_ = num_handlers;
00287   }
00288   ;
00289 
00290 };
00291 
00292 } // namespace industrial
00293 } // namespace message_manager
00294 
00295 #endif //MESSAGE_MANAGER


simple_message
Author(s): Shaun Edwards
autogenerated on Sat Jun 8 2019 20:43:23