Marker base for the weak‐reference executor wrappers.

Synopsis

Declared in <folly/DefaultKeepAliveExecutor.h>

class WeakRefExecutor
    : public virtual Executor

Base Classes

Name

Description

Executor

Schedules and runs asynchronous work.

Type Aliases

Name

Description

KeepAlive

Alias for ExecutorKeepAlive, a safe pointer to an Executor.

Member Functions

Name

Description

add [virtual]

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

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

::folly::async_tracing::logFutureVia

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

::folly::async_tracing::logGetGlobalCPUExecutor

Trace hook invoked when the global CPU executor is retrieved.

::folly::async_tracing::logGetImmutableCPUExecutor

Trace hook invoked when the immutable CPU executor is retrieved.

::folly::async_tracing::logSemiFutureVia

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

::folly::async_tracing::logSetGlobalCPUExecutor

Trace hook invoked when the global CPU executor is set.

Created with MrDocs