folly::SoftRealTimeExecutor

Executor that performs priority-based scheduling with a deadline assigned to each task.

Synopsis

Declared in <folly/executors/SoftRealTimeExecutor.h>

class SoftRealTimeExecutor
    : public virtual Executor

Description

Soft real-time means that not every deadline is guaranteed to be met.

Base Classes

NameDescription
ExecutorSchedules and runs asynchronous work.

Type Aliases

NameDescription
KeepAlive Alias for ExecutorKeepAlive, a safe pointer to an Executor.

Member Functions

NameDescription
add add overloads
addWithPriority [virtual]Enqueue a function with a given priority, where 0 is the medium priority This is up to the implementation to enforce
deadlineExecutor Returns an executor that schedules tasks at a fixed deadline.
getNumPriorities [virtual]Returns the number of priority levels this executor supports.

Static Member Functions

NameDescription
getKeepAliveToken getKeepAliveToken overloads
invokeCatchingExns Invokes f, logging and swallowing any exception it throws.

Static Data Members

NameDescription
HI_PRI Highest schedulable priority.
LO_PRI Lowest schedulable priority.
MID_PRI Medium (default) schedulable priority.

Using Declarations

NameDescription
add Inherits the deadline-free add overloads from Executor.

Protected Member Functions

NameDescription
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

NameDescription
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

NameDescription
async_tracing::logFutureViaTrace hook invoked when a Future is rescheduled onto an executor.
async_tracing::logGetGlobalCPUExecutorTrace hook invoked when the global CPU executor is retrieved.
async_tracing::logGetImmutableCPUExecutorTrace hook invoked when the immutable CPU executor is retrieved.
async_tracing::logSemiFutureViaTrace hook invoked when a SemiFuture is rescheduled onto an executor.
async_tracing::logSetGlobalCPUExecutorTrace hook invoked when the global CPU executor is set.

Derived Classes

NameDescription
StripedEDFThreadPoolExecutor An approximate implementation of an Earliest Deadline First executor.