mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-15 19:03:09 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/clientapi
History
Brendan Abolivier 9980ef544d Bring code up to date so that it passes lint
2019-05-21 19:13:06 +01:00
..
auth Merge branch 'modules' of https://github.com/rbns/dendrite into rbns-modules 2019-05-21 16:30:46 +01:00
consumers moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
httputil moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
jsonerror moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
producers moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
routing Bring code up to date so that it passes lint 2019-05-21 19:13:06 +01:00
threepid moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
userutil moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
clientapi.go moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +01:00
README.md moved sources to basedir to enable compiling with standard tools 2018-11-12 21:26:11 +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.