Network.WebSockets.RPC

Server

data RPCServerParams rep com m

Constructors

RPCServerParams

Fields

• reply :: rep -> m ()

  dispatch a reply

• complete :: com -> m ()

  dispatch a onComplete

type RPCServer sub sup rep com m

Arguments

 = RPCServerParams rep com m

-> Either sub sup

handle incoming message

-> m ()

rpcServer :: forall sub sup rep com m. (ToJSON rep, ToJSON com, FromJSON sub, FromJSON sup, MonadIO m, MonadThrow m, MonadBaseControl IO m) => RPCServer sub sup rep com m -> ServerAppT (WebSocketServerRPCT sub sup m)

May throw a WebSocketRPCParseFailure if the opposing party sends bad data

Client

data RPCClientParams sup m

Constructors

RPCClientParams

Fields

• supply :: sup -> m ()

  dispatch a supply

• cancel :: m ()

  cancel the RPC call

data RPCClient sub sup rep com m

Constructors

RPCClient

Fields

• subscription :: !sub
• onSubscribe :: RPCClientParams sup m -> m ()
• onReply :: RPCClientParams sup m -> rep -> m ()

  handle incoming reply

• onComplete :: com -> m ()

  handle finalized onComplete

rpcClient :: forall sub sup rep com m. (ToJSON sub, ToJSON sup, FromJSON rep, FromJSON com, MonadIO m, MonadThrow m, MonadCatch m) => ((RPCClient sub sup rep com m -> WebSocketClientRPCT rep com m ()) -> WebSocketClientRPCT rep com m ()) -> ClientAppT (WebSocketClientRPCT rep com m) ()

May throw a WebSocketRPCParseFailure if the opposing party sends bad data

Re-Exports

data WebSocketServerRPCT sub sup m a

Instances

MonadReader r m => MonadReader r (WebSocketServerRPCT sub sup m)

Methods

ask :: WebSocketServerRPCT sub sup m r

local :: (r -> r) -> WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m a

reader :: (r -> a) -> WebSocketServerRPCT sub sup m a

MonadState s m => MonadState s (WebSocketServerRPCT sub sup m)

Methods

get :: WebSocketServerRPCT sub sup m s

put :: s -> WebSocketServerRPCT sub sup m ()

state :: (s -> (a, s)) -> WebSocketServerRPCT sub sup m a

MonadWriter w m => MonadWriter w (WebSocketServerRPCT sub sup m)

Methods

writer :: (a, w) -> WebSocketServerRPCT sub sup m a

tell :: w -> WebSocketServerRPCT sub sup m ()

listen :: WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m (a, w)

pass :: WebSocketServerRPCT sub sup m (a, w -> w) -> WebSocketServerRPCT sub sup m a

MonadTrans (WebSocketServerRPCT sub sup)

Methods

lift :: Monad m => m a -> WebSocketServerRPCT sub sup m a

Monad m => Monad (WebSocketServerRPCT sub sup m)

Methods

(>>=) :: WebSocketServerRPCT sub sup m a -> (a -> WebSocketServerRPCT sub sup m b) -> WebSocketServerRPCT sub sup m b

(>>) :: WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m b -> WebSocketServerRPCT sub sup m b

return :: a -> WebSocketServerRPCT sub sup m a

fail :: String -> WebSocketServerRPCT sub sup m a

Functor m => Functor (WebSocketServerRPCT sub sup m)

Methods

fmap :: (a -> b) -> WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m b

(<$) :: a -> WebSocketServerRPCT sub sup m b -> WebSocketServerRPCT sub sup m a

Applicative m => Applicative (WebSocketServerRPCT sub sup m)

Methods

pure :: a -> WebSocketServerRPCT sub sup m a

(<*>) :: WebSocketServerRPCT sub sup m (a -> b) -> WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m b

(*>) :: WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m b -> WebSocketServerRPCT sub sup m b

(<*) :: WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m b -> WebSocketServerRPCT sub sup m a

MonadIO m => MonadIO (WebSocketServerRPCT sub sup m)

Methods

liftIO :: IO a -> WebSocketServerRPCT sub sup m a

MonadThrow m => MonadThrow (WebSocketServerRPCT sub sup m)

Methods

throwM :: Exception e => e -> WebSocketServerRPCT sub sup m a

MonadCatch m => MonadCatch (WebSocketServerRPCT sub sup m)

Methods

catch :: Exception e => WebSocketServerRPCT sub sup m a -> (e -> WebSocketServerRPCT sub sup m a) -> WebSocketServerRPCT sub sup m a

MonadMask m => MonadMask (WebSocketServerRPCT sub sup m)

