folly::TestExecutor Class Reference

#include <TestExecutor.h>

Inheritance diagram for folly::TestExecutor:

Public Member Functions
	TestExecutor (size_t numThreads)
	~TestExecutor () override
void	add (Func f) override
size_t	numThreads () const
Public Member Functions inherited from folly::Executor
virtual	~Executor ()
virtual void	addWithPriority (Func, int8_t priority)
virtual uint8_t	getNumPriorities () const

Private Member Functions
void	addImpl (Func f)

Private Attributes
std::mutex	m_
std::queue< Func >	workItems_
std::condition_variable	cv_
std::vector< std::thread >	workers_

Additional Inherited Members
Static Public Member Functions inherited from folly::Executor
template<typename ExecutorT >
static KeepAlive< ExecutorT >	getKeepAliveToken (ExecutorT *executor)
template<typename ExecutorT >
static KeepAlive< ExecutorT >	getKeepAliveToken (ExecutorT &executor)
Static Public Attributes inherited from folly::Executor
static const int8_t	LO_PRI = SCHAR_MIN
static const int8_t	MID_PRI = 0
static const int8_t	HI_PRI = SCHAR_MAX
Protected Member Functions inherited from folly::Executor
virtual bool	keepAliveAcquire ()
virtual void	keepAliveRelease ()
Static Protected Member Functions inherited from folly::Executor
template<typename ExecutorT >
static bool	isKeepAliveDummy (const KeepAlive< ExecutorT > &keepAlive)
template<typename ExecutorT >
static KeepAlive< ExecutorT >	makeKeepAlive (ExecutorT *executor)

Detailed Description

A simple multithreaded executor for use in tests etc

Definition at line 30 of file TestExecutor.h.

Constructor & Destructor Documentation

folly::TestExecutor::TestExecutor ( size_t  numThreads )

explicit

Definition at line 23 of file TestExecutor.cpp.

References cv_, max, and folly::gen::move.

                                            {
  const auto kWorkers = std::max(size_t(1), numThreads);
  for (auto idx = 0u; idx < kWorkers; ++idx) {
    workers_.emplace_back([this] {
      while (true) {
        Func work;
        {
          unique_lock<mutex> lk(m_);
          cv_.wait(lk, [this] { return !workItems_.empty(); });
          work = std::move(workItems_.front());
          workItems_.pop();
        }
        if (!work) {
          break;
        }
        work();
      }
    });
  }
}

folly::TestExecutor::~TestExecutor ( )

override

Definition at line 44 of file TestExecutor.cpp.

                            {
  for (auto& worker : workers_) {
    (void)worker;
    addImpl({});
  }

  for (auto& worker : workers_) {
    worker.join();
  }
}

Member Function Documentation

void folly::TestExecutor::add ( Func  )

overridevirtual

Enqueue a function to executed by this executor. This and all variants must be threadsafe.

Implements folly::Executor.

Definition at line 55 of file TestExecutor.cpp.

References folly::gen::move.

                             {
  if (f) {
    addImpl(std::move(f));
  }
}

void folly::TestExecutor::addImpl ( Func  f )

private

Definition at line 65 of file TestExecutor.cpp.

References cv_, g(), and folly::gen::move.

                                 {
  {
    lock_guard<mutex> g(m_);
    workItems_.push(std::move(f));
  }
  cv_.notify_one();
}

size_t folly::TestExecutor::numThreads

(

)

const

Definition at line 61 of file TestExecutor.cpp.

                                      {
  return workers_.size();
}

Member Data Documentation

std::condition_variable folly::TestExecutor::cv_

private

Definition at line 45 of file TestExecutor.h.

std::mutex folly::TestExecutor::m_

private

Definition at line 43 of file TestExecutor.h.

std::vector<std::thread> folly::TestExecutor::workers_

private

Definition at line 47 of file TestExecutor.h.

std::queue<Func> folly::TestExecutor::workItems_

private

Definition at line 44 of file TestExecutor.h.

---

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

• proxygen/folly/folly/futures/test/TestExecutor.h
• proxygen/folly/folly/futures/test/TestExecutor.cpp