README
¶
This component roughly corresponds to "Client Room Send" and "Client Sync" on the WIRING diagram. This component produces multiple binaries.
Internals
- HTTP routing is done using
gorilla/muxand the routing paths are in theroutingpackage.
Writers
- Each HTTP "write operation" (
/createRoom,/rooms/$room_id/send/$type, etc) is contained entirely to a single file in thewriterspackage. - This file contains the request and response
structdefinitions, as well as aValidate() boolfunction to validate incoming requests. - The entry point for each write operation is a stand-alone function as this makes testing easier. All dependencies should be injected into this function, including server keys/name, etc.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddPublicRoutes ¶
func AddPublicRoutes( processContext *process.ProcessContext, routers httputil.Routers, cfg *config.Dendrite, natsInstance *jetstream.NATSInstance, federation fclient.FederationClient, rsAPI roomserverAPI.ClientRoomserverAPI, transactionsCache *transactions.Cache, fsAPI federationAPI.ClientFederationAPI, userAPI userapi.ClientUserAPI, userDirectoryProvider userapi.QuerySearchProfilesAPI, extRoomsProvider api.ExtraPublicRoomsProvider, enableMetrics bool, )
AddPublicRoutes sets up and registers HTTP handlers for the ClientAPI component.
Types ¶
This section is empty.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.