Liking cljdoc? Tell your friends :D

promesa.protocols

A generic promise abstraction and related protocols.

A generic promise abstraction and related protocols.
raw docstring

IAwaitablecljprotocol

-await!clj

(-await! it)
(-await! it duration)

block current thread await termination

block current thread await termination
source

IBufferclj/sprotocol

Used internally; no public api

Used internally; no public api

-full?clj/s

(-full? it)

-offerclj/s

(-offer it val)

-pollclj/s

(-poll it)

-sizeclj/s

(-size it)
sourceraw docstring

ICancellableclj/sprotocol

A cancellation abstraction.

A cancellation abstraction.

-cancel!clj/s

(-cancel! it)

-cancelled?clj/s

(-cancelled? it)
sourceraw docstring

IChannelInternalclj/sprotocol

Used internally; no public api

Used internally; no public api

-cleanupclj/s

(-cleanup it)
sourceraw docstring

IChannelMultiplexerclj/sprotocol

Used internally; no public api

Used internally; no public api

-tapclj/s

(-tap it ch close?)

-untapclj/s

(-untap it ch)
sourceraw docstring

ICloseableclj/sprotocol

Used internally; no public api

Used internally; no public api

-closeclj/s

(-close it)
(-close it reason)

-closed?clj/s

(-closed? it)
sourceraw docstring

ICompletableclj/sprotocol

-reject!clj/s

(-reject! it e)

Deliver an error to empty promise.

Deliver an error to empty promise.

-resolve!clj/s

(-resolve! it v)

Deliver a value to empty promise.

Deliver a value to empty promise.
source

IExecutorclj/sprotocol

-exec!clj/s

(-exec! it task)

Submit a task and return nil

Submit a task and return nil

-run!clj/s

(-run! it task)

Submit a task and return a promise.

Submit a task and return a promise.

-submit!clj/s

(-submit! it task)

Submit a task and return a promise.

Submit a task and return a promise.
source

IHandlerclj/sprotocol

Used internally; no public api

Used internally; no public api

-active?clj/s

(-active? it)

-blockable?clj/s

(-blockable? it)

-commitclj/s

(-commit it)
sourceraw docstring

IInvokecljprotocol

-invokeclj

(-invoke it f)
(-invoke it f duration-or-ms)

Call a function f in a context with optional timeout

Call a function f in a context with optional timeout
source

IJoinablecljprotocol

-joinclj

(-join it)
(-join it duration-or-ms)

block current thread await termination

block current thread await termination
source

ILockclj/sprotocol

A lock protocol, used internally; no public api

A lock protocol, used internally; no public api

-lockclj/s

(-lock it)

-unlockclj/s

(-unlock it)
sourceraw docstring

IPromiseclj/sprotocol

-fmapclj/s

(-fmap it f)
(-fmap it f executor)

Apply function to a computation

Apply function to a computation

-fnlyclj/s

(-fnly it f)
(-fnly it f executor)

Apply function to a computation independently if is failed or successful; the return value is ignored.

Apply function to a computation independently if is failed or
successful; the return value is ignored.

-hmapclj/s

(-hmap it f)
(-hmap it f executor)

Apply function to a computation independently if is failed or successful.

Apply function to a computation independently if is failed or
successful.

-mcatclj/s

(-mcat it f)
(-mcat it f executor)

Apply function to a computation and flatten 1 level

Apply function to a computation and flatten 1 level

-merrclj/s

(-merr it f)
(-merr it f executor)

Apply function to a failed computation and flatten 1 level

Apply function to a failed computation and flatten 1 level

-thenclj/s

(-then it f)
(-then it f executor)

Apply function to a computation and flatten multiple levels

Apply function to a computation and flatten multiple levels
source

IPromiseFactoryclj/sprotocol

A promise constructor abstraction.

A promise constructor abstraction.

-promiseclj/s

(-promise it)

Create a promise instance from other types

Create a promise instance from other types
sourceraw docstring

IReadChannelclj/sprotocol

Used internally; no public api

Used internally; no public api

-takeclj/s

(-take it handler)
sourceraw docstring

ISchedulerclj/sprotocol

A generic abstraction for scheduler facilities.

A generic abstraction for scheduler facilities.

-schedule!clj/s

(-schedule! it ms func)

Schedule a function to be executed in future.

Schedule a function to be executed in future.
sourceraw docstring

ISemaphoreclj/sprotocol

A semaphore protocol, used internally; no public api

A semaphore protocol, used internally; no public api

-acquireclj/s

(-acquire it)
(-acquire it n)

Acquire 1 or N permits

Acquire 1 or N permits

-releaseclj/s

(-release it)
(-release it n)

Release 1 or N permits

Release 1 or N permits

-try-acquireclj/s

(-try-acquire it)
(-try-acquire it n)
(-try-acquire it n t)

Try acquire n or n permits, non-blocking or optional timeout

Try acquire n or n permits, non-blocking or optional timeout
sourceraw docstring

IStateclj/sprotocol

Additional state/introspection abstraction.

Additional state/introspection abstraction.

-extractclj/s

(-extract it)
(-extract it default)

Extract the current value.

Extract the current value.

-pending?clj/s

(-pending? it)

Retutns true if a promise is pending.

Retutns true if a promise is pending.

-rejected?clj/s

(-rejected? it)

Returns true if a promise is rejected.

Returns true if a promise is rejected.

-resolved?clj/s

(-resolved? it)

Returns true if a promise is resolved.

Returns true if a promise is resolved.
sourceraw docstring

IWriteChannelclj/sprotocol

Used internally; no public api

Used internally; no public api

-putclj/s

(-put it val handler)
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close