Network.WebSockets.Simple

Types

data WebSocketsApp m receive send

Constructors

WebSocketsApp

Fields

• onOpen :: WebSocketsAppParams m send -> m ()
• onReceive :: WebSocketsAppParams m send -> receive -> m ()
• onClose :: CloseOrigin -> ConnectionException -> m ()

  Should be re-entrant; this exception is caught in all uses of send, even if used in a dead Connection in a lingering thread.

Instances

Profunctor (WebSocketsApp m)

Methods

dimap :: (a -> b) -> (c -> d) -> WebSocketsApp m b c -> WebSocketsApp m a d

lmap :: (a -> b) -> WebSocketsApp m b c -> WebSocketsApp m a c

rmap :: (b -> c) -> WebSocketsApp m a b -> WebSocketsApp m a c

(#.) :: Coercible * c b => (b -> c) -> WebSocketsApp m a b -> WebSocketsApp m a c

(.#) :: Coercible * b a => WebSocketsApp m b c -> (a -> b) -> WebSocketsApp m a c

Generic (WebSocketsApp m receive send)

Associated Types

type Rep (WebSocketsApp m receive send) :: * -> *

Methods

from :: WebSocketsApp m receive send -> Rep (WebSocketsApp m receive send) x

to :: Rep (WebSocketsApp m receive send) x -> WebSocketsApp m receive send

Applicative m => Monoid (WebSocketsApp m receive send)

Methods

mempty :: WebSocketsApp m receive send

mappend :: WebSocketsApp m receive send -> WebSocketsApp m receive send -> WebSocketsApp m receive send

mconcat :: [WebSocketsApp m receive send] -> WebSocketsApp m receive send

type Rep (WebSocketsApp m receive send)

type Rep (WebSocketsApp m receive send) = D1 * (MetaData "WebSocketsApp" "Network.WebSockets.Simple" "websockets-simple-0.1.1-96MGElONGM623wSkmEZKQO" False) (C1 * (MetaCons "WebSocketsApp" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "onOpen") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (WebSocketsAppParams m send -> m ()))) ((:*:) * (S1 * (MetaSel (Just Symbol "onReceive") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (WebSocketsAppParams m send -> receive -> m ()))) (S1 * (MetaSel (Just Symbol "onClose") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (CloseOrigin -> ConnectionException -> m ()))))))

data WebSocketsAppParams m send

Constructors

WebSocketsAppParams

Fields

• send :: send -> m ()
• close :: m ()

Instances

Generic (WebSocketsAppParams m send)

Associated Types

type Rep (WebSocketsAppParams m send) :: * -> *

Methods

from :: WebSocketsAppParams m send -> Rep (WebSocketsAppParams m send) x

to :: Rep (WebSocketsAppParams m send) x -> WebSocketsAppParams m send

type Rep (WebSocketsAppParams m send)

type Rep (WebSocketsAppParams m send) = D1 * (MetaData "WebSocketsAppParams" "Network.WebSockets.Simple" "websockets-simple-0.1.1-96MGElONGM623wSkmEZKQO" False) (C1 * (MetaCons "WebSocketsAppParams" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "send") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (send -> m ()))) (S1 * (MetaSel (Just Symbol "close") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (m ())))))

data ConnectionException :: *

Various exceptions that can occur while receiving or transmitting messages

Constructors

CloseRequest Word16 ByteString

The peer has requested that the connection be closed, and included a close code and a reason for closing. When receiving this exception, no more messages can be sent. Also, the server is responsible for closing the TCP connection once this exception is received.

See http://tools.ietf.org/html/rfc6455#section-7.4 for a list of close codes.

ConnectionClosed

The peer unexpectedly closed the connection while we were trying to receive some data. This is a violation of the websocket RFC since the TCP connection should only be closed after sending and receiving close control messages.

ParseException String

The client sent garbage, i.e. we could not parse the WebSockets stream.

UnicodeException String

The client sent invalid UTF-8. Note that this exception will only be thrown if strict decoding is set in the connection options.

Instances

Eq ConnectionException

Methods

(==) :: ConnectionException -> ConnectionException -> Bool

(/=) :: ConnectionException -> ConnectionException -> Bool

Show ConnectionException

Methods

showsPrec :: Int -> ConnectionException -> ShowS

show :: ConnectionException -> String

showList :: [ConnectionException] -> ShowS

Exception ConnectionException

Methods

toException :: ConnectionException -> SomeException

fromException :: SomeException -> Maybe ConnectionException

displayException :: ConnectionException -> String

data CloseOrigin

Constructors

ClosedOnSend

ClosedOnClose

ClosedOnReceive

Instances

Eq CloseOrigin

Methods

(==) :: CloseOrigin -> CloseOrigin -> Bool

(/=) :: CloseOrigin -> CloseOrigin -> Bool

Show CloseOrigin

Methods

showsPrec :: Int -> CloseOrigin -> ShowS

show :: CloseOrigin -> String

showList :: [CloseOrigin] -> ShowS

data WebSocketsSimpleError

Constructors

JSONParseError ByteString

Instances

Eq WebSocketsSimpleError

Methods

(==) :: WebSocketsSimpleError -> WebSocketsSimpleError -> Bool

(/=) :: WebSocketsSimpleError -> WebSocketsSimpleError -> Bool

Show WebSocketsSimpleError

Methods

showsPrec :: Int -> WebSocketsSimpleError -> ShowS

show :: WebSocketsSimpleError -> String

showList :: [WebSocketsSimpleError] -> ShowS

Generic WebSocketsSimpleError

Associated Types

type Rep WebSocketsSimpleError :: * -> *

Methods

from :: WebSocketsSimpleError -> Rep WebSocketsSimpleError x

to :: Rep WebSocketsSimpleError x -> WebSocketsSimpleError

Exception WebSocketsSimpleError

Methods

toException :: WebSocketsSimpleError -> SomeException

fromException :: SomeException -> Maybe WebSocketsSimpleError

displayException :: WebSocketsSimpleError -> String

type Rep WebSocketsSimpleError

type Rep WebSocketsSimpleError = D1 * (MetaData "WebSocketsSimpleError" "Network.WebSockets.Simple" "websockets-simple-0.1.1-96MGElONGM623wSkmEZKQO" False) (C1 * (MetaCons "JSONParseError" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * ByteString)))

Running

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

This can throw a WebSocketSimpleError to the main thread via link when json parsing fails.

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

Utilities

expBackoffStrategy

Arguments

:: MonadIO m

=> m a

Action to call, like pinging a scoped channel to trigger the reconnect

-> m (ConnectionException -> 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.

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