replymonitor.h
Go to the documentation of this file.
1 
2 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification,
6 // are permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice,
9 // this list of conditions, and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice,
12 // this list of conditions, and the following disclaimer in the documentation
13 // and/or other materials provided with the distribution.
14 //
15 // 3. Neither the names of the copyright holders nor the names of their contributors
16 // may be used to endorse or promote products derived from this software without
17 // specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
24 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
26 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
28 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
29 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
30 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
31 //
32 
33 
34 // Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
35 // All rights reserved.
36 //
37 // Redistribution and use in source and binary forms, with or without modification,
38 // are permitted provided that the following conditions are met:
39 //
40 // 1. Redistributions of source code must retain the above copyright notice,
41 // this list of conditions, and the following disclaimer.
42 //
43 // 2. Redistributions in binary form must reproduce the above copyright notice,
44 // this list of conditions, and the following disclaimer in the documentation
45 // and/or other materials provided with the distribution.
46 //
47 // 3. Neither the names of the copyright holders nor the names of their contributors
48 // may be used to endorse or promote products derived from this software without
49 // specific prior written permission.
50 //
51 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
52 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
53 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
54 // THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 // SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
56 // OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
58 // TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS
60 // SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES
61 // OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE
62 // ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
63 //
64 
65 #ifndef REPLYMONITOR_H
66 #define REPLYMONITOR_H
67 
68 #include <xscommon/xsens_mutex.h>
69 #include <xscommon/journaller.h>
70 #include <vector>
71 
72 #include <memory>
73 
74 struct XsMessage;
75 class ReplyObject;
76 
77 namespace xsens
78 {
79 
84 {
85 public:
87  virtual void removeObject(ReplyObject* obj) = 0;
88  virtual ~ReplyObjectRemover() {}
89 };
90 
92 {
93 public:
94  ReplyMonitor();
95  virtual ~ReplyMonitor();
96 
97  std::shared_ptr<ReplyObject> addReplyObject(ReplyObject* replyObject); // Posts the semaphore
98  bool addReply(const XsMessage& message);
99  void removeObject(std::shared_ptr<ReplyObject> const& obj);
100  void dumpObjectList(Journaller* journal, JournalLogLevel level) const;
101 
102 private:
103  void removeObject(ReplyObject* obj);
104 
105  std::vector<ReplyObject*> m_objectList;
106  mutable Mutex m_mutex;
107 };
108 } // namespace xsens
109 
110 #endif
ReplyObject
Abstract reply object. Blocks on a semaphore when requesting the message until the message has been s...
Definition: replyobject.h:81
xsens::ReplyMonitor::addReplyObject
std::shared_ptr< ReplyObject > addReplyObject(ReplyObject *replyObject)
Add a reply object to the reply monitor.
Definition: replymonitor.cpp:115
JournalLogLevel
JournalLogLevel
Definition: journalloglevel.h:88
xsens::ReplyMonitor
A monitor class for receiving replies messages in a thread.
Definition: replymonitor.h:91
xsens::ReplyMonitor::ReplyMonitor
ReplyMonitor()
Default constructor.
Definition: replymonitor.cpp:103
xsens::ReplyMonitor::~ReplyMonitor
virtual ~ReplyMonitor()
Definition: replymonitor.cpp:107
xsens::ReplyMonitor::addReply
bool addReply(const XsMessage &message)
Put a reply in the monitor.
Definition: replymonitor.cpp:152
xsens::ReplyMonitor::m_objectList
std::vector< ReplyObject * > m_objectList
Definition: replymonitor.h:105
xsens_mutex.h
journaller.h
Journaller
A journalling class for debugging applications.
Definition: journaller.h:79
xsens::Mutex
A base mutex class.
Definition: xsens_mutex.h:132
XsMessage
Structure for storing a single message.
Definition: xsmessage.h:202
xsens::ReplyObjectRemover
A class that removes a reply object from the given monitor.
Definition: replymonitor.h:83
xsens::ReplyMonitor::dumpObjectList
void dumpObjectList(Journaller *journal, JournalLogLevel level) const
Dumps the current list of objects to wait for to the supplied journaller.
Definition: replymonitor.cpp:171
xsens::ReplyObjectRemover::removeObject
virtual void removeObject(ReplyObject *obj)=0
Remove an object from the list.
xsens::ReplyObjectRemover::~ReplyObjectRemover
virtual ~ReplyObjectRemover()
Definition: replymonitor.h:88
xsens::ReplyMonitor::removeObject
void removeObject(std::shared_ptr< ReplyObject > const &obj)
Remove an object from the list.
Definition: replymonitor.cpp:126
xsens
Definition: threading.cpp:78
xsens::ReplyMonitor::m_mutex
Mutex m_mutex
Definition: replymonitor.h:106


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:20