folly::LifoSemMPMCQueue< T, kBehavior > Class Template Reference

#include <LifoSemMPMCQueue.h>

Inheritance diagram for folly::LifoSemMPMCQueue< T, kBehavior >:

Public Member Functions
	LifoSemMPMCQueue (size_t max_capacity)
BlockingQueueAddResult	add (T item) override
T	take () override
folly::Optional< T >	try_take_for (std::chrono::milliseconds time) override
size_t	capacity ()
size_t	size () override
Public Member Functions inherited from folly::BlockingQueue< T >
virtual	~BlockingQueue ()=default
virtual BlockingQueueAddResult	addWithPriority (T item, int8_t)
virtual uint8_t	getNumPriorities ()

Private Attributes
folly::LifoSem	sem_
folly::MPMCQueue< T >	queue_

Detailed Description

template<class T, QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>
class folly::LifoSemMPMCQueue< T, kBehavior >

Definition at line 26 of file LifoSemMPMCQueue.h.

Constructor & Destructor Documentation

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

folly::LifoSemMPMCQueue< T, kBehavior >::LifoSemMPMCQueue ( size_t  max_capacity )

inlineexplicit

Definition at line 29 of file LifoSemMPMCQueue.h.

: queue_(max_capacity) {}

Member Function Documentation

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

BlockingQueueAddResult folly::LifoSemMPMCQueue< T, kBehavior >::add ( T  item )

inlineoverridevirtual

Implements folly::BlockingQueue< T >.

Definition at line 31 of file LifoSemMPMCQueue.h.

References folly::BLOCK, folly::gen::move, folly::detail::LifoSemBase< Handoff, Atom >::post(), folly::LifoSemMPMCQueue< T, kBehavior >::queue_, folly::LifoSemMPMCQueue< T, kBehavior >::sem_, and folly::THROW.

                                              {
    switch (kBehavior) { // static
      case QueueBehaviorIfFull::THROW:
        if (!queue_.write(std::move(item))) {
          throw QueueFullException("LifoSemMPMCQueue full, can't add item");
        }
        break;
      case QueueBehaviorIfFull::BLOCK:
        queue_.blockingWrite(std::move(item));
        break;
    }
    return sem_.post();
  }

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

size_t folly::LifoSemMPMCQueue< T, kBehavior >::capacity ( )

inline

Definition at line 63 of file LifoSemMPMCQueue.h.

References folly::LifoSemMPMCQueue< T, kBehavior >::queue_.

                    {
    return queue_.capacity();
  }

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

size_t folly::LifoSemMPMCQueue< T, kBehavior >::size ( )

inlineoverridevirtual

Implements folly::BlockingQueue< T >.

Definition at line 67 of file LifoSemMPMCQueue.h.

References folly::LifoSemMPMCQueue< T, kBehavior >::queue_.

                         {
    return queue_.size();
  }

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

T folly::LifoSemMPMCQueue< T, kBehavior >::take ( )

inlineoverridevirtual

Implements folly::BlockingQueue< T >.

Definition at line 45 of file LifoSemMPMCQueue.h.

References folly::LifoSemMPMCQueue< T, kBehavior >::queue_, folly::LifoSemMPMCQueue< T, kBehavior >::sem_, folly::T, and folly::detail::LifoSemBase< Handoff, Atom >::wait().

                    {
    T item;
    while (!queue_.readIfNotEmpty(item)) {
      sem_.wait();
    }
    return item;
  }

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

folly::Optional<T> folly::LifoSemMPMCQueue< T, kBehavior >::try_take_for ( std::chrono::milliseconds  time )

inlineoverridevirtual

Implements folly::BlockingQueue< T >.

Definition at line 53 of file LifoSemMPMCQueue.h.

References folly::gen::move, folly::none, folly::LifoSemMPMCQueue< T, kBehavior >::queue_, folly::LifoSemMPMCQueue< T, kBehavior >::sem_, folly::T, and folly::detail::LifoSemBase< Handoff, Atom >::try_wait_for().

                                                                     {
    T item;
    while (!queue_.readIfNotEmpty(item)) {
      if (!sem_.try_wait_for(time)) {
        return folly::none;
      }
    }
    return std::move(item);
  }

Member Data Documentation

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

folly::MPMCQueue<T> folly::LifoSemMPMCQueue< T, kBehavior >::queue_

private

Definition at line 73 of file LifoSemMPMCQueue.h.

Referenced by folly::LifoSemMPMCQueue< T, kBehavior >::add(), folly::LifoSemMPMCQueue< T, kBehavior >::capacity(), folly::LifoSemMPMCQueue< T, kBehavior >::size(), folly::LifoSemMPMCQueue< T, kBehavior >::take(), and folly::LifoSemMPMCQueue< T, kBehavior >::try_take_for().

template<class T , QueueBehaviorIfFull kBehavior = QueueBehaviorIfFull::THROW>

folly::LifoSem folly::LifoSemMPMCQueue< T, kBehavior >::sem_

private

Definition at line 72 of file LifoSemMPMCQueue.h.

Referenced by folly::LifoSemMPMCQueue< T, kBehavior >::add(), folly::LifoSemMPMCQueue< T, kBehavior >::take(), and folly::LifoSemMPMCQueue< T, kBehavior >::try_take_for().

---

The documentation for this class was generated from the following file:

• proxygen/folly/folly/executors/task_queue/LifoSemMPMCQueue.h