1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2025-02-02 04:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
61e0482fef
dendrite/clientapi
History
Neil Alexander 7f26b0cd13
Bind build support, further Yggdrasil demo updates (#1152) 
* Add gobind builds for Yggdrasil demo

* Massage client API a bit

* Fix build

* Fix gobind build

* Fix gobind client API setup

* Tweaks

* Tweaks

* Update sytest-whitelist, add comment

* Default to sending push rules on initial sync
2020-06-19 13:29:27 +01:00
..
auth Move account/device DBs to userapi (#1141) 2020-06-17 12:05:56 +01:00
consumers Move account/device DBs to userapi (#1141) 2020-06-17 12:05:56 +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 Bind build support, further Yggdrasil demo updates (#1152) 2020-06-19 13:29:27 +01:00
threepid Move account/device DBs to userapi (#1141) 2020-06-17 12:05:56 +01:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Move account/device DBs to userapi (#1141) 2020-06-17 12:05:56 +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.