1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-11-08 18:16:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
74827428bd
dendrite/clientapi
History
ruben 74827428bd use go module for dependencies (#594)
2019-05-21 21:56:55 +01:00
..
auth use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
consumers use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
httputil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
jsonerror use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
producers use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
routing use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
threepid use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go use go module for dependencies (#594) 2019-05-21 21:56:55 +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.