test/stress/queue/std_queue.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSUNIT_QUEUE_STD_QUEUE_H
  32 #define CDSUNIT_QUEUE_STD_QUEUE_H
  33
  34 #include <mutex>    //unique_lock
  35 #include <queue>
  36 #include <list>
  37 #include <cds/sync/spinlock.h>
  38
  39 namespace queue {
  40
  41     template <typename T, class Container, class Lock = cds::sync::spin >
  42     class StdQueue: public std::queue<T, Container >
  43     {
  44         typedef std::queue<T, Container >   base_class;
  45         mutable Lock m_Locker;
  46
  47     public:
  48         bool enqueue( const T& data )
  49         {
  50             std::unique_lock<Lock> a(m_Locker);
  51
  52             base_class::push( data );
  53             return true;
  54         }
  55
  56         bool push( const T& data )
  57         {
  58             return enqueue( data );
  59         }
  60
  61         bool dequeue( T& data )
  62         {
  63             std::unique_lock<Lock> a(m_Locker);
  64             if ( base_class::empty())
  65                 return false;
  66
  67             data = base_class::front();
  68             base_class::pop();
  69             return true;
  70         }
  71
  72         bool pop( T& data )
  73         {
  74             return dequeue( data );
  75         }
  76
  77         bool empty() const
  78         {
  79             std::unique_lock<Lock> a( m_Locker );
  80             return base_class::empty();
  81         }
  82
  83         size_t size() const
  84         {
  85             std::unique_lock<Lock> a( m_Locker );
  86             return base_class::size();
  87         }
  88
  89         cds::opt::none statistics() const
  90         {
  91             return cds::opt::none();
  92         }
  93     };
  94
  95     template <typename T, class Lock = cds::sync::spin >
  96     using StdQueue_deque = StdQueue<T, std::deque<T>, Lock >;
  97
  98     template <typename T, class Lock = cds::sync::spin >
  99     using StdQueue_list = StdQueue<T, std::list<T>, Lock >;
 100 }
 101
 102 #endif // #ifndef CDSUNIT_QUEUE_STD_QUEUE_H