Orocos Real-Time Toolkit  2.9.0
ConnPolicy.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: Peter Soetens Thu Oct 22 11:59:08 CEST 2009 ConnPolicy.hpp
3 
4  ConnPolicy.hpp - description
5  -------------------
6  begin : Thu October 22 2009
7  copyright : (C) 2009 Peter Soetens
8  email : peter@thesourcworks.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_CONN_POLICY_HPP
40 #define ORO_CONN_POLICY_HPP
41 
42 #include <string>
43 #include <iosfwd>
44 #include "rtt-fwd.hpp"
45 #include "rtt-config.h"
46 #include "BufferPolicy.hpp"
47 
48 namespace RTT {
49 
108  {
109  public:
110  static const int UNBUFFERED = -1;
111  static const int DATA = 0;
112  static const int BUFFER = 1;
113  static const int CIRCULAR_BUFFER = 2;
114 
115  static const int UNSYNC = 0;
116  static const int LOCKED = 1;
117  static const int LOCK_FREE = 2;
118 
119  static const bool PUSH = false;
120  static const bool PULL = true;
121 
129  static ConnPolicy &Default();
130 
139  static ConnPolicy buffer(int size, int lock_policy = LOCK_FREE, bool init_connection = false, bool pull = false);
140 
149  static ConnPolicy circularBuffer(int size, int lock_policy = LOCK_FREE, bool init_connection = false, bool pull = false);
150 
158  static ConnPolicy data(int lock_policy = LOCK_FREE, bool init_connection = true, bool pull = false);
159 
164  ConnPolicy();
165 
175  explicit ConnPolicy(int type);
176 
187  explicit ConnPolicy(int type, int lock_policy);
188 
190  int type;
191 
193  int size;
194 
197 
203  bool init;
204 
209  bool pull;
210 
217 
225 
232  bool mandatory;
233 
239 
248  mutable int data_size;
249 
256  mutable std::string name_id;
257 
258  private:
259  struct ConnPolicyDefault;
260  ConnPolicy(const ConnPolicyDefault &);
261  };
262 
263  std::ostream &operator<<(std::ostream &os, const ConnPolicy &cp);
264 }
265 
266 #endif
267 
int data_size
Suggest the payload size of the data sent over this channel.
Definition: ConnPolicy.hpp:248
int lock_policy
This is the locking policy on the connection.
Definition: ConnPolicy.hpp:196
#define RTT_API
Definition: rtt-config.h:97
int type
DATA, BUFFER or CIRCULAR_BUFFER.
Definition: ConnPolicy.hpp:190
A connection policy object describes how a given connection should behave.
Definition: ConnPolicy.hpp:107
int size
If the connection is a buffered connection, the size of the buffer.
Definition: ConnPolicy.hpp:193
bool pull
If true, then the sink will have to pull data.
Definition: ConnPolicy.hpp:209
bool mandatory
Whether the connection described by this connection policy is mandatory, which means that write opera...
Definition: ConnPolicy.hpp:232
int max_threads
The maximum number of threads that will access the connection data or buffer object.
Definition: ConnPolicy.hpp:224
bool init
If true, one should initialize the connection&#39;s value with the last value written on the writer port...
Definition: ConnPolicy.hpp:203
std::ostream & operator<<(std::ostream &os, const BufferPolicy &bp)
int transport
The prefered transport used.
Definition: ConnPolicy.hpp:238
int buffer_policy
The policy on how buffer elements will be installed for this connection, which influences the behavio...
Definition: ConnPolicy.hpp:216
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
std::string name_id
The name of this connection.
Definition: ConnPolicy.hpp:256