dendrite/clientapi
2020-01-27 17:36:43 +00:00
..
auth Fix accounts DB, device DB 2020-01-27 17:36:43 +00:00
consumers Interfaces for accounts/devices databases 2020-01-27 12:31:05 +00:00
httputil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
jsonerror Fix pipeline, emoji and syntax (#713) 2019-06-19 14:05:03 +01:00
producers use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
routing Interfaces for accounts/devices databases 2020-01-27 12:31:05 +00:00
threepid Interfaces for accounts/devices databases 2020-01-27 12:31:05 +00:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Interfaces for accounts/devices databases 2020-01-27 12:31:05 +00:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00

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/mux and the routing paths are in the routing package.

Writers

  • Each HTTP "write operation" (/createRoom, /rooms/$room_id/send/$type, etc) is contained entirely to a single file in the writers package.
  • This file contains the request and response struct definitions, as well as a Validate() bool function 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.