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 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       {
  45         m_maxSize = iMaxSize;
  46       }
  47
  48       virtual ~SyncedBuffer(void)
  49       {
  50         CLockObject lock(m_mutex, true);
  51         Clear();
  52       }
  53
  54       void Clear(void)
  55       {
  56         while (!m_buffer.empty())
  57           m_buffer.pop();
  58       }
  59
  60       size_t Size(void) const { return m_buffer.size(); }
  61
  62       bool Push(_BType entry)
  63       {
  64         CLockObject lock(m_mutex);
  65         if (m_buffer.size() == m_maxSize)
  66           return false;
  67
  68         m_buffer.push(entry);
  69         return true;
  70       }
  71
  72       bool Pop(_BType &entry)
  73       {
  74         bool bReturn(false);
  75         CLockObject lock(m_mutex);
  76         if (!m_buffer.empty())
  77         {
  78           entry = m_buffer.front();
  79           m_buffer.pop();
  80           bReturn = true;
  81         }
  82         return bReturn;
  83       }
  84
  85     private:
  86       size_t             m_maxSize;
  87       std::queue<_BType> m_buffer;
  88       CMutex             m_mutex;
  89     };
  90 };