MIRA
ServiceInterfaceHandler.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_SERVICEINTERFACEHANDLER_H_
48 #define _MIRA_SERVICEINTERFACEHANDLER_H_
49 
50 #include <queue>
51 #include <fw/FrameworkExports.h>
52 
53 #include <fw/DispatcherThread.h>
54 
56 
57 namespace mira {
58 
60 
69  public DiagnosticRunnable
70 {
71 public:
72 
73  typedef boost::function<void (const std::string&, const std::string&)> Callback;
74 
76  DiagnosticRunnable(module), mDispatcher(dispatcher) {}
77 
79  virtual void newServiceInterface(const std::string& interface,
80  const std::string& service);
81 
83  virtual void run(DispatcherThread* dispatcher);
84 
85  void registerCallback(const std::string& interface, Callback cb);
86 
87 private:
88 
89  DispatcherThread* mDispatcher;
90  boost::mutex mMutex;
91  std::queue<std::pair<std::string, std::string>> mNewServiceQueue;
92  std::multimap<std::string, Callback> mCallbacks;
93 };
94 
95 typedef boost::shared_ptr<ServiceInterfaceHandler> ServiceInterfaceHandlerPtr;
96 
98 
99 } // namespace
100 
101 #endif
Abstract interface for handler(s) that get called upon new services with a special interface get avai...
boost::function< void(const std::string &, const std::string &)> Callback
Definition: ServiceInterfaceHandler.h:73
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
Framework export macro declaration.
Dispatcher class that allows registration of handler functions that need to be called from within the...
#define MIRA_FRAMEWORK_EXPORT
Definition: FrameworkExports.h:61
boost::shared_ptr< ServiceInterfaceHandler > ServiceInterfaceHandlerPtr
Definition: ServiceInterfaceHandler.h:95
Definition: Runnable.h:91
Class that can be used whenever you want to have ONE thread where several handlers are assigned to...
Definition: DispatcherThread.h:131
ServiceInterfaceHandler implements a AbstractInterfaceCallbackHandler.
Definition: ServiceInterfaceHandler.h:67
Abstract interface for derived handler(s).
Definition: AbstractInterfaceCallbackHandler.h:62
Base class for modules that want to use diagnostics and set the current status.
Definition: Status.h:138
ServiceInterfaceHandler(DispatcherThread *dispatcher, DiagnosticsModulePtr module=NULL)
Definition: ServiceInterfaceHandler.h:75