docs(producer): clarify SendAsync description#1485
Open
MukundaKatta wants to merge 1 commit intoapache:masterfrom
Open
docs(producer): clarify SendAsync description#1485MukundaKatta wants to merge 1 commit intoapache:masterfrom
MukundaKatta wants to merge 1 commit intoapache:masterfrom
Conversation
Clarify that SendAsync completes in the background and signals completion via the user-supplied callback, and qualify the queue-full blocking behavior with the DisableBlockIfQueueFull option (issue apache/pulsar#23643).
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.
Why
Closes apache/pulsar#23643.
The current
Producer.SendAsyncGoDoc says "This call is blocked when themaxPendingMessagesbecomes full (default: 1000)" without context, which makes the asynchronous API sound blocking by default. As noted in the issue thread, the call only blocks when the queue is full andDisableBlockIfQueueFullis left at its default (false). It also never says, in plain words, that the send happens in the background and the callback is what signals completion — which is the actual mental model users need.What
pulsar/producer.go:SendAsyncruns the send in the background and invokes the supplied callback on completion (success or failure).maxPendingMessagesbecomes full" sentence with theDisableBlockIfQueueFullexception, instead of describing it as unconditional.The context paragraph, callback description, example, and signature are intentionally untouched.
Tested
gh api .../compare/...shows +5 / -2 inpulsar/producer.go).