Gamedev Framework (gf)  0.3.0
A C++11 framework for 2D games
Queue.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_QUEUE_H
22 #define GF_QUEUE_H
23 
24 #include <condition_variable>
25 #include <deque>
26 #include <mutex>
27 
28 #include "Portability.h"
29 
30 namespace gf {
31 #ifndef DOXYGEN_SHOULD_SKIP_THIS
32 inline namespace v1 {
33 #endif
34 
35  /**
36  * @ingroup core
37  * @brief A simple concurrent queue
38  *
39  * This is a simple concurrent queue that can be used in a multi-threaded
40  * application. For example, it can be used between a thread that receives
41  * messages from the network and the main loop that handles the messages.
42  */
43  template<typename T>
44  class GF_API Queue {
45  public:
46  /**
47  * @brief Poll a value from the queue, if possible
48  *
49  * @param value A reference for the result
50  * @return True if a value was poped from the queue
51  */
52  bool poll(T& value) {
53  std::unique_lock<std::mutex> lock(m_mutex);
54 
55  if (m_queue.empty()) {
56  return false;
57  }
58 
59  value = m_queue.front();
60  m_queue.pop_front();
61  return true;
62  }
63 
64  /**
65  * @brief Push a value on the queue
66  *
67  * @param value The value to push on the queue
68  */
69  void push(const T& value) {
70  std::unique_lock<std::mutex> lock(m_mutex);
71  m_queue.push_back(value);
72  }
73 
74  /**
75  * @brief Clear the queue
76  */
77  void clear() {
78  std::unique_lock<std::mutex> lock(m_mutex);
79  m_queue.clear();
80  }
81 
82  private:
83  std::mutex m_mutex;
84  std::deque<T> m_queue;
85  };
86 
87 #ifndef DOXYGEN_SHOULD_SKIP_THIS
88 }
89 #endif
90 }
91 
92 #endif // GF_QUEUE_H
void push(const T &value)
Push a value on the queue.
Definition: Queue.h:69
A simple concurrent queue.
Definition: Queue.h:44
bool poll(T &value)
Poll a value from the queue, if possible.
Definition: Queue.h:52
Definition: Action.h:34
void clear()
Clear the queue.
Definition: Queue.h:77
#define GF_API
Definition: Portability.h:35