Network.WebSockets.Simple

Documentation

data WebSocketsAppParams send m

Constructors

WebSocketsAppParams

Fields

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

Instances

Generic (WebSocketsAppParams send m)

Associated Types

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

Methods

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

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

type Rep (WebSocketsAppParams send m)

type Rep (WebSocketsAppParams send m) = D1 (MetaData "WebSocketsAppParams" "Network.WebSockets.Simple" "websockets-simple-0.0.4-GTX2AwUs0Cm37PNYFFLfoJ" 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 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

Instances

Generic (WebSocketsApp send receive m)

Associated Types

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

Methods

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

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

type Rep (WebSocketsApp send receive m)

type Rep (WebSocketsApp send receive m) = D1 (MetaData "WebSocketsApp" "Network.WebSockets.Simple" "websockets-simple-0.0.4-GTX2AwUs0Cm37PNYFFLfoJ" False) (C1 (MetaCons "WebSocketsApp" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "onOpen") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (WebSocketsAppParams send m -> m ()))) ((:*:) (S1 (MetaSel (Just Symbol "onReceive") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (WebSocketsAppParams send m -> receive -> m ()))) (S1 (MetaSel (Just Symbol "onClose") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Word16, ByteString) -> 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

data WebSocketSimpleError

Constructors

JSONParseError ByteString

Instances

Eq WebSocketSimpleError

Methods

(==) :: WebSocketSimpleError -> WebSocketSimpleError -> Bool

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

Show WebSocketSimpleError

Methods

showsPrec :: Int -> WebSocketSimpleError -> ShowS

show :: WebSocketSimpleError -> String

showList :: [WebSocketSimpleError] -> ShowS

Generic WebSocketSimpleError

Associated Types

type Rep WebSocketSimpleError :: * -> *

Methods

from :: WebSocketSimpleError -> Rep WebSocketSimpleError x

to :: Rep WebSocketSimpleError x -> WebSocketSimpleError

Exception WebSocketSimpleError

Methods

toException :: WebSocketSimpleError -> SomeException

fromException :: SomeException -> Maybe WebSocketSimpleError

displayException :: WebSocketSimpleError -> String

type Rep WebSocketSimpleError

type Rep WebSocketSimpleError = D1 (MetaData "WebSocketSimpleError" "Network.WebSockets.Simple" "websockets-simple-0.0.4-GTX2AwUs0Cm37PNYFFLfoJ" False) (C1 (MetaCons "JSONParseError" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

data WebSocketsAppThreads

Constructors

WebSocketsAppThreads

Fields

• onOpenThread :: Async ()
• onReceiveThreads :: TChan (Async ())