Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Federation.API

Contents

Re-exports

Synopsis

type family FedApi (comp :: Component) = (api :: Type) | api -> comp
type HasFedEndpoint comp api name = HasUnsafeFedEndpoint comp api name
type HasUnsafeFedEndpoint comp api name = 'Just api ~ LookupEndpoint (FedApi comp) name
class FederationMonad (fedM :: Component -> Type -> Type) where
- fedClientWithProxy :: forall (comp :: Component) name api. (HasClient (fedM comp) api, HasFedEndpoint comp api name, KnownComponent comp, IsNamed name, Typeable (Client (fedM comp) api)) => Proxy name -> Proxy api -> Proxy (fedM comp) -> Client (fedM comp) api
class IsNamed (name :: k) where
- nameVal' :: Text
nameVal :: forall {k} (name :: k). IsNamed name => Text
fedClient :: forall (comp :: Component) name fedM (showcomp :: Symbol) api. (showcomp ~ ShowComponent comp, HasFedEndpoint comp api name, HasClient (fedM comp) api, KnownComponent comp, IsNamed name, FederationMonad fedM, Typeable (Client (fedM comp) api)) => Client (fedM comp) api
fedQueueClient :: forall {k} (tag :: k) c. (HasNotificationEndpoint tag, HasVersionRange tag, HasFedPath tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag), c ~ NotificationComponent k) => Payload tag -> FedQueueClient c ()
sendBundle :: KnownComponent c => PayloadBundle c -> FedQueueClient c ()
fedClientIn :: forall (comp :: Component) (name :: Symbol) m api. (HasFedEndpoint comp api name, HasClient m api) => Client m api
module Wire.API.Component
data Component
- = Brig
- | Galley
- | Cargohold
makeConversationUpdateBundle :: ConversationUpdate -> FedQueueClient 'Galley (PayloadBundle 'Galley)

Documentation

type family FedApi (comp :: Component) = (api :: Type) | api -> comp Source #

Instances

Instances details

type FedApi 'Brig Source #
Instance details Defined in Wire.API.Federation.API type FedApi 'Brig = BrigApi
type FedApi 'Cargohold Source #
Instance details Defined in Wire.API.Federation.API type FedApi 'Cargohold = CargoholdApi
type FedApi 'Galley Source #
Instance details Defined in Wire.API.Federation.API type FedApi 'Galley = GalleyApi

type HasFedEndpoint comp api name = HasUnsafeFedEndpoint comp api name Source #

type HasUnsafeFedEndpoint comp api name = 'Just api ~ LookupEndpoint (FedApi comp) name Source #

Like HasFedEndpoint, but doesn't propagate a CallsFed constraint. Useful for tests, but unsafe in the sense that incorrect usage will allow you to forget about some federated calls.

class FederationMonad (fedM :: Component -> Type -> Type) where Source #

Methods

fedClientWithProxy :: forall (comp :: Component) name api. (HasClient (fedM comp) api, HasFedEndpoint comp api name, KnownComponent comp, IsNamed name, Typeable (Client (fedM comp) api)) => Proxy name -> Proxy api -> Proxy (fedM comp) -> Client (fedM comp) api Source #

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 #

class IsNamed (name :: k) where Source #

Methods

nameVal' :: Text Source #

Instances

Instances details

KnownSymbol name => IsNamed (name :: Symbol) Source #
Instance details Defined in Wire.API.Federation.API Methods nameVal' :: Text Source #
(IsNamed name, SingI v) => IsNamed (Versioned v name :: Type) Source #
Instance details Defined in Wire.API.Federation.API Methods nameVal' :: Text Source #

nameVal :: forall {k} (name :: k). IsNamed name => Text Source #

fedClient :: forall (comp :: Component) name fedM (showcomp :: Symbol) api. (showcomp ~ ShowComponent comp, HasFedEndpoint comp api name, HasClient (fedM comp) api, KnownComponent comp, IsNamed name, FederationMonad fedM, Typeable (Client (fedM comp) api)) => Client (fedM comp) api Source #

Return a client for a named endpoint.

fedQueueClient :: forall {k} (tag :: k) c. (HasNotificationEndpoint tag, HasVersionRange tag, HasFedPath tag, KnownComponent (NotificationComponent k), ToJSON (Payload tag), c ~ NotificationComponent k) => Payload tag -> FedQueueClient c () Source #

sendBundle :: KnownComponent c => PayloadBundle c -> FedQueueClient c () Source #

fedClientIn :: forall (comp :: Component) (name :: Symbol) m api. (HasFedEndpoint comp api name, HasClient m api) => Client m api Source #

module Wire.API.Component

Re-exports

data Component Source #

Constructors

Brig
Galley
Cargohold

Instances

Instances details

Arbitrary Component
Instance details Defined in Wire.API.Component Methods arbitrary :: Gen Component Source # shrink :: Component -> [Component] Source #
FromJSON Component
Instance details Defined in Wire.API.Component Methods parseJSON :: Value -> Parser Component Source # parseJSONList :: Value -> Parser [Component] Source #
ToJSON Component
Instance details Defined in Wire.API.Component Methods toJSON :: Component -> Value Source # toEncoding :: Component -> Encoding Source # toJSONList :: [Component] -> Value Source # toEncodingList :: [Component] -> Encoding Source #
Generic Component
Instance details Defined in Wire.API.Component Associated Types type Rep Component :: Type -> Type # Methods from :: Component -> Rep Component x # to :: Rep Component x -> Component #
Show Component
Instance details Defined in Wire.API.Component Methods showsPrec :: Int -> Component -> ShowS # show :: Component -> String # showList :: [Component] -> ShowS #
Eq Component
Instance details Defined in Wire.API.Component Methods (==) :: Component -> Component -> Bool # (/=) :: Component -> Component -> Bool #
FromHttpApiData Component
Instance details Defined in Wire.API.Component Methods parseUrlPiece :: Text -> Either Text Component Source # parseHeader :: ByteString -> Either Text Component Source # parseQueryParam :: Text -> Either Text Component Source #
ToHttpApiData Component
Instance details Defined in Wire.API.Component Methods toUrlPiece :: Component -> Text Source # toEncodedUrlPiece :: Component -> Builder Source # toHeader :: Component -> ByteString Source # toQueryParam :: Component -> Text Source # toEncodedQueryParam :: Component -> Builder Source #
ToSchema Component
Instance details Defined in Wire.API.Component Methods schema :: ValueSchema NamedSwaggerDoc Component Source #
type Rep Component
Instance details Defined in Wire.API.Component type Rep Component = D1 ('MetaData "Component" "Wire.API.Component" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "Brig" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Galley" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cargohold" 'PrefixI 'False) (U1 :: Type -> Type)))

makeConversationUpdateBundle :: ConversationUpdate -> FedQueueClient 'Galley (PayloadBundle 'Galley) Source #