Safe Haskell	None
Language	Haskell2010

Network.JSONRPC

Contents

Introduction

Synopsis

data Session = Session {
- inCh :: TBMChan (Either Response Value)
- outCh :: TBMChan Message
- reqCh :: Maybe (TBMChan BatchRequest)
- lastId :: TVar Id
- sentReqs :: TVar SentRequests
- rpcVer :: Ver
- dead :: TVar Bool
}
type JSONRPCT = ReaderT Session
runJSONRPCT :: (MonadLoggerIO m, MonadUnliftIO m) => Ver -> Bool -> ConduitT ByteString Void m () -> ConduitT () ByteString m () -> JSONRPCT m a -> m a
decodeConduit :: forall (m :: Type -> Type). MonadLogger m => Ver -> ConduitT ByteString (Either Response Value) m ()
encodeConduit :: forall j (m :: Type -> Type). (ToJSON j, MonadLogger m) => ConduitT j ByteString m ()
receiveRequest :: forall (m :: Type -> Type). MonadLoggerIO m => JSONRPCT m (Maybe Request)
receiveBatchRequest :: forall (m :: Type -> Type). MonadLoggerIO m => JSONRPCT m (Maybe BatchRequest)
sendResponse :: forall (m :: Type -> Type). MonadLoggerIO m => Response -> JSONRPCT m ()
sendBatchResponse :: forall (m :: Type -> Type). MonadLoggerIO m => BatchResponse -> JSONRPCT m ()
sendRequest :: forall (m :: Type -> Type) q r. (MonadLoggerIO m, ToJSON q, ToRequest q, FromResponse r) => q -> JSONRPCT m (Maybe (Either ErrorObj r))
sendBatchRequest :: forall (m :: Type -> Type) q r. (MonadLoggerIO m, ToJSON q, ToRequest q, FromResponse r) => [q] -> JSONRPCT m [Maybe (Either ErrorObj r)]
jsonrpcTCPClient :: (MonadLoggerIO m, MonadUnliftIO m) => Ver -> Bool -> ClientSettings -> JSONRPCT m a -> m a
jsonrpcTCPServer :: (MonadLoggerIO m, MonadUnliftIO m) => Ver -> Bool -> ServerSettings -> JSONRPCT m () -> m a
type SentRequests = HashMap Id (TMVar (Maybe Response))
initSession :: Ver -> Bool -> STM Session
processIncoming :: forall (m :: Type -> Type). (Functor m, MonadLoggerIO m) => JSONRPCT m ()
sendMessage :: forall (m :: Type -> Type). MonadLoggerIO m => Message -> JSONRPCT m ()
data Ver
- = V1
- | V2
data Message
- = MsgRequest {
  - getMsgRequest :: !Request
  }
- | MsgResponse {
  - getMsgResponse :: !Response
  }
- | MsgBatch {
  - getBatch :: ![Message]
  }
data Id
- = IdInt {
  - getIdInt :: !Int
  }
- | IdTxt {
  - getIdTxt :: !Text
  }
type Method = Text
data Request
- = Request {
  - getReqVer :: !Ver
  - getReqMethod :: !Method
  - getReqParams :: !Value
  - getReqId :: !Id
  }
- | Notif {
  - getReqVer :: !Ver
  - getReqMethod :: !Method
  - getReqParams :: !Value
  }
data BatchRequest
- = BatchRequest {
  - getBatchRequest :: ![Request]
  }
- | SingleRequest {
  - getSingleRequest :: !Request
  }
class FromRequest q where
- parseParams :: Method -> Maybe (Value -> Parser q)
fromRequest :: FromRequest q => Request -> Either ErrorObj q
class ToRequest q where
- requestMethod :: q -> Method
- requestIsNotif :: q -> Bool
buildRequest :: (ToJSON q, ToRequest q) => Ver -> q -> Id -> Request
data Response
- = Response {
  - getResVer :: !Ver
  - getResult :: !Value
  - getResId :: !Id
  }
- | ResponseError {
  - getResVer :: !Ver
  - getError :: !ErrorObj
  - getResId :: !Id
  }
