Servant.Server.JsonRpc

This module provides support for writing handlers for JSON-RPC endpoints

type Mul = JsonRpc "mul" (Int, Int) String Int
mulHandler :: (Int, Int) -> Handler (Either (JsonRpcErr String) Int)
mulHandler = _

type Add = JsonRpc "add" (Int, Int) String Int
addHandler :: (Int, Int) -> Handler (Either (JsonRpcErr String) Int)
addHandler = _

type API = Add :<|> Mul
server :: Application
server = serve (Proxy @(RawJsonRpc API)) $ addHandler :<|> mulHandler

Documentation

serveJsonRpc :: (Monad m, RouteJsonRpc a) => Proxy a -> Proxy m -> RpcHandler a m -> Request Value -> m PossibleJsonRpcResponse

This function is the glue required to convert a collection of handlers in servant standard style to the handler that RawJsonRpc expects.

class RouteJsonRpc a where

This internal class is how we accumulate a map of handlers for dispatch

Associated Types

type RpcHandler a (m :: Type -> Type)

Methods

jsonRpcRouter :: Monad m => Proxy a -> Proxy m -> RpcHandler a m -> Map String (Value -> m (PossibleContent (Either (JsonRpcErr Value) Value)))

hoistRpcRouter :: Proxy a -> (forall x. m x -> n x) -> RpcHandler a m -> RpcHandler a n

Instances

(RouteJsonRpc a, RouteJsonRpc b) => RouteJsonRpc (a :<|> b)

Defined in Servant.Server.JsonRpc

Associated Types

type RpcHandler (a :<|> b) m

Methods

jsonRpcRouter :: Monad m => Proxy (a :<|> b) -> Proxy m -> RpcHandler (a :<|> b) m -> Map String (Value -> m (PossibleContent (Either (JsonRpcErr Value) Value)))

hoistRpcRouter :: Proxy (a :<|> b) -> (forall x. m x -> n x) -> RpcHandler (a :<|> b) m -> RpcHandler (a :<|> b) n

(KnownSymbol method, FromJSON p) => RouteJsonRpc (JsonRpcNotification method p)

Defined in Servant.Server.JsonRpc

Associated Types

type RpcHandler (JsonRpcNotification method p) m

Methods

jsonRpcRouter :: Monad m => Proxy (JsonRpcNotification method p) -> Proxy m -> RpcHandler (JsonRpcNotification method p) m -> Map String (Value -> m (PossibleContent (Either (JsonRpcErr Value) Value)))

hoistRpcRouter :: Proxy (JsonRpcNotification method p) -> (forall x. m x -> n x) -> RpcHandler (JsonRpcNotification method p) m -> RpcHandler (JsonRpcNotification method p) n

(KnownSymbol method, FromJSON p, ToJSON e, ToJSON r) => RouteJsonRpc (JsonRpc method p e r)

Defined in Servant.Server.JsonRpc

Associated Types

type RpcHandler (JsonRpc method p e r) m

Methods

jsonRpcRouter :: Monad m => Proxy (JsonRpc method p e r) -> Proxy m -> RpcHandler (JsonRpc method p e r) m -> Map String (Value -> m (PossibleContent (Either (JsonRpcErr Value) Value)))

hoistRpcRouter :: Proxy (JsonRpc method p e r) -> (forall x. m x -> n x) -> RpcHandler (JsonRpc method p e r) m -> RpcHandler (JsonRpc method p e r) n

module Servant.JsonRpc

data PossibleContent a

Since we collapse an entire JSON RPC api down to a single Servant endpoint, we need a type that can return content but might not.

Instances

ToJSON a => ToJSON (PossibleContent a)

Defined in Servant.Server.JsonRpc

Methods

toJSON :: PossibleContent a -> Value

toEncoding :: PossibleContent a -> Encoding

toJSONList :: [PossibleContent a] -> Value

toEncodingList :: [PossibleContent a] -> Encoding

omitField :: PossibleContent a -> Bool

ToJSON a => AllCTRender '[JSONRPC] (PossibleContent a)

Defined in Servant.Server.JsonRpc

Methods

handleAcceptH :: Proxy '[JSONRPC] -> AcceptHeader -> PossibleContent a -> Maybe (ByteString, ByteString)

type PossibleJsonRpcResponse = PossibleContent (JsonRpcResponse Value Value)

Orphan instances

(RouteJsonRpc api, HasContextEntry (context .++ DefaultErrorFormatters) ErrorFormatters) => HasServer (RawJsonRpc ctype api :: Type) context

Associated Types

type ServerT (RawJsonRpc ctype api) m

Methods

route :: Proxy (RawJsonRpc ctype api) -> Context context -> Delayed env (Server (RawJsonRpc ctype api)) -> Router env

hoistServerWithContext :: Proxy (RawJsonRpc ctype api) -> Proxy context -> (forall x. m x -> n x) -> ServerT (RawJsonRpc ctype api) m -> ServerT (RawJsonRpc ctype api) n