Skip to content
Permalink
Browse files
docs: Document potentially unexpected blocking behavior of publish() …
…method (#370)

* docs: Document potentially unexpected blocking behavior of publish() method.

* docs: Run mvn fmt:format
  • Loading branch information
dpcollins-google committed Jan 21, 2021
1 parent 573a5e0 commit 18b3a2f77816b55cf605447b382a2f1bd42e0880
@@ -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
@@ -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

0 comments on commit 18b3a2f

Please sign in to comment.