- | OrphanError {
  - getResVer :: !Ver
  - getError :: !ErrorObj
  }
data BatchResponse
- = BatchResponse {
  - getBatchResponse :: ![Response]
  }
- | SingleResponse {
  - getSingleResponse :: !Response
  }
class FromResponse r where
- parseResult :: Method -> Maybe (Value -> Parser r)
fromResponse :: FromResponse r => Method -> Response -> Maybe r
type Respond q (m :: Type -> Type) r = q -> m (Either ErrorObj r)
buildResponse :: (Monad m, FromRequest q, ToJSON r) => Respond q m r -> Request -> m (Maybe Response)
data ErrorObj
- = ErrorObj {
  - getErrMsg :: !String
  - getErrCode :: !Int
  - getErrData :: !Value
  }
- | ErrorVal {
  - getErrData :: !Value
  }
fromError :: ErrorObj -> String
errorParse :: ByteString -> ErrorObj
errorInvalid :: Value -> ErrorObj
errorParams :: Value -> String -> ErrorObj
errorMethod :: Method -> ErrorObj
errorId :: Id -> ErrorObj
fromId :: Id -> String

Introduction

This JSON-RPC library is fully-compatible with JSON-RPC 2.0 and 1.0. It provides an interface that combines a JSON-RPC client and server. It can set and keep track of request ids to parse responses. There is support for sending and receiving notifications. You may use any underlying transport. Basic TCP client and server provided.

A JSON-RPC application using this interface is considered to be peer-to-peer, as it can send and receive all types of JSON-RPC message independent of whether it originated the connection.

data Session Source #

Constructors

Session
Fields inCh :: TBMChan (Either Response Value) outCh :: TBMChan Message reqCh :: Maybe (TBMChan BatchRequest) lastId :: TVar Id sentReqs :: TVar SentRequests rpcVer :: Ver dead :: TVar Bool

type JSONRPCT = ReaderT Session Source #

runJSONRPCT Source #

Arguments

:: (MonadLoggerIO m, MonadUnliftIO m)
=> Ver	JSON-RPC version
-> Bool	Ignore incoming requests/notifs
-> ConduitT ByteString Void m ()	Sink to send messages
-> ConduitT () ByteString m ()	Source to receive messages from
-> JSONRPCT m a	JSON-RPC action
-> m a	Output of action

Create JSON-RPC session around conduits from transport layer. When context exits session disappears.

decodeConduit :: forall (m :: Type -> Type). MonadLogger m => Ver -> ConduitT ByteString (Either Response Value) m () Source #

Conduit to decode incoming messages. Left Response indicates a response to send back to sender if parsing JSON fails.

encodeConduit :: forall j (m :: Type -> Type). (ToJSON j, MonadLogger m) => ConduitT j ByteString m () Source #

receiveRequest :: forall (m :: Type -> Type). MonadLoggerIO m => JSONRPCT m (Maybe Request) Source #

Receive requests from remote endpoint. Returns Nothing if incoming channel is closed or has never been opened. Will reject incoming request if sent in a batch.

receiveBatchRequest :: forall (m :: Type -> Type). MonadLoggerIO m => JSONRPCT m (Maybe BatchRequest) Source #

Receive batch of requests. Will also accept single requests.

sendResponse :: forall (m :: Type -> Type). MonadLoggerIO m => Response -> JSONRPCT m () Source #

Send response message. Do not use to respond to a batch of requests.

sendBatchResponse :: forall (m :: Type -> Type). MonadLoggerIO m => BatchResponse -> JSONRPCT m () Source #

Send batch of responses. Use to respond to a batch of requests.

sendRequest :: forall (m :: Type -> Type) q r. (MonadLoggerIO m, ToJSON q, ToRequest q, FromResponse r) => q -> JSONRPCT m (Maybe (Either ErrorObj r)) Source #

Returns Nothing if did not receive response, could not parse it, or request is a notification. Just Left contains the error object returned by server if any. Just Right means response was received just right.

sendBatchRequest :: forall (m :: Type -> Type) q r. (MonadLoggerIO m, ToJSON q, ToRequest q, FromResponse r) => [q] -> JSONRPCT m [Maybe (Either ErrorObj r)] Source #

