Orocos Real-Time Toolkit  2.9.0
AtomicQueue.hpp
Go to the documentation of this file.
1 /***************************************************************************
2  tag: The SourceWorks Tue Sep 7 00:55:18 CEST 2010 AtomicQueue.hpp
3 
4  AtomicQueue.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_CORELIB_ATOMIC_QUEUE_HPP
40 #define ORO_CORELIB_ATOMIC_QUEUE_HPP
41 
42 namespace RTT
43 {
44  namespace internal {
45 
56  template<class T>
58  {
59  public:
60  typedef unsigned int size_type;
61 
62  virtual ~AtomicQueue() {}
63 
68  virtual bool isFull() const = 0;
69 
74  virtual bool isEmpty() const = 0;
75 
79  virtual size_type capacity() const = 0;
80 
86  virtual size_type size() const = 0;
87 
93  virtual bool enqueue(const T& value) = 0;
94 
100  virtual bool dequeue( T& result ) = 0;
101 
105  virtual const T front() const = 0;
106 
110  virtual void clear() = 0;
111  };
112 
113 }}
114 
115 #endif
An atomic, non-blocking single ended queue (FIFO) for storing a pointer to T.
Definition: AtomicQueue.hpp:57
virtual size_type capacity() const =0
Return the maximum number of items this queue can contain.
virtual void clear()=0
Clear all contents of the Queue and thus make it empty.
virtual bool isEmpty() const =0
Inspect if the Queue is empty.
virtual bool dequeue(T &result)=0
Dequeue an item.
virtual bool enqueue(const T &value)=0
Enqueue an item.
virtual const T front() const =0
Return the next to be read value.
virtual size_type size() const =0
Return the exact number of elements in the queue.
Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.
Definition: Activity.cpp:52
virtual bool isFull() const =0
Inspect if the Queue is full.