less debug logging by default
[deb_libcec.git] / src / lib / platform / util / buffer.h
CommitLineData
abbca718
LOK
1#pragma once
2/*
3 * This file is part of the libCEC(R) library.
4 *
b492c10e 5 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
abbca718
LOK
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
32 */
33
2b44051c 34#include "lib/platform/threads/mutex.h"
abbca718
LOK
35#include <queue>
36
f00ff009 37namespace PLATFORM
b9187cc6
LOK
38{
39 template<typename _BType>
f00ff009 40 struct SyncedBuffer
fac23b02 41 {
b9187cc6 42 public:
120d4ca8 43 SyncedBuffer(size_t iMaxSize = 100) :
a8559e01
LOK
44 m_maxSize(iMaxSize),
45 m_bHasMessages(false) {}
25701fa6 46
f00ff009 47 virtual ~SyncedBuffer(void)
25701fa6
LOK
48 {
49 Clear();
50 }
51
52 void Clear(void)
53 {
120d4ca8 54 CLockObject lock(m_mutex);
25701fa6
LOK
55 while (!m_buffer.empty())
56 m_buffer.pop();
aaff5cee 57 m_bHasMessages = true;
a8559e01 58 m_condition.Broadcast();
25701fa6 59 }
abbca718 60
120d4ca8
LOK
61 size_t Size(void)
62 {
63 CLockObject lock(m_mutex);
64 return m_buffer.size();
65 }
66
67 bool IsEmpty(void)
68 {
69 CLockObject lock(m_mutex);
70 return m_buffer.empty();
71 }
c49c485b 72
b9187cc6
LOK
73 bool Push(_BType entry)
74 {
f00ff009 75 CLockObject lock(m_mutex);
b9187cc6
LOK
76 if (m_buffer.size() == m_maxSize)
77 return false;
825ddb96 78
b9187cc6 79 m_buffer.push(entry);
a8559e01
LOK
80 m_bHasMessages = true;
81 m_condition.Signal();
b9187cc6
LOK
82 return true;
83 }
abbca718 84
a8559e01 85 bool Pop(_BType &entry, uint32_t iTimeoutMs = 0)
abbca718 86 {
b9187cc6 87 bool bReturn(false);
f00ff009 88 CLockObject lock(m_mutex);
a8559e01
LOK
89
90 // wait for a signal if the buffer is empty
91 if (m_buffer.empty() && iTimeoutMs > 0)
92 {
93 if (!m_condition.Wait(m_mutex, m_bHasMessages, iTimeoutMs))
94 return bReturn;
95 }
96
97 // pop the first item
aaff5cee 98 m_bHasMessages = !m_buffer.empty();
25701fa6 99 if (!m_buffer.empty())
b9187cc6
LOK
100 {
101 entry = m_buffer.front();
102 m_buffer.pop();
103 bReturn = true;
104 }
105 return bReturn;
abbca718 106 }
abbca718 107
a75e3a5a
LOK
108 bool Peek(_BType &entry)
109 {
110 bool bReturn(false);
111 CLockObject lock(m_mutex);
112 if (!m_buffer.empty())
113 {
114 entry = m_buffer.front();
115 bReturn = true;
116 }
117 return bReturn;
118 }
119
b9187cc6 120 private:
6f14b512 121 size_t m_maxSize;
b9187cc6
LOK
122 std::queue<_BType> m_buffer;
123 CMutex m_mutex;
a8559e01
LOK
124 CCondition<bool> m_condition;
125 bool m_bHasMessages;
b9187cc6
LOK
126 };
127};