Orocos Real-Time Toolkit  2.9.0
MQSendRecv.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: The SourceWorks Tue Sep 7 00:55:18 CEST 2010 MQSendRecv.hpp
3 
4  MQSendRecv.hpp - description
5  -------------------
6  begin : Tue September 07 2010
7  copyright : (C) 2010 The SourceWorks
8  email : peter@thesourceworks.com
9 
10  ***************************************************************************
11  * This library is free software; you can redistribute it and/or *
12  * modify it under the terms of the GNU General Public *
13  * License as published by the Free Software Foundation; *
14  * version 2 of the License. *
15  * *
16  * As a special exception, you may use this file as part of a free *
17  * software library without restriction. Specifically, if other files *
18  * instantiate templates or use macros or inline functions from this *
19  * file, or you compile this file and link it with other files to *
20  * produce an executable, this file does not by itself cause the *
21  * resulting executable to be covered by the GNU General Public *
22  * License. This exception does not however invalidate any other *
23  * reasons why the executable file might be covered by the GNU General *
24  * Public License. *
25  * *
26  * This library is distributed in the hope that it will be useful, *
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
29  * Lesser General Public License for more details. *
30  * *
31  * You should have received a copy of the GNU General Public *
32  * License along with this library; if not, write to the Free Software *
33  * Foundation, Inc., 59 Temple Place, *
34  * Suite 330, Boston, MA 02111-1307 USA *
35  * *
36  ***************************************************************************/
37 
38 
39 #ifndef ORO_MQSENDER_HPP_
40 #define ORO_MQSENDER_HPP_
41 
42 #include <mqueue.h>
43 #include "../../rtt-fwd.hpp"
44 #include "../../base/DataSourceBase.hpp"
45 
46 namespace RTT
47 {
48  namespace mqueue
49  {
54  class MQSendRecv
55  {
56  protected:
71  mqd_t mqdes;
79  char* buf;
83  bool mis_sender;
87  bool minit_done;
91  int max_size;
96  std::string mqname;
103 
104  public:
109  MQSendRecv(types::TypeMarshaller const& transport);
110 
111  void setupStream(base::DataSourceBase::shared_ptr ds, base::PortInterface* port, ConnPolicy const& policy, bool is_sender);
112 
113  ~MQSendRecv();
114 
115  void cleanupStream();
116 
123 
130 
137 
145  };
146  }
147 }
148 
149 #endif /* ORO_MQSENDER_HPP_ */
Implements the sending/receiving of mqueue messages.
Definition: MQSendRecv.hpp:54
types::TypeMarshaller const & mtransport
Transport marshaller used for size calculations and data updates.
Definition: MQSendRecv.hpp:61
virtual void mqNewSample(base::DataSourceBase::shared_ptr ds)
Adapts the mq send/receive buffer size according to the data in mqdata_source, or the value set in md...
Definition: MQSendRecv.cpp:188
bool mqRead(base::DataSourceBase::shared_ptr ds)
Read from the message queue.
Definition: MQSendRecv.cpp:246
void * marshaller_cookie
A private blob that is returned by mtransport.getCookie().
Definition: MQSendRecv.hpp:67
bool mis_sender
True if this object is a sender.
Definition: MQSendRecv.hpp:83
void setupStream(base::DataSourceBase::shared_ptr ds, base::PortInterface *port, ConnPolicy const &policy, bool is_sender)
Definition: MQSendRecv.cpp:69
std::string mqname
The name of the queue, as specified in the ConnPolicy when creating the stream, or self-calculated wh...
Definition: MQSendRecv.hpp:96
int max_size
The size of buf.
Definition: MQSendRecv.hpp:91
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:107
bool mqWrite(base::DataSourceBase::shared_ptr ds)
Write to the message queue.
Definition: MQSendRecv.cpp:271
virtual bool mqReady(base::DataSourceBase::shared_ptr ds, base::ChannelElementBase *chan)
Works only in receive mode, waits for a new sample and adapts the receive buffer to match it&#39;s size...
Definition: MQSendRecv.cpp:198
Objects implementing this interface have the capability to convert data sources to and from a binary ...
int mdata_size
The size of the data, as specified in the ConnPolicy when creating the stream, or calculated using th...
Definition: MQSendRecv.hpp:102
char * buf
Send/Receive buffer.
Definition: MQSendRecv.hpp:79
bool minit_done
True if setupStream() was called, false after cleanupStream().
Definition: MQSendRecv.hpp:87
MQSendRecv(types::TypeMarshaller const &transport)
Create a channel element for remote data exchange.
Definition: MQSendRecv.cpp:64
boost::intrusive_ptr< DataSourceBase > shared_ptr
Use this type to store a pointer to a DataSourceBase.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
In the data flow implementation, a channel is created by chaining ChannelElementBase objects...
The base class of every data flow port.
mqd_t mqdes
MQueue file descriptor.
Definition: MQSendRecv.hpp:71