Safe Haskell	Safe-Inferred
Language	GHC2021

Bilge.RPC

Synopsis

class HasRequestId m where
- getRequestId :: m RequestId
data RPCException = RPCException {
- rpceRemote :: !LText
- rpceRequest :: !Request
- rpceCause :: !SomeException
}
rpc :: (MonadUnliftIO m, MonadCatch m, MonadHttp m, HasRequestId m) => LText -> (Request -> Request) -> m (Response (Maybe LByteString))
rpc' :: (MonadUnliftIO m, MonadCatch m, MonadHttp m, HasRequestId m) => LText -> Request -> (Request -> Request) -> m (Response (Maybe LByteString))
parseResponse :: (Exception e, MonadThrow m, FromJSON a) => (LText -> e) -> Response (Maybe LByteString) -> m a
rpcExceptionMsg :: RPCException -> Msg -> Msg

Documentation

class HasRequestId m where Source #

Methods

getRequestId :: m RequestId Source #

Instances

Instances details

Monad m => HasRequestId (ReaderT RequestId m) Source #
Instance details Defined in Bilge.RPC Methods getRequestId :: ReaderT RequestId m RequestId Source #

data RPCException Source #

Constructors

RPCException
Fields rpceRemote :: !LText rpceRequest :: !Request rpceCause :: !SomeException

Instances

Instances details

Exception RPCException Source #
Instance details Defined in Bilge.RPC Methods toException :: RPCException -> SomeException # fromException :: SomeException -> Maybe RPCException # displayException :: RPCException -> String #
Show RPCException Source #
Instance details Defined in Bilge.RPC Methods showsPrec :: Int -> RPCException -> ShowS # show :: RPCException -> String # showList :: [RPCException] -> ShowS #

rpc :: (MonadUnliftIO m, MonadCatch m, MonadHttp m, HasRequestId m) => LText -> (Request -> Request) -> m (Response (Maybe LByteString)) Source #

rpc' Source #

Arguments

:: (MonadUnliftIO m, MonadCatch m, MonadHttp m, HasRequestId m)
=> LText	A label for the remote system in case of `RPCException`s.
-> Request
-> (Request -> Request)
-> m (Response (Maybe LByteString))

Perform an HTTP request and return the response, thereby forwarding the Request-Id header from the current monadic context. Note: syncIO is wrapped around the IO action performing the request and any exceptions caught are re-thrown in an RPCException.

parseResponse :: (Exception e, MonadThrow m, FromJSON a) => (LText -> e) -> Response (Maybe LByteString) -> m a Source #

rpcExceptionMsg :: RPCException -> Msg -> Msg Source #