Control.TimeWarp.Rpc.MonadRpc

This module contains MonadRpc typeclass which abstracts over RPC communication.

Documentation

type Port = Int

Port number.

type Host = ByteString

Host address.

type NetworkAddress = (Host, Port)

Full node address.

class MonadThrow r => MonadRpc r where

Defines protocol of RPC layer.

Minimal complete definition

execClient, serve

Methods

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

Executes remote method call.

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

Starts RPC server with a set of RPC methods.

Instances

MonadRpc MsgPackRpc

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> MsgPackRpc a

serve :: Port -> [Method MsgPackRpc] -> MsgPackRpc ()

MonadRpc m => MonadRpc (LoggerNameBox m)

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> LoggerNameBox m a

serve :: Port -> [Method (LoggerNameBox m)] -> LoggerNameBox m ()

(MonadIO m, MonadCatch m) => MonadRpc (PureRpc m)

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> PureRpc m a

serve :: Port -> [Method (PureRpc m)] -> PureRpc m ()

MonadRpc m => MonadRpc (ReaderT * r m)

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> ReaderT * r m a

serve :: Port -> [Method (ReaderT * r m)] -> ReaderT * r m ()

class RpcType t

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)

Methods

rpcc :: String -> [Object] -> Client o

(RpcType t, MessagePack p) => RpcType (p -> t)

Methods

rpcc :: String -> [Object] -> p -> t

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

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

data Method m

Keeps method definition.

Constructors

Method

Fields

• methodName :: String
• methodBody :: [Object] -> m Object

data Client a where

Keeps function name and arguments.

Constructors

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

Instances

MessagePack o => RpcType (Client o)

Methods

rpcc :: String -> [Object] -> Client o

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

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

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

Methods

toBody :: Object -> [Object] -> m Object

MonadThrow m => MonadThrow (ServerT m)

Methods

throwM :: Exception e => e -> ServerT m a

MonadCatch m => MonadCatch (ServerT m)

Methods

catch :: Exception e => ServerT m a -> (e -> ServerT m a) -> ServerT m a

WithNamedLogger m => WithNamedLogger (ServerT m)

Methods

getLoggerName :: ServerT m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> ServerT m a -> ServerT m a