man: add message unref to sd_bus_call_method #32900
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
please-review
|
Important An -rc1 tag has been created and a release is being prepared, so please note that PRs introducing new features and APIs will be held back until the new version has been released. |
yuwata
requested changes
May 17, 2024
| functions into a single function call. When <parameter>reply</parameter> message returned from this function | ||
| is no longer needed, it should be unreferenced by calling | ||
| <citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> | ||
| on it.</para> |
There was a problem hiding this comment.
This should be mentioned in sd_bus_call(3).
| not call <citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> | ||
| on it. If the callback wants to hold on to the message beyond the lifetime of the callback, it needs to call | ||
| <citerefentry><refentrytitle>sd_bus_message_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry> to create a | ||
| new reference.</para> |
There was a problem hiding this comment.
Hm, this is copied from sd_bus_call(3). I do not think we should duplicate such...
There was a problem hiding this comment.
actually it's an important point, so either the same wording or a reference to the exact paragraph is a good thing to have here too, better to have too much info than too little
There was a problem hiding this comment.
Then, let's extract this to another .xml file and include it for all sd_bus_*_async() functions.
yuwata
added
reviewed/needs-rework 🔨
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
I added information when to use and when not to use
sd_bus_message_unreftosd_bus_call_method(3).