base

Documentation

Index

• Constants
• Variables
• func ConfigureAdminEndpoints(processContext *process.ProcessContext, routers httputil.Routers)
• func CreateClient(cfg *config.Dendrite, dnsCache *fclient.DNSCache) *fclient.Client
• func CreateFederationClient(cfg *config.Dendrite, dnsCache *fclient.DNSCache) fclient.FederationClient
• func PlatformSanityChecks()
• func SetupAndServeHTTP(processContext *process.ProcessContext, cfg *config.Dendrite, ...)
• func WaitForShutdown(processCtx *process.ProcessContext)

Constants

const HTTPServerTimeout = time.Minute * 5

Variables

var StaticContent = staticContent

Functions

func ConfigureAdminEndpoints

func ConfigureAdminEndpoints(processContext *process.ProcessContext, routers httputil.Routers)

func CreateClient

func CreateClient(cfg *config.Dendrite, dnsCache *fclient.DNSCache) *fclient.Client

CreateClient creates a new client (normally used for media fetch requests). Should only be called once per component.

func CreateFederationClient

func CreateFederationClient(cfg *config.Dendrite, dnsCache *fclient.DNSCache) fclient.FederationClient

CreateFederationClient creates a new federation client. Should only be called once per component.

func PlatformSanityChecks

func PlatformSanityChecks()

func SetupAndServeHTTP

func SetupAndServeHTTP(
	processContext *process.ProcessContext,
	cfg *config.Dendrite,
	routers httputil.Routers,
	externalHTTPAddr config.ServerAddress,
	certFile, keyFile *string,
)

SetupAndServeHTTP sets up the HTTP server to serve client & federation APIs and adds a prometheus handler under /_dendrite/metrics.

func WaitForShutdown

func WaitForShutdown(processCtx *process.ProcessContext)