Liking cljdoc? Tell your friends :D

promesa.exec

Executors & Schedulers facilities.

Executors & Schedulers facilities.
raw docstring

*default-executor*clj/s

source

*default-scheduler*clj/s

source

cached-executorclj

(cached-executor & {:keys [factory]})

A cached thread executor pool constructor.

A cached thread executor pool constructor.
sourceraw docstring

configure-default-executor!clj

(configure-default-executor! & params)
source

current-threadclj

(current-thread)

Return the current thread.

Return the current thread.
sourceraw docstring

current-thread-executorclj/s

(current-thread-executor)

Creates an executor instance that run tasks in the same thread.

Creates an executor instance that run tasks in the same thread.
sourceraw docstring

default-current-thread-executorclj/s

Default Executor instance that runs the task in the same thread.

Default Executor instance that runs the task in the same thread.
sourceraw docstring

default-executorclj/s

Default executor instance, ForkJoinPool/commonPool in JVM, MicrotaskExecutor on JS.

Default executor instance, ForkJoinPool/commonPool in JVM, MicrotaskExecutor on JS.
sourceraw docstring

default-schedulerclj/s

Default scheduled executor instance.

Default scheduled executor instance.
sourceraw docstring

executor?clj/s

(executor? o)

Returns true if o is an instane of Executor or satisfies IExecutor protocol.

Returns true if `o` is an instane of Executor or satisfies IExecutor protocol.
sourceraw docstring

fixed-executorclj

(fixed-executor & {:keys [parallelism factory]})

A fixed thread executor pool constructor.

A fixed thread executor pool constructor.
sourceraw docstring

forkjoin-executorclj

(forkjoin-executor & {:keys [factory async? parallelism] :or {async? true}})
source

forkjoin-thread-factoryclj

(forkjoin-thread-factory &
                         {:keys [name daemon]
                          :or {name "promesa/forkjoin/%s" daemon true}})
source

interrupt!clj

(interrupt!)
(interrupt! thread)

Interrupt a thread.

Interrupt a thread.
sourceraw docstring

interrupted?clj

(interrupted?)
(interrupted? thread)

Check if the thread has the interrupted flag set.

There are two special cases:

Using the :current keyword as argument will check the interrupted flag on the current thread.

Using the arity 0 (passing no arguments), then the current thread will be checked and WARNING the interrupted flag reset to false.

Check if the thread has the interrupted flag set.

There are two special cases:

Using the `:current` keyword as argument will check the interrupted
flag on the current thread.

Using the arity 0 (passing no arguments), then the current thread
will be checked and **WARNING** the interrupted flag reset to
`false`.
sourceraw docstring

microtask-executorcljs

(microtask-executor)

An IExecutor that schedules tasks to be executed in the MicrotasksQueue.

An IExecutor that schedules tasks to be executed in the MicrotasksQueue.
sourceraw docstring

pmapclj

(pmap f coll)
(pmap f coll & colls)

Analogous to the clojure.core/pmap with the excetion that it allows use a custom executor (binded to default-executor var) The default clojure chunk size (32) is used for evaluation and the real parallelism is determined by the provided executor.

EXPERIMENTAL API: This function should be considered EXPERIMENTAL and may be changed or removed in future versions until this notification is removed.

Analogous to the `clojure.core/pmap` with the excetion that it allows
use a custom executor (binded to *default-executor* var) The default
clojure chunk size (32) is used for evaluation and the real
parallelism is determined by the provided executor.


**EXPERIMENTAL API:** This function should be considered
EXPERIMENTAL and may be changed or removed in future versions until
this notification is removed.
sourceraw docstring

run!clj/s

(run! f)
(run! executor f)

Run the task in the provided executor.

Run the task in the provided executor.
sourceraw docstring

schedule!clj/s

(schedule! ms f)
(schedule! scheduler ms f)

Schedule a callable to be executed after the ms delay is reached.

In JVM it uses a scheduled executor service and in JS it uses the setTimeout function.