Methods

mask :: ((forall a. WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m a) -> WebSocketServerRPCT sub sup m b) -> WebSocketServerRPCT sub sup m b

uninterruptibleMask :: ((forall a. WebSocketServerRPCT sub sup m a -> WebSocketServerRPCT sub sup m a) -> WebSocketServerRPCT sub sup m b) -> WebSocketServerRPCT sub sup m b

Generic (WebSocketServerRPCT sub sup m a)

Associated Types

type Rep (WebSocketServerRPCT sub sup m a) :: * -> *

Methods

from :: WebSocketServerRPCT sub sup m a -> Rep (WebSocketServerRPCT sub sup m a) x

to :: Rep (WebSocketServerRPCT sub sup m a) x -> WebSocketServerRPCT sub sup m a

type Rep (WebSocketServerRPCT sub sup m a)

type Rep (WebSocketServerRPCT sub sup m a) = D1 (MetaData "WebSocketServerRPCT" "Network.WebSockets.RPC.Trans.Server" "websockets-rpc-0.6.0-Bvy6xnnJ8kALWZvC58himH" True) (C1 (MetaCons "WebSocketServerRPCT" PrefixI True) (S1 (MetaSel (Just Symbol "runWebSocketServerRPCT") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ReaderT * (Env sub sup m) m a))))

execWebSocketServerRPCT :: MonadIO m => WebSocketServerRPCT sub sup m a -> m a

data WebSocketClientRPCT rep com m a

Instances

MonadReader r m => MonadReader r (WebSocketClientRPCT rep com m)

Methods

ask :: WebSocketClientRPCT rep com m r

local :: (r -> r) -> WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m a

reader :: (r -> a) -> WebSocketClientRPCT rep com m a

MonadState s m => MonadState s (WebSocketClientRPCT rep com m)

Methods

get :: WebSocketClientRPCT rep com m s

put :: s -> WebSocketClientRPCT rep com m ()

state :: (s -> (a, s)) -> WebSocketClientRPCT rep com m a

MonadWriter w m => MonadWriter w (WebSocketClientRPCT rep com m)

Methods

writer :: (a, w) -> WebSocketClientRPCT rep com m a

tell :: w -> WebSocketClientRPCT rep com m ()

listen :: WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m (a, w)

pass :: WebSocketClientRPCT rep com m (a, w -> w) -> WebSocketClientRPCT rep com m a

MonadTrans (WebSocketClientRPCT rep com)

Methods

lift :: Monad m => m a -> WebSocketClientRPCT rep com m a

Monad m => Monad (WebSocketClientRPCT rep com m)

Methods

(>>=) :: WebSocketClientRPCT rep com m a -> (a -> WebSocketClientRPCT rep com m b) -> WebSocketClientRPCT rep com m b

(>>) :: WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m b -> WebSocketClientRPCT rep com m b

return :: a -> WebSocketClientRPCT rep com m a

fail :: String -> WebSocketClientRPCT rep com m a

Functor m => Functor (WebSocketClientRPCT rep com m)

Methods

fmap :: (a -> b) -> WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m b

(<$) :: a -> WebSocketClientRPCT rep com m b -> WebSocketClientRPCT rep com m a

Applicative m => Applicative (WebSocketClientRPCT rep com m)

Methods

pure :: a -> WebSocketClientRPCT rep com m a

(<*>) :: WebSocketClientRPCT rep com m (a -> b) -> WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m b

(*>) :: WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m b -> WebSocketClientRPCT rep com m b

(<*) :: WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m b -> WebSocketClientRPCT rep com m a

MonadIO m => MonadIO (WebSocketClientRPCT rep com m)

Methods

liftIO :: IO a -> WebSocketClientRPCT rep com m a

MonadThrow m => MonadThrow (WebSocketClientRPCT rep com m)

Methods

throwM :: Exception e => e -> WebSocketClientRPCT rep com m a

MonadCatch m => MonadCatch (WebSocketClientRPCT rep com m)

Methods

catch :: Exception e => WebSocketClientRPCT rep com m a -> (e -> WebSocketClientRPCT rep com m a) -> WebSocketClientRPCT rep com m a

MonadMask m => MonadMask (WebSocketClientRPCT rep com m)

Methods

mask :: ((forall a. WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m a) -> WebSocketClientRPCT rep com m b) -> WebSocketClientRPCT rep com m b

uninterruptibleMask :: ((forall a. WebSocketClientRPCT rep com m a -> WebSocketClientRPCT rep com m a) -> WebSocketClientRPCT rep com m b) -> WebSocketClientRPCT rep com m b

