Network.WebSockets.Simple

Documentation

data WebSocketsAppParams send m

Constructors

WebSocketsAppParams

Fields

send :: send -> m ()

close :: m ()

Instances

Generic (WebSocketsAppParams send m)

type Rep (WebSocketsAppParams send m)

data WebSocketsApp send receive m

Constructors

WebSocketsApp

Fields

onOpen :: WebSocketsAppParams send m -> m ()

onReceive :: WebSocketsAppParams send m -> receive -> m ()

onClose :: Maybe (Word16, ByteString) -> m ()

Either was a clean close, with CloseRequest params, or was unclean. Note that to implement backoff strategies, you should catch your ConnectionException outside this simple app, and only after you've runClient or server, because the Connection will be different.

Instances

Generic (WebSocketsApp send receive m)

type Rep (WebSocketsApp send receive m)

hoistWebSocketsApp :: (forall a. m a -> n a) -> (forall a. n a -> m a) -> WebSocketsApp send receive m -> WebSocketsApp send receive n

toClientAppT :: forall send receive m. (ToJSON send, FromJSON receive, MonadBaseControl IO m, MonadThrow m, MonadCatch m) => WebSocketsApp send receive m -> ClientAppT m (Maybe WebSocketsAppThreads)

This can throw a WebSocketSimpleError when json parsing fails. However, do note: the onOpen is called once, but is still forked when called. Likewise, the onReceive function is called every time a (parsable) response is received from the other party, and is forked on every invocation.

toClientAppT' :: (ToJSON send, FromJSON receive, MonadBaseControl IO m, MonadThrow m, MonadCatch m) => WebSocketsApp send receive m -> ClientAppT m ()

toServerAppT :: (ToJSON send, FromJSON receive, MonadBaseControl IO m, MonadThrow m, MonadCatch m) => WebSocketsApp send receive m -> ServerAppT m

expBackoffStrategy

Arguments

:: (MonadBaseControl IO m, MonadCatch m)

=> m a

The run app

-> m a

A simple backoff strategy, which (per second), will increasingly delay at 2^soFar, until soFar >= 5minutes, where it will then routinely poll every 5 minutes.

data WebSocketSimpleError

Constructors

JSONParseError ByteString

Instances

Eq WebSocketSimpleError

Show WebSocketSimpleError

Generic WebSocketSimpleError

Exception WebSocketSimpleError

type Rep WebSocketSimpleError

data WebSocketsAppThreads

Constructors

WebSocketsAppThreads

Fields

onOpenThread :: Async ()

onReceiveThreads :: TChan (Async ())