Copyright	(c) Serokell, 2016
License	GPL-3 (see the file LICENSE)
Maintainer	Serokell <hi@serokell.io>
Stability	experimental
Portability	POSIX, GHC
Safe Haskell	None
Language	Haskell2010

Control.TimeWarp.Rpc.MonadRpc

Contents

Orphan instances

Description

This module contains MonadRpc typeclass which abstracts over RPC communication.

Synopsis

Documentation

type Port = Int Source #

Port number.

type Host = ByteString Source #

Host address.

type NetworkAddress = (Host, Port) Source #

Full node address.

class MonadThrow r => MonadRpc r where Source #

Defines protocol of RPC layer.

Minimal complete definition

execClient, serve

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> r a Source #

Executes remote method call.

serve :: Port -> [Method r] -> r () Source #

Starts RPC server with a set of RPC methods.

Instances

MonadRpc MsgPackRpc Source #
Methods execClient :: MessagePack a => NetworkAddress -> Client a -> MsgPackRpc a Source # serve :: Port -> [Method MsgPackRpc] -> MsgPackRpc () Source #
MonadRpc m => MonadRpc (LoggerNameBox m) Source #
Methods execClient :: MessagePack a => NetworkAddress -> Client a -> LoggerNameBox m a Source # serve :: Port -> [Method (LoggerNameBox m)] -> LoggerNameBox m () Source #
(MonadIO m, MonadCatch m) => MonadRpc (PureRpc m) Source #
Methods execClient :: MessagePack a => NetworkAddress -> Client a -> PureRpc m a Source # serve :: Port -> [Method (PureRpc m)] -> PureRpc m () Source #
MonadRpc m => MonadRpc (ReaderT * r m) Source #
Methods execClient :: MessagePack a => NetworkAddress -> Client a -> ReaderT * r m a Source # serve :: Port -> [Method (ReaderT * r m)] -> ReaderT * r m () Source #

class RpcType t Source #

Collects function name and arguments (it's msgpack-rpc implementation is hidden, need our own).

Minimal complete definition

rpcc

Instances

MessagePack o => RpcType (Client o) Source #
Methods rpcc :: String -> [Object] -> Client o
(RpcType t, MessagePack p) => RpcType (p -> t) Source #
Methods rpcc :: String -> [Object] -> p -> t

execClientTimeout :: (MonadTimed m, MonadRpc m, MessagePack a, TimeUnit t) => t -> NetworkAddress -> Client a -> m a Source #

Same as execClient, but allows to set up timeout for a call (see timeout).

data Method m Source #

Keeps method definition.

Constructors

Method
Fields methodName :: String methodBody :: [Object] -> m Object

data Client a where Source #

Keeps function name and arguments.

Constructors

Client :: MessagePack a => String -> [Object] -> Client a

Instances

MessagePack o => RpcType (Client o) Source #
Methods rpcc :: String -> [Object] -> Client o

method :: MethodType m f => String -> f -> Method m Source #

Creates method available for RPC-requests. It accepts method name (which would be refered by clients) and it's body.

call :: RpcType t => String -> t Source #

Creates a function call. It accepts function name and arguments.

type Server = ServerT IO #

data ServerT m a :: (* -> *) -> * -> * #

Instances

MonadTrans ServerT
Methods lift :: Monad m => m a -> ServerT m a #
(Functor m, MonadThrow m, MessagePack o) => MethodType m (ServerT m o)
Methods toBody :: ServerT m o -> [Object] -> m Object
Monad m => Monad (ServerT m)
Methods (>>=) :: ServerT m a -> (a -> ServerT m b) -> ServerT m b # (>>) :: ServerT m a -> ServerT m b -> ServerT m b # return :: a -> ServerT m a # fail :: String -> ServerT m a #
Functor m => Functor (ServerT m)
Methods fmap :: (a -> b) -> ServerT m a -> ServerT m b # (<$) :: a -> ServerT m b -> ServerT m a #
Applicative m => Applicative (ServerT m)
Methods pure :: a -> ServerT m a # (<>) :: ServerT m (a -> b) -> ServerT m a -> ServerT m b # (>) :: ServerT m a -> ServerT m b -> ServerT m b # (<*) :: ServerT m a -> ServerT m b -> ServerT m a #
MonadIO m => MonadIO (ServerT m)
Methods liftIO :: IO a -> ServerT m a #

class Monad m => MethodType m f #

Minimal complete definition

toBody

Instances

MethodType MsgPackRpc f => MethodType MsgPackRpc (MsgPackRpc f) #
Methods toBody :: MsgPackRpc f -> [Object] -> MsgPackRpc Object
(Functor m, MonadThrow m, MessagePack o) => MethodType m (ServerT m o)
Methods toBody :: ServerT m o -> [Object] -> m Object
(MonadThrow m, MessagePack o, MethodType m r) => MethodType m (o -> r)
Methods toBody :: (o -> r) -> [Object] -> m Object

data RpcError :: * #

Constructors

ServerError Object
ResultTypeError String Object
ProtocolError String

Instances

Eq RpcError
Methods (==) :: RpcError -> RpcError -> Bool # (/=) :: RpcError -> RpcError -> Bool #
Ord RpcError
Methods compare :: RpcError -> RpcError -> Ordering # (<) :: RpcError -> RpcError -> Bool # (<=) :: RpcError -> RpcError -> Bool # (>) :: RpcError -> RpcError -> Bool # (>=) :: RpcError -> RpcError -> Bool # max :: RpcError -> RpcError -> RpcError # min :: RpcError -> RpcError -> RpcError #
Show RpcError
Methods showsPrec :: Int -> RpcError -> ShowS # show :: RpcError -> String # showList :: [RpcError] -> ShowS #
Exception RpcError
Methods toException :: RpcError -> SomeException # fromException :: SomeException -> Maybe RpcError # displayException :: RpcError -> String #

Orphan instances

Monad m => MethodType m Object Source #
Methods toBody :: Object -> [Object] -> m Object
MonadThrow m => MonadThrow (ServerT m) Source #
Methods throwM :: Exception e => e -> ServerT m a #
MonadCatch m => MonadCatch (ServerT m) Source #
Methods catch :: Exception e => ServerT m a -> (e -> ServerT m a) -> ServerT m a #
WithNamedLogger m => WithNamedLogger (ServerT m) Source #
Methods getLoggerName :: ServerT m LoggerName Source # modifyLoggerName :: (LoggerName -> LoggerName) -> ServerT m a -> ServerT m a Source #