Generic (WebSocketClientRPCT rep com m a)

Associated Types

type Rep (WebSocketClientRPCT rep com m a) :: * -> *

Methods

from :: WebSocketClientRPCT rep com m a -> Rep (WebSocketClientRPCT rep com m a) x

to :: Rep (WebSocketClientRPCT rep com m a) x -> WebSocketClientRPCT rep com m a

type Rep (WebSocketClientRPCT rep com m a)

type Rep (WebSocketClientRPCT rep com m a) = D1 (MetaData "WebSocketClientRPCT" "Network.WebSockets.RPC.Trans.Client" "websockets-rpc-0.6.0-Bvy6xnnJ8kALWZvC58himH" True) (C1 (MetaCons "WebSocketClientRPCT" PrefixI True) (S1 (MetaSel (Just Symbol "runWebSocketClientRPCT") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ReaderT * (Env rep com m) m a))))

execWebSocketClientRPCT :: MonadIO m => WebSocketClientRPCT rep com m a -> m a

data WebSocketRPCException

Constructors

WebSocketRPCParseFailure [String] ByteString

Instances

Show WebSocketRPCException

Methods

showsPrec :: Int -> WebSocketRPCException -> ShowS

show :: WebSocketRPCException -> String

showList :: [WebSocketRPCException] -> ShowS

Generic WebSocketRPCException

Associated Types

type Rep WebSocketRPCException :: * -> *

Methods

from :: WebSocketRPCException -> Rep WebSocketRPCException x

to :: Rep WebSocketRPCException x -> WebSocketRPCException

Exception WebSocketRPCException

Methods

toException :: WebSocketRPCException -> SomeException

fromException :: SomeException -> Maybe WebSocketRPCException

displayException :: WebSocketRPCException -> String

type Rep WebSocketRPCException

type Rep WebSocketRPCException = D1 (MetaData "WebSocketRPCException" "Network.WebSockets.RPC.Types" "websockets-rpc-0.6.0-Bvy6xnnJ8kALWZvC58himH" False) (C1 (MetaCons "WebSocketRPCParseFailure" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString))))

runClientAppTBackingOff :: (forall a. m a -> IO a) -> String -> Int -> String -> ClientAppT m () -> IO ()

rpcServerSimple

Arguments

:: (MonadBaseControl IO m, MonadIO m)

=> (Maybe (Word16, ByteString) -> m ())

see onClose

-> RPCServer sub sup rep com m

-> WebSocketsApp (Either (Reply rep) (Complete com)) (Either (Subscribe sub) (Supply sup)) (WebSocketServerRPCT sub sup m)

Note that this does not ping-pong.

rpcClientSimple

Arguments

:: MonadIO m

=> (Maybe (Word16, ByteString) -> m ())

see onClose

-> RPCClient sub sup rep com m

-> WebSocketClientRPCT rep com m (WebSocketsApp (Either (Subscribe sub) (Supply sup)) (Either (Reply rep) (Complete com)) (WebSocketClientRPCT rep com m))

Note, does not support pingpong

runWebSocketClientRPCTSimple :: Monad m => (forall a. WebSocketClientRPCT rep com m a -> m a) -> WebSocketsApp (Either (Subscribe sub) (Supply sup)) (Either (Reply rep) (Complete com)) (WebSocketClientRPCT rep com m) -> WebSocketsApp (Either (Subscribe sub) (Supply sup)) (Either (Reply rep) (Complete com)) m

execWebSocketClientRPCTSimple :: MonadBaseControl IO m => WebSocketsApp (Either (Subscribe sub) (Supply sup)) (Either (Reply rep) (Complete com)) (WebSocketClientRPCT rep com m) -> m (WebSocketsApp (Either (Subscribe sub) (Supply sup)) (Either (Reply rep) (Complete com)) m)

runWebSocketServerRPCTSimple :: Monad m => (forall a. WebSocketServerRPCT sub sup m a -> m a) -> WebSocketsApp (Either (Reply rep) (Complete com)) (Either (Subscribe sub) (Supply sup)) (WebSocketServerRPCT sub sup m) -> WebSocketsApp (Either (Reply rep) (Complete com)) (Either (Subscribe sub) (Supply sup)) m

execWebSocketServerRPCTSimple :: MonadBaseControl IO m => WebSocketsApp (Either (Reply rep) (Complete com)) (Either (Subscribe sub) (Supply sup)) (WebSocketServerRPCT sub sup m) -> m (WebSocketsApp (Either (Reply rep) (Complete com)) (Either (Subscribe sub) (Supply sup)) m)