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

docs: Document potentially unexpected blocking behavior of publish() method #370

Merged
merged 2 commits into from Jan 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -206,6 +206,9 @@ public String getTopicNameString() {
* Schedules the publishing of a message. The publishing of the message may occur immediately or
* be delayed based on the publisher batching options.
*
* <p>This method blocks in the downcall if using LimitExceededBehavior.Block in the flow control
* settings.
*
* <p>Example of publishing a message.
*
* <pre>{@code
Expand Down
Expand Up @@ -28,6 +28,8 @@ public interface PublisherInterface {
* Schedules the publishing of a message. The future will be returned with the message ID on
* success or an exception on failure.
*
* <p>Some implementations of this method may block in the downcall until allowed by flow control.
*
* <p>Example of publishing a message.
*
* <pre>{@code
Expand Down