summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/rtc_base/buffer_queue.h
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/libwebrtc/rtc_base/buffer_queue.h')
-rw-r--r--third_party/libwebrtc/rtc_base/buffer_queue.h70
1 files changed, 70 insertions, 0 deletions
diff --git a/third_party/libwebrtc/rtc_base/buffer_queue.h b/third_party/libwebrtc/rtc_base/buffer_queue.h
new file mode 100644
index 0000000000..b018e160a1
--- /dev/null
+++ b/third_party/libwebrtc/rtc_base/buffer_queue.h
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2015 The WebRTC Project Authors. All rights reserved.
+ *
+ * Use of this source code is governed by a BSD-style license
+ * that can be found in the LICENSE file in the root of the source
+ * tree. An additional intellectual property rights grant can be found
+ * in the file PATENTS. All contributing project authors may
+ * be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef RTC_BASE_BUFFER_QUEUE_H_
+#define RTC_BASE_BUFFER_QUEUE_H_
+
+#include <stddef.h>
+
+#include <deque>
+#include <vector>
+
+#include "api/sequence_checker.h"
+#include "rtc_base/buffer.h"
+#include "rtc_base/system/no_unique_address.h"
+#include "rtc_base/thread_annotations.h"
+
+namespace rtc {
+
+class BufferQueue final {
+ public:
+ // Creates a buffer queue with a given capacity and default buffer size.
+ BufferQueue(size_t capacity, size_t default_size);
+ ~BufferQueue();
+
+ BufferQueue(const BufferQueue&) = delete;
+ BufferQueue& operator=(const BufferQueue&) = delete;
+
+ // Return number of queued buffers.
+ size_t size() const;
+
+ // Clear the BufferQueue by moving all Buffers from `queue_` to `free_list_`.
+ void Clear();
+
+ // ReadFront will only read one buffer at a time and will truncate buffers
+ // that don't fit in the passed memory.
+ // Returns true unless no data could be returned.
+ bool ReadFront(void* data, size_t bytes, size_t* bytes_read);
+
+ // WriteBack always writes either the complete memory or nothing.
+ // Returns true unless no data could be written.
+ bool WriteBack(const void* data, size_t bytes, size_t* bytes_written);
+
+ bool is_writable() const {
+ RTC_DCHECK_RUN_ON(&sequence_checker_);
+ return queue_.size() < capacity_;
+ }
+
+ bool is_readable() const {
+ RTC_DCHECK_RUN_ON(&sequence_checker_);
+ return !queue_.empty();
+ }
+
+ private:
+ RTC_NO_UNIQUE_ADDRESS webrtc::SequenceChecker sequence_checker_;
+ const size_t capacity_;
+ const size_t default_size_;
+ std::deque<Buffer*> queue_ RTC_GUARDED_BY(sequence_checker_);
+ std::vector<Buffer*> free_list_ RTC_GUARDED_BY(sequence_checker_);
+};
+
+} // namespace rtc
+
+#endif // RTC_BASE_BUFFER_QUEUE_H_