Network.JsonRpc

Contents

• Introduction
• Establish JSON-RPC context
• Conduits for encoding/decoding
• Communicate with remote party
  • Dummies
• Transports
  • Client
  • Server
• Requests
  • Parsing
  • Encoding
• Responses
  • Parsing
  • Encoding
• Notifications
  • Parsing
  • Encoding
• Errors
  • Error Messages
• Others

Synopsis

• type JsonRpcT = ReaderT Session
• runJsonRpcT :: (MonadLoggerIO m, MonadBaseControl IO m, FromRequest q, ToJSON r) => Ver -> Respond q m r -> Sink Message m () -> Source m (Either Err Message) -> JsonRpcT m a -> m a
• decodeConduit :: MonadLogger m => Ver -> Conduit ByteString m (Either Err Message)
• encodeConduit :: MonadLogger m => Conduit Message m ByteString
• sendRequest :: (MonadLoggerIO m, ToJSON q, ToRequest q, FromResponse r) => q -> JsonRpcT m (Either ErrorObj (Maybe r))
• sendNotif :: (ToJSON no, ToNotif no, MonadLoggerIO m) => no -> JsonRpcT m ()
• receiveNotif :: (MonadLoggerIO m, FromNotif n) => JsonRpcT m (Maybe (Either ErrorObj (Maybe n)))
• dummyRespond :: MonadLoggerIO m => Respond () m ()
• dummySrv :: MonadLoggerIO m => JsonRpcT m ()
• jsonRpcTcpClient :: (MonadLoggerIO m, MonadBaseControl IO m, FromRequest q, ToJSON r) => Ver -> ClientSettings -> Respond q m r -> JsonRpcT m a -> m a
• jsonRpcTcpServer :: (MonadLoggerIO m, MonadBaseControl IO m, FromRequest q, ToJSON r) => Ver -> ServerSettings -> Respond q m r -> JsonRpcT m () -> m a
• data Request = Request {
  • getReqVer :: !Ver
  • getReqMethod :: !Method
  • getReqParams :: !Value
  • getReqId :: !Id
  }
• class FromRequest q where
  • parseParams :: Method -> Maybe (Value -> Parser q)
• fromRequest :: FromRequest q => Request -> Maybe q
• class ToRequest q where
  • requestMethod :: q -> Method
• buildRequest :: (ToJSON q, ToRequest q) => Ver -> q -> Id -> Request
• data Response = Response {
  • getResVer :: !Ver
  • getResult :: !Value
  • getResId :: !Id
  }
• class FromResponse r where
  • parseResult :: Method -> Maybe (Value -> Parser r)
• fromResponse :: FromResponse r => Method -> Response -> Maybe r
• type Respond q m r = q -> m (Either ErrorObj r)
• buildResponse :: (Monad m, FromRequest q, ToJSON r) => Respond q m r -> Request -> m (Either Err Response)
• data Notif = Notif {
  • getNotifVer :: !Ver
  • getNotifMethod :: !Method
  • getNotifParams :: !Value
  }
• class FromNotif n where
  • parseNotif :: Method -> Maybe (Value -> Parser n)
• fromNotif :: FromNotif n => Notif -> Maybe n
• class ToNotif n where
  • notifMethod :: n -> Method
• buildNotif :: (ToJSON n, ToNotif n) => Ver -> n -> Notif
• data Err = Err {
  • getErrVer :: !Ver
  • getErrObj :: !ErrorObj
  • getErrId :: !Id
  }
• data ErrorObj
  • = ErrorObj {
    • getErrMsg :: !String
    • getErrCode :: !Int
    • getErrData :: !Value
    }
  • | ErrorVal {
    • getErrData :: !Value
    }
• fromError :: ErrorObj -> String
• errorParse :: Value -> ErrorObj
• errorInvalid :: Value -> ErrorObj
• errorParams :: Value -> ErrorObj
• errorMethod :: Method -> ErrorObj
• errorId :: Id -> ErrorObj
• data Message
  • = MsgRequest {
    • getMsgRequest :: !Request
    }
  • | MsgResponse {
    • getMsgResponse :: !Response
    }
  • | MsgNotif {
    • getMsgNotif :: !Notif
    }
  • | MsgError {
    • getMsgError :: !Err
    }
• type Method = Text
• data Id
  • = IdInt {
    • getIdInt :: !Int
    }
  • | IdTxt {
    • getIdTxt :: !Text
    }
  • | IdNull
• fromId :: Id -> String
• data Ver
  • = V1
  • | V2

Introduction

Establish JSON-RPC context

Conduits for encoding/decoding

Communicate with remote party

Dummies

Transports

Client

Server

Requests

Parsing

Encoding

Responses

Parsing

Encoding

Notifications

Parsing

Encoding

Errors

Error Messages

Others