Reflex.Requester.Class

This module defines Requester, which indicates that an action can make requests and receive responses to them. Typically, this is used for things like a WebSocket, where it's desirable to collect many potential sources of events and send them over a single channel, then distribute the results back out efficiently to their original request sites.

Documentation

class (Reflex t, Monad m) => Requester t m | m -> t where

A Requester action can trigger requests of type Request m a based on Events, and receive responses of type Response m a in return. Note that the a type can vary within the Requester action, but will be linked for a given request. For example, if Request m is IO and Response m is Identity, then requestingIdentity has the same type as performEvent.

Minimal complete definition

requesting, requesting_

Associated Types

type Request m :: * -> *

The type of requests that this Requester can emit

type Response m :: * -> *

The type of responses that this Requester can receive

Methods

requesting :: Event t (Request m a) -> m (Event t (Response m a))

Emit a request whenever the given Event fires, and return responses in the resulting Event.

requesting_ :: Event t (Request m a) -> m ()

Emit a request whenever the given Event fires, and ignore all responses.

Instances

Requester t m => Requester t (StateT s m)

Defined in Reflex.Requester.Class

Associated Types

type Request (StateT s m) :: * -> *

type Response (StateT s m) :: * -> *

Methods

requesting :: Event t (Request (StateT s m) a) -> StateT s m (Event t (Response (StateT s m) a))

requesting_ :: Event t (Request (StateT s m) a) -> StateT s m ()

Requester t m => Requester t (StateT s m)

Defined in Reflex.Requester.Class

Associated Types

type Request (StateT s m) :: * -> *

type Response (StateT s m) :: * -> *

Methods

requesting :: Event t (Request (StateT s m) a) -> StateT s m (Event t (Response (StateT s m) a))

requesting_ :: Event t (Request (StateT s m) a) -> StateT s m ()

Requester t m => Requester t (ReaderT r m)

Defined in Reflex.Requester.Class

Associated Types

type Request (ReaderT r m) :: * -> *

type Response (ReaderT r m) :: * -> *

Methods

requesting :: Event t (Request (ReaderT r m) a) -> ReaderT r m (Event t (Response (ReaderT r m) a))

requesting_ :: Event t (Request (ReaderT r m) a) -> ReaderT r m ()

Requester t m => Requester t (EventWriterT t w m)

Defined in Reflex.EventWriter.Base

Associated Types

type Request (EventWriterT t w m) :: * -> *

type Response (EventWriterT t w m) :: * -> *

Methods

requesting :: Event t (Request (EventWriterT t w m) a) -> EventWriterT t w m (Event t (Response (EventWriterT t w m) a))

requesting_ :: Event t (Request (EventWriterT t w m) a) -> EventWriterT t w m ()

Requester t m => Requester t (QueryT t q m)

Defined in Reflex.Query.Base

Associated Types

type Request (QueryT t q m) :: * -> *

type Response (QueryT t q m) :: * -> *

Methods

requesting :: Event t (Request (QueryT t q m) a) -> QueryT t q m (Event t (Response (QueryT t q m) a))

requesting_ :: Event t (Request (QueryT t q m) a) -> QueryT t q m ()

Requester t m => Requester t (DynamicWriterT t w m)

Defined in Reflex.DynamicWriter.Base

Associated Types

type Request (DynamicWriterT t w m) :: * -> *

type Response (DynamicWriterT t w m) :: * -> *

Methods

requesting :: Event t (Request (DynamicWriterT t w m) a) -> DynamicWriterT t w m (Event t (Response (DynamicWriterT t w m) a))

requesting_ :: Event t (Request (DynamicWriterT t w m) a) -> DynamicWriterT t w m ()

Requester t m => Requester t (BehaviorWriterT t w m)

Defined in Reflex.BehaviorWriter.Base

Associated Types

type Request (BehaviorWriterT t w m) :: * -> *

type Response (BehaviorWriterT t w m) :: * -> *

Methods

requesting :: Event t (Request (BehaviorWriterT t w m) a) -> BehaviorWriterT t w m (Event t (Response (BehaviorWriterT t w m) a))

requesting_ :: Event t (Request (BehaviorWriterT t w m) a) -> BehaviorWriterT t w m ()

(Reflex t, Monad m) => Requester t (RequesterT t request response m)

Defined in Reflex.Requester.Base

Associated Types

type Request (RequesterT t request response m) :: * -> *

type Response (RequesterT t request response m) :: * -> *

Methods

requesting :: Event t (Request (RequesterT t request response m) a) -> RequesterT t request response m (Event t (Response (RequesterT t request response m) a))

requesting_ :: Event t (Request (RequesterT t request response m) a) -> RequesterT t request response m ()

withRequesting :: (Requester t m, MonadFix m) => (Event t (Response m a) -> m (Event t (Request m a), r)) -> m r

requestingIdentity :: (Requester t m, Response m ~ Identity) => Event t (Request m a) -> m (Event t a)

Emit a request whenever the given Event fires, and unwrap the responses before returning them. Response m must be Identity.