src/lib/platform/util/buffer.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited.  All rights reserved.
   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
  34 #include "../threads/mutex.h"
  35 #include <queue>
  36
  37 namespace PLATFORM
  38 {
  39   template<typename _BType>
  40     struct SyncedBuffer
  41     {
  42     public:
  43       SyncedBuffer(size_t iMaxSize = 100) :
  44           m_maxSize(iMaxSize) {}
  45
  46       virtual ~SyncedBuffer(void)
  47       {
  48         Clear();
  49       }
  50
  51       void Clear(void)
  52       {
  53         CLockObject lock(m_mutex);
  54         while (!m_buffer.empty())
  55           m_buffer.pop();
  56       }
  57
  58       size_t Size(void)
  59       {
  60         CLockObject lock(m_mutex);
  61         return m_buffer.size();
  62       }
  63
  64       bool IsEmpty(void)
  65       {
  66         CLockObject lock(m_mutex);
  67         return m_buffer.empty();
  68       }
  69
  70       bool Push(_BType entry)
  71       {
  72         CLockObject lock(m_mutex);
  73         if (m_buffer.size() == m_maxSize)
  74           return false;
  75
  76         m_buffer.push(entry);
  77         return true;
  78       }
  79
  80       bool Pop(_BType &entry)
  81       {
  82         bool bReturn(false);
  83         CLockObject lock(m_mutex);
  84         if (!m_buffer.empty())
  85         {
  86           entry = m_buffer.front();
  87           m_buffer.pop();
  88           bReturn = true;
  89         }
  90         return bReturn;
  91       }
  92
  93       bool Peek(_BType &entry)
  94       {
  95         bool bReturn(false);
  96         CLockObject lock(m_mutex);
  97         if (!m_buffer.empty())
  98         {
  99           entry = m_buffer.front();
 100           bReturn = true;
 101         }
 102         return bReturn;
 103       }
 104
 105     private:
 106       size_t             m_maxSize;
 107       std::queue<_BType> m_buffer;
 108       CMutex             m_mutex;
 109     };
 110 };