Home | History | Annotate | Download | only in base
      1 /*
      2  *  Copyright 2015 The WebRTC Project Authors. All rights reserved.
      3  *
      4  *  Use of this source code is governed by a BSD-style license
      5  *  that can be found in the LICENSE file in the root of the source
      6  *  tree. An additional intellectual property rights grant can be found
      7  *  in the file PATENTS.  All contributing project authors may
      8  *  be found in the AUTHORS file in the root of the source tree.
      9  */
     10 
     11 #ifndef WEBRTC_BASE_BUFFERQUEUE_H_
     12 #define WEBRTC_BASE_BUFFERQUEUE_H_
     13 
     14 #include <deque>
     15 #include <vector>
     16 
     17 #include "webrtc/base/buffer.h"
     18 #include "webrtc/base/criticalsection.h"
     19 
     20 namespace rtc {
     21 
     22 class BufferQueue {
     23  public:
     24   // Creates a buffer queue with a given capacity and default buffer size.
     25   BufferQueue(size_t capacity, size_t default_size);
     26   virtual ~BufferQueue();
     27 
     28   // Return number of queued buffers.
     29   size_t size() const;
     30 
     31   // ReadFront will only read one buffer at a time and will truncate buffers
     32   // that don't fit in the passed memory.
     33   // Returns true unless no data could be returned.
     34   bool ReadFront(void* data, size_t bytes, size_t* bytes_read);
     35 
     36   // WriteBack always writes either the complete memory or nothing.
     37   // Returns true unless no data could be written.
     38   bool WriteBack(const void* data, size_t bytes, size_t* bytes_written);
     39 
     40  protected:
     41   // These methods are called when the state of the queue changes.
     42   virtual void NotifyReadableForTest() {}
     43   virtual void NotifyWritableForTest() {}
     44 
     45  private:
     46   size_t capacity_;
     47   size_t default_size_;
     48   mutable CriticalSection crit_;
     49   std::deque<Buffer*> queue_ GUARDED_BY(crit_);
     50   std::vector<Buffer*> free_list_ GUARDED_BY(crit_);
     51 
     52   RTC_DISALLOW_COPY_AND_ASSIGN(BufferQueue);
     53 };
     54 
     55 }  // namespace rtc
     56 
     57 #endif  // WEBRTC_BASE_BUFFERQUEUE_H_
     58