-
Notifications
You must be signed in to change notification settings - Fork 448
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Backend
documentation
#301
Conversation
This change adds `Backend` documentation to methods that provide functionality not offered by a client.
We should add some stub documentation for Agents and Connections are one-to-one. Agents represent the client's state on the server-side. On the server, the Agent has a direct reference to the Connection, and to the Backend (through a direct stream). A client-side Connection does not have a reference to an Agent. |
Clarify some of the new `Backend` documentation, and add documentation for the `Backend` constructor, as well as some brief documentation on the `Agent` class, accompanied by some rough authentication documentation.
This change adds
Backend
documentation to methods that providefunctionality not offered by a client.