Skip to content

Document IPROTO watchers #3044

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

Merged
merged 4 commits into from
Aug 5, 2022
Merged

Document IPROTO watchers #3044

merged 4 commits into from
Aug 5, 2022

Conversation

xuniq
Copy link
Contributor

@xuniq xuniq commented Jul 22, 2022

Fixes #2408
Deploy:

@github-actions github-actions bot temporarily deployed to branch-gh-2408-iproto-watchers July 22, 2022 09:57 Inactive
@xuniq xuniq marked this pull request as draft July 22, 2022 10:08
@github-actions github-actions bot temporarily deployed to branch-gh-2408-iproto-watchers July 22, 2022 10:11 Inactive
@xuniq xuniq force-pushed the gh-2408-iproto-watchers branch from 62901e5 to 93cd850 Compare July 29, 2022 10:38
@xuniq xuniq marked this pull request as ready for review July 29, 2022 10:39
@github-actions github-actions bot temporarily deployed to branch-gh-2408-iproto-watchers July 29, 2022 10:40 Inactive
@xuniq xuniq requested a review from locker August 1, 2022 06:50
@github-actions github-actions bot temporarily deployed to branch-gh-2408-iproto-watchers August 1, 2022 06:52 Inactive

.. _box_protocol-watch:

IPROTO_WATCH = 0x4a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IPROTO_WATCH and IPROTO_UNWATCH should probably be listed in the Requests sub-section, because they are user requests. The description could just contain a reference to the Watchers sub-section, like IPROTO_AUTH refers to the Authentication sub-section.

# <body>
msgpack({
IPROTO_EVENT_KEY: :samp:`{{MP_STR string}}}`,
IPROTO_EVENT_DATA: :samp:`{{MP_NIL nil}}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From this description, it looks like the data can only be MP_NIL, but it can contain any valid MsgPack, not just MP_NIL.

@github-actions github-actions bot temporarily deployed to branch-gh-2408-iproto-watchers August 5, 2022 12:00 Inactive
@patiencedaur patiencedaur merged commit 288018e into latest Aug 5, 2022
@patiencedaur patiencedaur deleted the gh-2408-iproto-watchers branch August 5, 2022 12:53
p7nov pushed a commit that referenced this pull request Aug 11, 2022
Written by Kseniia Antonova
Proofread by Patience Daur

Co-authored-by: Kseniia Antonova <[email protected]>
Co-authored-by: Patience Daur <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[3pt] Document IPROTO watchers
3 participants