Schedule a callable to be executed after the `ms` delay
is reached.

In JVM it uses a scheduled executor service and in JS
it uses the `setTimeout` function.
sourceraw docstring

scheduled-executorclj/s

(scheduled-executor & {:keys [parallelism factory] :or {parallelism 1}})

A scheduled thread pool constructor. A ScheduledExecutor (IScheduler in CLJS) instance allows execute asynchronous tasks some time later.

A scheduled thread pool constructor. A ScheduledExecutor (IScheduler
in CLJS) instance allows execute asynchronous tasks some time later.
sourceraw docstring

shutdown!clj

(shutdown! executor)

Shutdowns the executor service.

Shutdowns the executor service.
sourceraw docstring

shutdown-now!clj

(shutdown-now! executor)

Shutdowns and interrupts the executor service.

Shutdowns and interrupts the executor service.
sourceraw docstring

shutdown?clj

(shutdown? executor)

Check if execitor is in shutdown state.

Check if execitor is in shutdown state.
sourceraw docstring

single-executorclj

(single-executor & {:keys [factory]})

A single thread executor pool constructor.

A single thread executor pool constructor.
sourceraw docstring

sleepclj

(sleep ms)

Turn the current thread to sleep accept a number of milliseconds or Duration instance.

Turn the current thread to sleep accept a number of milliseconds or
Duration instance.
sourceraw docstring

submit!clj/s

(submit! f)
(submit! executor f)

Submit a task to be executed in a provided executor and return a promise that will be completed with the return value of a task.

A task is a plain clojure function.

Submit a task to be executed in a provided executor
and return a promise that will be completed with
the return value of a task.

A task is a plain clojure function.
sourceraw docstring

threadcljmacro

(thread opts & body)

A low-level, not-pooled thread constructor.

A low-level, not-pooled thread constructor.
sourceraw docstring

thread-factoryclj

(thread-factory
  &
  {:keys [name daemon priority]
   :or {daemon true priority Thread/NORM_PRIORITY name "promesa/thread/%s"}})

Returns an instance of promesa default thread factory.

Returns an instance of promesa default thread factory.
sourceraw docstring

thread-factory?clj

(thread-factory? o)

Checks if o is an instance of ThreadFactory

Checks if `o` is an instance of ThreadFactory
sourceraw docstring

thread-idclj

(thread-id)
(thread-id thread)

Retrieves the thread ID.

Retrieves the thread ID.
sourceraw docstring

thread?clj

(thread? t)

Check if provided object is a thread instance.

Check if provided object is a thread instance.
sourceraw docstring

vthreads-supported?clj/s

A var that indicates if virtual threads are supported or not in the current runtime.

A var that indicates if virtual threads are supported or not in the current runtime.
sourceraw docstring

with-dispatchclj/smacro

(with-dispatch executor & body)

Helper macro for dispatch execution of the body to an executor service. The returned promise is not cancellable (the body will be executed independently of the cancellation).

Helper macro for dispatch execution of the body to an executor
service. The returned promise is not cancellable (the body will be
executed independently of the cancellation).
sourceraw docstring

with-executorclj/smacro

(with-executor executor & body)

Binds the default-executor var with the provided executor, executes the macro body. It also can optionally shutdown or shutdown and interrupt on termination if you provide ^:shutdown and ^:interrupt metadata.

EXPERIMENTAL API: This function should be considered EXPERIMENTAL and may be changed or removed in future versions until this notification is removed.

Binds the *default-executor* var with the provided executor,
executes the macro body. It also can optionally shutdown or shutdown
and interrupt on termination if you provide `^:shutdown` and
`^:interrupt` metadata.

**EXPERIMENTAL API:** This function should be considered
EXPERIMENTAL and may be changed or removed in future versions until
this notification is removed.
sourceraw docstring

work-stealing-executorclj

(work-stealing-executor & params)

An alias for the forkjoin-executor.

An alias for the `forkjoin-executor`.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close