Safe Haskell	None
Language	Haskell2010

Network.MessagePack.Types

Synopsis

type Request ix = (Int, Int, ix, [Object])
type Response = (Int, Int, Object, Object)
packRequest :: (Eq mth, MessagePack mth) => [mth] -> Request mth -> ByteString
packResponse :: Response -> ByteString
unpackRequest :: MessagePack ix => Object -> Either DecodeError (Request ix)
unpackResponse :: Object -> Either DecodeError Response
data MethodVal = MethodVal {
- valName :: Text
- valType :: Text
}
data MethodDocs = MethodDocs {
- methodArgs :: [MethodVal]
- methodRetv :: MethodVal
}
class Monad m => MethodType m f where
- toBody :: Text -> f -> [Object] -> m Object
data Method m = Method {
- methodName :: Text
- methodDocs :: MethodDocs
- methodBody :: [Object] -> m Object
}
method :: MethodType m f => Text -> MethodDocs -> f -> Method m
data RpcError
- = RemoteError Object
- | ResultTypeError Text Object
- | ProtocolError Text
newtype ServerError = ServerError Text
class RpcType r where
- rpcc :: Text -> [Object] -> r
call :: RpcType a => Text -> a

Documentation

type Request ix = (Int, Int, ix, [Object]) Source #

type Response = (Int, Int, Object, Object) Source #

packRequest :: (Eq mth, MessagePack mth) => [mth] -> Request mth -> ByteString Source #

packResponse :: Response -> ByteString Source #

unpackRequest :: MessagePack ix => Object -> Either DecodeError (Request ix) Source #

unpackResponse :: Object -> Either DecodeError Response Source #

data MethodVal Source #

Constructors

MethodVal
Fields valName :: Text valType :: Text

Instances

Instances details

Eq MethodVal Source #
Instance details Defined in Network.MessagePack.Types.Server Methods (==) :: MethodVal -> MethodVal -> Bool # (/=) :: MethodVal -> MethodVal -> Bool #
Read MethodVal Source #
Instance details Defined in Network.MessagePack.Types.Server Methods readsPrec :: Int -> ReadS MethodVal # readList :: ReadS [MethodVal] # readPrec :: ReadPrec MethodVal # readListPrec :: ReadPrec [MethodVal] #
Show MethodVal Source #
Instance details Defined in Network.MessagePack.Types.Server Methods showsPrec :: Int -> MethodVal -> ShowS # show :: MethodVal -> String # showList :: [MethodVal] -> ShowS #

data MethodDocs Source #

MessagePack RPC method

Constructors

MethodDocs
Fields methodArgs :: [MethodVal] methodRetv :: MethodVal

Instances

Instances details

Eq MethodDocs Source #
Instance details Defined in Network.MessagePack.Types.Server Methods (==) :: MethodDocs -> MethodDocs -> Bool # (/=) :: MethodDocs -> MethodDocs -> Bool #
Read MethodDocs Source #
Instance details Defined in Network.MessagePack.Types.Server Methods readsPrec :: Int -> ReadS MethodDocs # readList :: ReadS [MethodDocs] # readPrec :: ReadPrec MethodDocs # readListPrec :: ReadPrec [MethodDocs] #
Show MethodDocs Source #
Instance details Defined in Network.MessagePack.Types.Server Methods showsPrec :: Int -> MethodDocs -> ShowS # show :: MethodDocs -> String # showList :: [MethodDocs] -> ShowS #

class Monad m => MethodType m f where Source #

Methods

toBody :: Text -> f -> [Object] -> m Object Source #

Create a RPC method from a Haskell function

Instances

Instances details

(Functor m, MonadThrow m, MessagePack o) => MethodType m (ServerT m o) Source #
Instance details Defined in Network.MessagePack.Server.Basic Methods toBody :: Text -> ServerT m o -> [Object] -> m Object Source #
(MonadThrow m, MessagePack o, MethodType m r) => MethodType m (o -> r) Source #
Instance details Defined in Network.MessagePack.Server.Basic Methods toBody :: Text -> (o -> r) -> [Object] -> m Object Source #

data Method m Source #

Constructors

Method
Fields methodName :: Text methodDocs :: MethodDocs methodBody :: [Object] -> m Object

method Source #

Arguments

:: MethodType m f
=> Text	Method name
-> MethodDocs
-> f	Method body
-> Method m

Build a method

data RpcError Source #

RPC error type

Constructors

RemoteError Object	Server error
ResultTypeError Text Object	Result type mismatch
ProtocolError Text	Protocol error

Instances

Instances details

Eq RpcError Source #
Instance details Defined in Network.MessagePack.Types.Error Methods (==) :: RpcError -> RpcError -> Bool # (/=) :: RpcError -> RpcError -> Bool #
Ord RpcError Source #
Instance details Defined in Network.MessagePack.Types.Error 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 Source #
Instance details Defined in Network.MessagePack.Types.Error Methods showsPrec :: Int -> RpcError -> ShowS # show :: RpcError -> String # showList :: [RpcError] -> ShowS #
Exception RpcError Source #
Instance details Defined in Network.MessagePack.Types.Error Methods toException :: RpcError -> SomeException # fromException :: SomeException -> Maybe RpcError # displayException :: RpcError -> String #

newtype ServerError Source #

Constructors

ServerError Text

Instances

Instances details

Show ServerError Source #
Instance details Defined in Network.MessagePack.Types.Error Methods showsPrec :: Int -> ServerError -> ShowS # show :: ServerError -> String # showList :: [ServerError] -> ShowS #
Exception ServerError Source #
Instance details Defined in Network.MessagePack.Types.Error Methods toException :: ServerError -> SomeException # fromException :: SomeException -> Maybe ServerError # displayException :: ServerError -> String #

class RpcType r where Source #

Methods

rpcc :: Text -> [Object] -> r Source #

Instances

Instances details

(MessagePack o, RpcType r) => RpcType (o -> r) Source #
Instance details Defined in Network.MessagePack.Types.Client Methods rpcc :: Text -> [Object] -> o -> r Source #
(MonadIO m, MonadThrow m, MessagePack o) => RpcType (ClientT m o) Source #
Instance details Defined in Network.MessagePack.Client.Internal Methods rpcc :: Text -> [Object] -> ClientT m o Source #

call :: RpcType a => Text -> a Source #

Call an RPC Method