* ThreadedExecutor

Synopsis

Declared in <folly/executors/ThreadedExecutor.h>

class ThreadedExecutor
    : public virtual folly::Executor

Description

An executor for blocking tasks.

This executor runs each task in its own thread. It works well for tasks which mostly sleep, but works poorly for tasks which mostly compute.

For each task given to the executor with add, the executor spawns a new thread for that task, runs the task in that thread, and joins the thread after the task has completed.

Spawning and joining task threads are done in the executor's internal control thread. Calls to add put the tasks to be run into a queue, where the control thread will find them.

There is currently no limitation on, or throttling of, concurrency.

This executor is not currently optimized for performance. For example, it makes no attempt to re‐use task threads. Rather, it exists primarily to offload sleep‐heavy tasks from the CPU executor, where they might otherwise be run.

Base Classes

Name

Description

folly::Executor

Schedules and runs asynchronous work.

Type Aliases

Name

Description

KeepAlive

Alias for ExecutorKeepAlive, a safe pointer to an Executor.

Member Functions

Name

Description

ThreadedExecutor [constructor]

Constructors

~ThreadedExecutor [destructor] [virtual]

Stops the control thread and joins any remaining task threads.

operator=

Assignment operators

add [virtual]

Enqueues a task to be run in its own thread.

addWithPriority [virtual]

Enqueue a function with a given priority, where 0 is the medium priority This is up to the implementation to enforce

getNumPriorities [virtual]

Returns the number of priority levels this executor supports.

Static Member Functions

Name

Description

getKeepAliveToken

getKeepAliveToken overloads

invokeCatchingExns

Invokes f, logging and swallowing any exception it throws.

Static Data Members

Name

Description

HI_PRI

Highest schedulable priority.

LO_PRI

Lowest schedulable priority.

MID_PRI

Medium (default) schedulable priority.

Protected Member Functions

Name

Description

keepAliveAcquire [virtual]

Acquire a keep alive token. Should return false if keep‐alive mechanism is not supported.

keepAliveRelease [virtual]

Release a keep alive token previously acquired by keepAliveAcquire(). Will never be called if keepAliveAcquire() returns false.

Protected Static Member Functions

Name

Description

isKeepAliveDummy

Returns true if the KeepAlive is constructed from an executor that does not support the keep alive ref‐counting functionality

keepAliveAcquire

Acquires a keep‐alive reference on executor.

keepAliveRelease

Releases a keep‐alive reference on executor.

makeKeepAlive

Makes a counted (non‐dummy, non‐alias) keep‐alive referring to executor.

Non-Member Functions

Name

Description

async_tracing::logFutureVia

Trace hook invoked when a Future is rescheduled onto an executor.

async_tracing::logGetGlobalCPUExecutor

Trace hook invoked when the global CPU executor is retrieved.

async_tracing::logGetImmutableCPUExecutor

Trace hook invoked when the immutable CPU executor is retrieved.

async_tracing::logSemiFutureVia

Trace hook invoked when a SemiFuture is rescheduled onto an executor.

async_tracing::logSetGlobalCPUExecutor

Trace hook invoked when the global CPU executor is set.

Created with MrDocs