iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SynchroQueue.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_CORE_DESIGN_SYNCHROQUEUE_H
37 #define INCLUDE_NRT_CORE_DESIGN_SYNCHROQUEUE_H
38 
40 #include <queue>
41 
42 namespace nrt
43 {
44  //! SynchroQueue is a thread-safe synchronized producer/consumer queue.
45  /*! SynchroQueue is designed for use in producer/consumer scenarios where multiple threads wish to push and pop data
46  onto/from the queue asynchronously. Threads that try to pop data when the queue is empty will sleep until data
47  is actually available.
48  \ingroup design */
49  template <class T>
51  {
52  public:
53  //! Create a new SynchroQueue with no data
54  SynchroQueue();
55 
56  //! Push a new data element onto the queue
57  void push(T const & val);
58 
59  //! Pop a data element off of the queue, potentially sleeping until one is available
60  T pop();
61 
62  //! Get the number of elements in the queue
63  size_t const size();
64 
65  private:
66  std::queue<T> itsQueue;
67  nrt::Semaphore itsSemaphore;
68  std::mutex itsMutex;
69  };
70 } // namespace nrt
71 
73 
74 #endif // INCLUDE_NRT_CORE_DESIGN_SYNCHROQUEUE_H
75