1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-11-13 23:31:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
aa0d22bf50
dendrite/clientapi
History
Alex Chen aa0d22bf50
Implement client single event retrieval (#693)
2019-08-09 17:45:54 +08:00
..
auth Implement profile retrieval over federation (#726) 2019-08-07 00:02:12 +08: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 Fix pipeline, emoji and syntax (#713) 2019-06-19 14:05:03 +01:00
producers use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
routing Implement client single event retrieval (#693) 2019-08-09 17:45:54 +08:00
threepid Replace membership and visibility values with constants (#774) 2019-08-06 15:07:36 +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.