Network.JsonRpc.TinyClient

Tiny JSON-RPC 2.0 client. Functions for implementing the client side of JSON-RPC 2.0. See http://www.jsonrpc.org/specification.

If you have monad with MonadIO, MonadThrow and MonadReader instances, it can be used as base for JSON-RPC calls.

Example:

  newtype MyMonad a = ...

  instance JsonRpc MyMonad

  foo :: Mymonad Text
  foo = remote "foo"

Arguments of function are stored into params request array.

Example:

  myMethod :: JsonRpc m => Int -> Bool -> m String
  myMethod = remote "myMethod"

The JSON-RPC remote call monad

class JsonRpcM m => JsonRpc m where

JSON-RPC call monad.

Minimal complete definition

Nothing

Methods

remote :: Remote m a => MethodName -> a

Remote call of JSON-RPC method.

type MethodName = Text

Name of called method.

JSON-RPC client settings

data JsonRpcClient

JSON-RPC client state vars.

Constructors

JsonRpcHttpClient

Fields

• jsonRpcManager :: Manager

  HTTP connection manager.

• jsonRpcServer :: String

  Remote server URI.

JsonRpcWsClient

Fields

• jsonRpcWsConnection :: Connection

  WebSocket connection.

Instances

Show JsonRpcClient

Defined in Network.JsonRpc.TinyClient

Methods

showsPrec :: Int -> JsonRpcClient -> ShowS

show :: JsonRpcClient -> String

showList :: [JsonRpcClient] -> ShowS

defaultSettings

Arguments

:: MonadIO m

=> String

JSON-RPC server URI

-> m JsonRpcClient

Create default JsonRpcClient settings.

Error handling

data JsonRpcException

Constructors

ParsingException String

CallException RpcError

Instances

Eq JsonRpcException

Defined in Network.JsonRpc.TinyClient

Methods

(==) :: JsonRpcException -> JsonRpcException -> Bool

(/=) :: JsonRpcException -> JsonRpcException -> Bool

Show JsonRpcException

Defined in Network.JsonRpc.TinyClient

Methods

showsPrec :: Int -> JsonRpcException -> ShowS

show :: JsonRpcException -> String

showList :: [JsonRpcException] -> ShowS

Exception JsonRpcException

Defined in Network.JsonRpc.TinyClient

Methods

toException :: JsonRpcException -> SomeException

fromException :: SomeException -> Maybe JsonRpcException

displayException :: JsonRpcException -> String

data RpcError

JSON-RPC error message

Constructors

RpcError

Fields

• errCode :: !Int
• errMessage :: !Text
• errData :: !(Maybe Value)

Instances

Eq RpcError

Defined in Network.JsonRpc.TinyClient

Methods

(==) :: RpcError -> RpcError -> Bool

(/=) :: RpcError -> RpcError -> Bool

Show RpcError

Defined in Network.JsonRpc.TinyClient

Methods

showsPrec :: Int -> RpcError -> ShowS

show :: RpcError -> String

showList :: [RpcError] -> ShowS

FromJSON RpcError

Defined in Network.JsonRpc.TinyClient

Methods

parseJSON :: Value -> Parser RpcError

parseJSONList :: Value -> Parser [RpcError]