char/dendrite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
dendrite/clientapi
History
Kegsay 11a8059bba
Rename the typing server to EDU server (#948) 
* Blunt move and sed rename

* Rename common/ refs to typing

* Rename internal stuff in eduserver

* Rename docs and scripts

* Rename constants/filenames, goimports everything to re-order imports
2020-03-30 15:02:20 +01:00
..
auth Implement /joined_rooms (#911) 2020-03-19 10:25:36 +00:00
consumers Implement gomatrixserverlib.HeaderedEvent in roomserver Kafka output (#914) 2020-03-17 11:01:25 +00:00
httputil Remove httputil.LogThenError so that the line numbers are reported properly - make error reporting slightly more useful (#879) 2020-03-02 16:20:44 +00:00
jsonerror Add room version to room create request, persist in storage (#915) 2020-03-17 15:12:01 +00:00
producers Rename the typing server to EDU server (#948) 2020-03-30 15:02:20 +01:00
routing Rename the typing server to EDU server (#948) 2020-03-30 15:02:20 +01:00
threepid Further room version wiring (#936) 2020-03-27 16:28:22 +00:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Rename the typing server to EDU server (#948) 2020-03-30 15:02:20 +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.