Send multiple requests in a batch. If only a single request, do not put it in a batch.

jsonrpcTCPClient Source #

Arguments

:: (MonadLoggerIO m, MonadUnliftIO m)
=> Ver	JSON-RPC version
-> Bool	Ignore incoming requests or notifications
-> ClientSettings	Connection settings
-> JSONRPCT m a	JSON-RPC action
-> m a	Output of action

TCP client transport for JSON-RPC.

jsonrpcTCPServer Source #

Arguments

:: (MonadLoggerIO m, MonadUnliftIO m)
=> Ver	JSON-RPC version
-> Bool	Ignore incoming requests or notifications
-> ServerSettings	Connection settings
-> JSONRPCT m ()	Action to perform on connecting client thread
-> m a

TCP server transport for JSON-RPC.

type SentRequests = HashMap Id (TMVar (Maybe Response)) Source #

initSession :: Ver -> Bool -> STM Session Source #

processIncoming :: forall (m :: Type -> Type). (Functor m, MonadLoggerIO m) => JSONRPCT m () Source #

Process incoming messages. Do not use this directly unless you know what you are doing. This is an internal function.

sendMessage :: forall (m :: Type -> Type). MonadLoggerIO m => Message -> JSONRPCT m () Source #

Send any message. Do not use this. Use the other high-level functions instead. Will not track request ids. Incoming responses to requests sent using this method will be ignored.

data Ver Source #

JSON-RPC version.

Constructors

V1	JSON-RPC 1.0
V2	JSON-RPC 2.0

Instances

Instances details

Arbitrary Ver Source #

Instance details

Defined in Network.JSONRPC.Arbitrary

Methods

arbitrary :: Gen Ver #

shrink :: Ver -> [Ver] #

Generic Ver Source #

Instance details

MsgRequest
Fields getMsgRequest :: !Request
MsgResponse
Fields getMsgResponse :: !Response
MsgBatch
Fields getBatch :: ![Message]

Request
Fields getReqVer :: !Ver getReqMethod :: !Method getReqParams :: !Value getReqId :: !Id
Notif
Fields getReqVer :: !Ver getReqMethod :: !Method getReqParams :: !Value

BatchRequest
Fields getBatchRequest :: ![Request]
SingleRequest
Fields getSingleRequest :: !Request

FromRequest Value Source #
Instance details Defined in Network.JSONRPC.Data Methods parseParams :: Method -> Maybe (Value -> Parser Value) Source #
FromRequest () Source #
Instance details Defined in Network.JSONRPC.Data Methods parseParams :: Method -> Maybe (Value -> Parser ()) Source #

ToRequest Value Source #
Instance details Defined in Network.JSONRPC.Data Methods requestMethod :: Value -> Method Source # requestIsNotif :: Value -> Bool Source #
ToRequest () Source #
Instance details Defined in Network.JSONRPC.Data Methods requestMethod :: () -> Method Source # requestIsNotif :: () -> Bool Source #

:: (ToJSON q, ToRequest q)
=> Ver	JSON-RPC version
-> q	Request data
-> Id
-> Request

Response
Fields getResVer :: !Ver getResult :: !Value getResId :: !Id
ResponseError
Fields getResVer :: !Ver getError :: !ErrorObj getResId :: !Id
OrphanError
Fields getResVer :: !Ver getError :: !ErrorObj

BatchResponse
Fields getBatchResponse :: ![Response]
SingleResponse
Fields getSingleResponse :: !Response

FromResponse Value Source #
Instance details Defined in Network.JSONRPC.Data Methods parseResult :: Method -> Maybe (Value -> Parser Value) Source #
FromResponse () Source #
Instance details Defined in Network.JSONRPC.Data Methods parseResult :: Method -> Maybe (Value -> Parser ()) Source #

ErrorObj
Fields getErrMsg :: !String getErrCode :: !Int getErrData :: !Value
ErrorVal
Fields getErrData :: !Value

IdInt
Fields getIdInt :: !Int
IdTxt
Fields getIdTxt :: !Text