clojure.core.async

<>A B C D F G I M O P R S T U

<

<!
takes a val from port. Must be called inside a (go ...) block. Will return nil if closed. Will park if nothing is avai...
function
([port])
<!!
takes a val from port. Will return nil if closed. Will block if nothing is available. Not intended for use in direct...
function
([port])

>

>!
puts a val into port. nil values are not allowed. Must be called inside a (go ...) block. Will park if no buffer space...
function
([port val])
>!!
puts a val into port. nil values are not allowed. Will block if no buffer space is available. Returns true unless port...
function
([port val])

A

admix
Adds ch as an input to the mix
function
([mix ch])
admix*
protocol-method
([m ch])
alt!
Makes a single choice between one of several channel operations, as if by alts!, returning the value of the result exp...
macro
([& clauses])
alt!!
Like alt!, except as if by alts!!, will block until completed, and not intended for use in (go ...) blocks.
macro
([& clauses])
alts!
Completes at most one of several channel operations. Must be called inside a (go ...) block. ports is a vector of chan...
function
([ports & {:as opts}])
alts!!
Like alts!, except takes will be made as if by <!!, and puts will be made as if by >!!, will block until completed. ...
function
([ports & opts])

B

buffer
Returns a fixed buffer of size n. When full, puts will block/park.
function
([n])

C

chan
Creates a channel with an optional buffer, an optional transducer (like (map f), (filter p) etc or a composition there...
function
([] [buf-or-n] [buf-or-n xform] [buf-or-n xform ex-handler])
close!
Closes a channel. The channel will no longer accept any puts (they will be ignored). Data in the channel remains avail...
function
([chan])

D

defblockingop
macro
([op doc arglist & body])
do-alt
function
([alts clauses])
do-alts
returns derefable [val port] if immediate, nil if enqueued
function
([fret ports opts])
dropping-buffer
Returns a buffer of size n. When full, puts will complete but val will be dropped (no transfer).
function
([n])

F

fn-handler
function
([f] [f blockable])

G

go
Asynchronously executes the body, returning immediately to the calling thread. Additionally, any visible calls to <!, ...
macro
([& body])
go-loop
Like (go (loop ...))
macro
([bindings & body])

I

into
Returns a channel containing the single (collection) result of the items taken from the channel conjoined to the suppl...
function
([coll ch])
ioc-alts!
function
([state cont-block ports & {:as opts}])

M

Mix
value
Mult
value
Mux
value
map
Takes a function and a collection of source channels, and returns a channel which contains the values produced by appl...
function
([f chs] [f chs buf-or-n])
merge
Takes a collection of source channels and returns a channel which contains all values taken from them. The returned ch...
function
([chs] [chs buf-or-n])
mix
Creates and returns a mix of one or more input channels which will be put on the supplied out channel. Input sources c...
function
([out])
mult
Creates and returns a mult(iple) of the supplied channel. Channels containing copies of the channel can be created wit...
function
([ch])
muxch*
protocol-method
([_])

O

offer!
Puts a val into port if it's possible to do so immediately. nil values are not allowed. Never blocks. Returns true if...
function
([port val])
onto-chan!
Puts the contents of coll into the supplied channel. By default the channel will be closed after the items are copied...
function
([ch coll] [ch coll close?])
onto-chan!!
Like onto-chan! for use when accessing coll might block, e.g. a lazy seq of blocking operations
function
([ch coll] [ch coll close?])

P

Pub
value
pipe
Takes elements from the from channel and supplies them to the to channel. By default, the to channel will be closed wh...
function
([from to] [from to close?])
pipeline
Takes elements from the from channel and supplies them to the to channel, subject to the transducer xf, with paralleli...
function
([n to xf from] [n to xf from close?] [n to xf from close? ex-handler])
pipeline-async
Takes elements from the from channel and supplies them to the to channel, subject to the async function af, with paral...
function
([n to af from] [n to af from close?])
pipeline-blocking
Like pipeline, for blocking operations.
function
([n to xf from] [n to xf from close?] [n to xf from close? ex-handler])
poll!
Takes a val from port if it's possible to do so immediately. Never blocks. Returns value if successful, nil otherwise...
function
([port])
promise-chan
Creates a promise channel with an optional transducer, and an optional exception-handler. A promise channel can take e...
function
([] [xform] [xform ex-handler])
pub
Creates and returns a pub(lication) of the supplied channel, partitioned into topics by the topic-fn. topic-fn will be...
function
([ch topic-fn] [ch topic-fn buf-fn])
put!
Asynchronously puts a val into port, calling fn1 (if supplied) when complete, passing false iff port is already close...
function
([port val] [port val fn1] [port val fn1 on-caller?])

R

reduce
f should be a function of 2 arguments. Returns a channel containing the single result of applying f to init and the fi...
function
([f init ch])

S

sliding-buffer
Returns a buffer of size n. When full, puts will complete, and be buffered, but oldest elements in buffer will be drop...
function
([n])
solo-mode
Sets the solo mode of the mix. mode must be one of :mute or :pause
function
([mix mode])
solo-mode*
protocol-method
([m mode])
split
Takes a predicate and a source channel and returns a vector of two channels, the first of which will contain the value...
function
([p ch] [p ch t-buf-or-n f-buf-or-n])
sub
Subscribes a channel to a topic of a pub. By default the channel will be closed when the source closes, but can be ...
function
([p topic ch] [p topic ch close?])
sub*
protocol-method
([p v ch close?])

T

take
Returns a channel that will return, at most, n items from ch. After n items have been returned, or ch has been closed...
function
([n ch] [n ch buf-or-n])
take!
Asynchronously takes a val from port, passing to fn1. Will pass nil if closed. If on-caller? (default true) is true, ...
function
([port fn1] [port fn1 on-caller?])
tap
Copies the mult source onto the supplied channel. By default the channel will be closed when the source closes, but...
function
([mult ch] [mult ch close?])
tap*
protocol-method
([m ch close?])
thread
Executes the body in another thread, returning immediately to the calling thread. Returns a channel which will receive...
macro
([& body])
thread-call
Executes f in another thread, returning immediately to the calling thread. Returns a channel which will receive the re...
function
([f])
timeout
Returns a channel that will close after msecs
function
([msecs])
to-chan!
Creates and returns a channel which contains the contents of coll, closing when exhausted. If accessing coll might ...
function
([coll])
to-chan!!
Like to-chan! for use when accessing coll might block, e.g. a lazy seq of blocking operations
function
([coll])
toggle
Atomically sets the state(s) of one or more channels in a mix. The state map is a map of channels -> channel-state-map...
function
([mix state-map])
toggle*
protocol-method
([m state-map])
transduce
async/reduces a channel with a transformation (xform f). Returns a channel containing the result. ch must close befor...
function
([xform f init ch])

U

unblocking-buffer?
Returns true if a channel created with buff will never block. That is to say, puts into this buffer will never cause ...
function
([buff])
unmix
Removes ch as an input to the mix
function
([mix ch])
unmix*
protocol-method
([m ch])
unmix-all
removes all inputs from the mix
function
([mix])
unmix-all*
protocol-method
([m])
unsub
Unsubscribes a channel from a topic of a pub
function
([p topic ch])
unsub*
protocol-method
([p v ch])
unsub-all
Unsubscribes all channels from a pub, or a topic of a pub
function
([p] [p topic])
unsub-all*
protocol-method
([p] [p v])
untap
Disconnects a target channel from a mult
function
([mult ch])
untap*
protocol-method
([m ch])
untap-all
Disconnects all target channels from a mult
function
([mult])
untap-all*
protocol-method
([m])