-
Notifications
You must be signed in to change notification settings - Fork 43
Document the watchers and built-in events #2858
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
Conversation
1a0a8d9
to
4a87eca
Compare
Each subscription is defined by the certain key. | ||
The main feature of the subscriptions is a one-time action. | ||
It means that if the server generates too many events and a client is too slow, | ||
the server will not allocate additional memory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand what this means. Maybe, refer to the section describing the watcher protocol in IPROTO, where we would describe how it's implemented and what exactly prevents the server from "allocating additional memory" if clients don't process events in time?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the sentence about "allocating additional memory". I'll return to this comment in #2408
e727318
to
51251d6
Compare
* check file path * update text * add glossary * fix links
* Renamed pub/sub section to System events, removed paragraph about pub/sub, moved the event definition to Event watchers section * Removed code-block with empty table for the event values * Fixed some refs and links
4758194
to
b357275
Compare
Fixes #2551 Fixes #2409 Fixes #2407 * Add new functions to module box * Update watch and broadcast methods * Add System events section * Add glossary * Proofread text and add links Written by Kseniia Antonova Reviewed by Vladimir Davydov and Dmitry Oboukhov Proofread by Patience Daur Co-authored-by: Kseniia Antonova <[email protected]> Co-authored-by: Patience Daur <[email protected]>
Fixes #2551
Fixes #2409
Fixes #2407
Deploy: