folly/executors/BlockingQueue.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <exception>
  20 #include <stdexcept>
  21
  22 #include <glog/logging.h>
  23
  24 namespace folly {
  25
  26 // Some queue implementations (for example, LifoSemMPMCQueue or
  27 // PriorityLifoSemMPMCQueue) support both blocking (BLOCK) and
  28 // non-blocking (THROW) behaviors.
  29 enum class QueueBehaviorIfFull { THROW, BLOCK };
  30
  31 class QueueFullException : public std::runtime_error {
  32   using std::runtime_error::runtime_error; // Inherit constructors.
  33 };
  34
  35 template <class T>
  36 class BlockingQueue {
  37  public:
  38   virtual ~BlockingQueue() = default;
  39   virtual void add(T item) = 0;
  40   virtual void addWithPriority(T item, int8_t /* priority */) {
  41     add(std::move(item));
  42   }
  43   virtual uint8_t getNumPriorities() {
  44     return 1;
  45   }
  46   virtual T take() = 0;
  47   virtual size_t size() = 0;
  48 };
  49
  50 } // namespace folly