Control.Batching

An Applicative for deferring "requests" to handle them all in bulk.

Documentation

data Batching rq rs a

The bulk request-response Applicative.

A value of type Batching rq rs a describes a computation that gathers some number of rq request values, expects the same number of rs response values, and ultimately returns an a result value derived from the responses.

This can be used to apply an offline resource allocation algorithm to code written as if allocation requests were satisfied incrementally.

This synergizes well with -XApplicativeDo, which allows using do-notation for this type, as long as requests do not depend on earlier responses.

Instances

Functor (Batching rq rs)

Defined in Control.Batching

Methods

fmap :: (a -> b) -> Batching rq rs a -> Batching rq rs b

(<$) :: a -> Batching rq rs b -> Batching rq rs a

Applicative (Batching rq rs)

Defined in Control.Batching

Methods

pure :: a -> Batching rq rs a

(<*>) :: Batching rq rs (a -> b) -> Batching rq rs a -> Batching rq rs b

liftA2 :: (a -> b -> c) -> Batching rq rs a -> Batching rq rs b -> Batching rq rs c

(*>) :: Batching rq rs a -> Batching rq rs b -> Batching rq rs b

(<*) :: Batching rq rs a -> Batching rq rs b -> Batching rq rs a

request :: rq -> Batching rq rs rs

Issue one request and retrieve its response.

batchRequest :: forall t rq rs. Traversable t => t rq -> Batching rq rs (t rs)

Issue a Traversable of requests and retrieve their responses.

runBatching :: Functor f => (forall n. Vec n rq -> f (Vec n rs)) -> Batching rq rs a -> f a

Given an allocator function in any Functor, run a Batching computation.

runBatching_ :: (forall n. Vec n rq -> Vec n rs) -> Batching rq rs a -> a

Like runBatching, but without a Functor (or implicitly in Identity).