Skip to content
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

Document the watchers and built-in events #2858

Merged
merged 13 commits into from Aug 5, 2022
Merged

Conversation

@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system May 5, 2022 08:23 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 20, 2022 17:34 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 21, 2022 16:46 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 23, 2022 08:38 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 23, 2022 08:40 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 24, 2022 10:59 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 24, 2022 11:41 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 24, 2022 13:18 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 27, 2022 13:41 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 27, 2022 14:28 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 27, 2022 14:41 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 27, 2022 16:47 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 27, 2022 17:33 Inactive
@xuniq xuniq requested a review from locker June 27, 2022 17:40
doc/reference/reference_lua/box_watchers/broadcast.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_watchers/watch.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/net_box.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_watchers/watch.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/net_box.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/pub-sub.rst Outdated Show resolved Hide resolved
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.
Copy link
Member

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?

Copy link
Contributor Author

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

doc/reference/reference_lua/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/pub-sub.rst Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 30, 2022 15:40 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system June 30, 2022 16:48 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system July 1, 2022 06:43 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system July 4, 2022 10:33 Inactive
@xuniq xuniq requested a review from locker July 4, 2022 10:40
doc/reference/reference_lua/box.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/box_events/pub-sub.rst Outdated Show resolved Hide resolved
doc/reference/reference_lua/net_box.rst Outdated Show resolved Hide resolved
@locker locker requested a review from unera July 4, 2022 16:11
@locker
Copy link
Member

locker commented Jul 4, 2022

@xuniq Please also solicit an approval from @unera. He's a product manager who participated in the feature design. He knows better how to present the feature to Tarantool users.

@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system July 4, 2022 17:23 Inactive
@xuniq xuniq changed the title Document the new pub/sub system and its events Document the watchers and built-in events Jul 6, 2022
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system July 27, 2022 13:11 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system July 28, 2022 11:05 Inactive
xuniq added 10 commits July 29, 2022 09:52
* 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
@xuniq xuniq requested review from locker and unera July 29, 2022 06:57
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system July 29, 2022 06:57 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system August 5, 2022 07:38 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system August 5, 2022 08:15 Inactive
@github-actions github-actions bot temporarily deployed to branch-gh-2551-pub-sub-system August 5, 2022 08:35 Inactive
@patiencedaur patiencedaur merged commit 7c351fb into latest Aug 5, 2022
@patiencedaur patiencedaur deleted the gh-2551-pub-sub-system branch August 5, 2022 08:58
p7nov pushed a commit that referenced this pull request Aug 11, 2022
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 <xuniq.is.here@gmail.com>
Co-authored-by: Patience Daur <patiencedaur@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants