dendrite/src/github.com/matrix-org/dendrite/clientapi
Robert Swain d09a65abbe Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
..
auth Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
config Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
events Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
httputil Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
jsonerror Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
producers Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
readers Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
routing Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
writers Add Apache Version 2.0 license and headers to all golang files 2017-04-21 00:40:52 +02:00
README.md Create README.md 2017-03-13 15:56:26 +00: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.