dendrite/clientapi
2024-10-17 17:16:37 +02:00
..
api Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
auth Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
httputil Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
producers Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
routing Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
threepid Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
userutil Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
admin_test.go Add getting/deleting single event report (#3344) 2024-03-22 21:54:29 +00:00
clientapi.go Update the copyright headers in all files 2024-10-17 17:16:37 +02:00
clientapi_test.go Add event reporting (#3340) 2024-03-21 19:27:34 +01: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.