733abe912b
Possibly fixes #1194 |
||
---|---|---|
.. | ||
api | ||
auth | ||
httputil | ||
jsonerror | ||
producers | ||
routing | ||
threepid | ||
userutil | ||
README.md | ||
clientapi.go |
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 therouting
package.
Writers
- Each HTTP "write operation" (
/createRoom
,/rooms/$room_id/send/$type
, etc) is contained entirely to a single file in thewriters
package. - This file contains the request and response
struct
definitions, as well as aValidate() 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.