fix: typo Slop->Slot and mark Signal::subscribe() [[nodiscard]] - #1199
Open
webzuweb wants to merge 1 commit into
Open
fix: typo Slop->Slot and mark Signal::subscribe() [[nodiscard]]#1199webzuweb wants to merge 1 commit into
webzuweb wants to merge 1 commit into
Conversation
- Fix doc comment "Signal/Slop implementation" -> "Signal/Slot implementation" - Mark subscribe() [[nodiscard]]: the returned shared_ptr is the only strong reference keeping the subscription alive (subscribers_ stores weak_ptrs), so discarding it silently drops the subscription before it can ever fire. Closes BehaviorTree#1159
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #1159.
Two minimal changes to
include/behaviortree_cpp/utils/signal.h:Signal::subscribe()as[[nodiscard]].Rationale for the
[[nodiscard]]:subscribe()returns aSubscriber(shared_ptr<CallableFunction>) that is the only strong reference keeping the subscription alive —subscribers_storesweak_ptrs. If a caller discards the return value, the refcount drops to zero immediately, the weak_ptr expires, and the subscription is silently dropped before it can ever fire.[[nodiscard]]turns that silent footgun into a compile-time warning.Verified locally:
g++ -std=c++17 -Wall -Wextra -Werroron a small TU that includes the header and keeps the return value (no warnings; runs clean).