Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Federation.Client

Synopsis

data FederatorClientEnv = FederatorClientEnv {
- ceOriginDomain :: Domain
- ceTargetDomain :: Domain
- ceFederator :: Endpoint
- ceHttp2Manager :: Http2Manager
- ceOriginRequestId :: RequestId
}
data FederatorClientVersionedEnv = FederatorClientVersionedEnv {
- cveEnv :: FederatorClientEnv
- cveVersion :: Maybe Version
}
unversionedEnv :: FederatorClientEnv -> FederatorClientVersionedEnv
data FederatorClient (c :: Component) a
runFederatorClient :: FederatorClientEnv -> FederatorClient c a -> IO (Either FederatorClientError a)
runVersionedFederatorClient :: FederatorClientVersionedEnv -> FederatorClient c a -> IO (Either FederatorClientError a)
runFederatorClientToCodensity :: forall c a. FederatorClientEnv -> FederatorClient c a -> Codensity IO (Either FederatorClientError a)
runVersionedFederatorClientToCodensity :: FederatorClientVersionedEnv -> FederatorClient c a -> ExceptT FederatorClientError (Codensity IO) a
getNegotiatedVersion :: FederatorClient c (Maybe Version)
performHTTP2Request :: Http2Manager -> Target -> Request -> IO (Either FederatorClientHTTP2Error (ResponseF Builder))
consumeStreamingResponseWith :: (StreamingResponse -> a) -> Response -> a
streamingResponseStrictBody :: StreamingResponse -> IO Builder
headersFromTable :: TokenHeaderTable -> [Header]

Documentation

data FederatorClientEnv Source #

Constructors

FederatorClientEnv
Fields ceOriginDomain :: Domain ceTargetDomain :: Domain ceFederator :: Endpoint ceHttp2Manager :: Http2Manager ceOriginRequestId :: RequestId

data FederatorClientVersionedEnv Source #

Constructors

FederatorClientVersionedEnv
Fields cveEnv :: FederatorClientEnv cveVersion :: Maybe Version

Instances

Instances details

MonadReader FederatorClientVersionedEnv (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods ask :: FederatorClient c FederatorClientVersionedEnv # local :: (FederatorClientVersionedEnv -> FederatorClientVersionedEnv) -> FederatorClient c a -> FederatorClient c a # reader :: (FederatorClientVersionedEnv -> a) -> FederatorClient c a #

unversionedEnv :: FederatorClientEnv -> FederatorClientVersionedEnv Source #

data FederatorClient (c :: Component) a Source #

A request to a remote backend. The API version of the remote backend is in the environment. The MaybeT layer is used to match endpoint versions (via the Alternative and VersionedMonad instances).

Instances

Instances details

FederationMonad FederatorClient Source #
Instance details Defined in Wire.API.Federation.API Methods fedClientWithProxy :: forall {k} (comp :: Component) (name :: k) api. (HasClient (FederatorClient comp) api, HasFedEndpoint comp api name, KnownComponent comp, IsNamed name, Typeable (Client (FederatorClient comp) api)) => Proxy name -> Proxy api -> Proxy (FederatorClient comp) -> Client (FederatorClient comp) api Source #
MonadError FederatorClientError (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods throwError :: FederatorClientError -> FederatorClient c a # catchError :: FederatorClient c a -> (FederatorClientError -> FederatorClient c a) -> FederatorClient c a #
MonadReader FederatorClientVersionedEnv (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods ask :: FederatorClient c FederatorClientVersionedEnv # local :: (FederatorClientVersionedEnv -> FederatorClientVersionedEnv) -> FederatorClient c a -> FederatorClient c a # reader :: (FederatorClientVersionedEnv -> a) -> FederatorClient c a #
VersionedMonad Version (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods guardVersion :: (Version -> Bool) -> FederatorClient c () Source #
MonadIO (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods liftIO :: IO a -> FederatorClient c a #
Alternative (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods empty :: FederatorClient c a # (<\|>) :: FederatorClient c a -> FederatorClient c a -> FederatorClient c a # some :: FederatorClient c a -> FederatorClient c [a] # many :: FederatorClient c a -> FederatorClient c [a] #
Applicative (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods pure :: a -> FederatorClient c a # (<>) :: FederatorClient c (a -> b) -> FederatorClient c a -> FederatorClient c b # liftA2 :: (a -> b -> c0) -> FederatorClient c a -> FederatorClient c b -> FederatorClient c c0 # (>) :: FederatorClient c a -> FederatorClient c b -> FederatorClient c b # (<*) :: FederatorClient c a -> FederatorClient c b -> FederatorClient c a #
Functor (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods fmap :: (a -> b) -> FederatorClient c a -> FederatorClient c b # (<$) :: a -> FederatorClient c b -> FederatorClient c a #
Monad (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods (>>=) :: FederatorClient c a -> (a -> FederatorClient c b) -> FederatorClient c b # (>>) :: FederatorClient c a -> FederatorClient c b -> FederatorClient c b # return :: a -> FederatorClient c a #
KnownComponent c => RunClient (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods runRequestAcceptStatus :: Maybe [Status] -> Request -> FederatorClient c Response Source # throwClientError :: ClientError -> FederatorClient c a Source #
KnownComponent c => RunStreamingClient (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods withStreamingRequest :: Request -> (StreamingResponse -> IO a) -> FederatorClient c a Source #

runFederatorClient :: FederatorClientEnv -> FederatorClient c a -> IO (Either FederatorClientError a) Source #

Run federator client synchronously.

runVersionedFederatorClient :: FederatorClientVersionedEnv -> FederatorClient c a -> IO (Either FederatorClientError a) Source #

runFederatorClientToCodensity :: forall c a. FederatorClientEnv -> FederatorClient c a -> Codensity IO (Either FederatorClientError a) Source #

runVersionedFederatorClientToCodensity :: FederatorClientVersionedEnv -> FederatorClient c a -> ExceptT FederatorClientError (Codensity IO) a Source #

getNegotiatedVersion :: FederatorClient c (Maybe Version) Source #

performHTTP2Request :: Http2Manager -> Target -> Request -> IO (Either FederatorClientHTTP2Error (ResponseF Builder)) Source #

consumeStreamingResponseWith :: (StreamingResponse -> a) -> Response -> a Source #

streamingResponseStrictBody :: StreamingResponse -> IO Builder Source #

headersFromTable :: TokenHeaderTable -> [Header] Source #