1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-11-22 11:41:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
57b7fa3db8
dendrite/clientapi
History
Kegsay 0ba1245a46
Current wiring (#1125) 
* Current wiring

* Add ServerKeyAPI lines
2020-06-15 10:13:57 +01:00
..
auth Rehuffle where things are in the internal package (#1122) 2020-06-12 14:55:57 +01:00
consumers Roomserver API changes (#1118) 2020-06-11 19:50:40 +01:00
httputil Remove httputil.LogThenError so that the line numbers are reported properly - make error reporting slightly more useful (#879) 2020-03-02 16:20:44 +00:00
jsonerror Roomserver perform join (#1001) 2020-05-04 13:53:47 +01:00
producers Rehuffle where things are in the internal package (#1122) 2020-06-12 14:55:57 +01:00
routing Current wiring (#1125) 2020-06-15 10:13:57 +01:00
threepid Rehuffle where things are in the internal package (#1122) 2020-06-12 14:55:57 +01:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Current wiring (#1125) 2020-06-15 10:13:57 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00

README.md

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.