federationapi

Documentation

Index

• func AddInternalRoutes(router *mux.Router, intAPI api.FederationInternalAPI)
• func AddPublicRoutes(base *base.BaseDendrite, userAPI userapi.UserInternalAPI, ...)
• func NewInternalAPI(base *base.BaseDendrite, federation api.FederationClient, ...) api.FederationInternalAPI

Functions

func AddInternalRoutes

func AddInternalRoutes(router *mux.Router, intAPI api.FederationInternalAPI)

AddInternalRoutes registers HTTP handlers for the internal API. Invokes functions on the given input API.

func AddPublicRoutes

func AddPublicRoutes(
	base *base.BaseDendrite,
	userAPI userapi.UserInternalAPI,
	federation *gomatrixserverlib.FederationClient,
	keyRing gomatrixserverlib.JSONVerifier,
	rsAPI roomserverAPI.FederationRoomserverAPI,
	fedAPI federationAPI.FederationInternalAPI,
	keyAPI keyserverAPI.FederationKeyAPI,
	servers federationAPI.ServersInRoomProvider,
)

AddPublicRoutes sets up and registers HTTP handlers on the base API muxes for the FederationAPI component.

func NewInternalAPI

func NewInternalAPI(
	base *base.BaseDendrite,
	federation api.FederationClient,
	rsAPI roomserverAPI.FederationRoomserverAPI,
	caches *caching.Caches,
	keyRing *gomatrixserverlib.KeyRing,
	resetBlacklist bool,
) api.FederationInternalAPI

NewInternalAPI returns a concerete implementation of the internal API. Callers can call functions directly on the returned API or via an HTTP interface using AddInternalRoutes.