Skip to content

Commit

Permalink
Update the sessionIdleTimeout JavaDoc (Azure#37341)
Browse files Browse the repository at this point in the history
* Update the sessionIdleTimeout doc

* improve the doc.

Co-authored-by: Connie Yau <conniey@microsoft.com>

---------

Co-authored-by: Connie Yau <conniey@microsoft.com>
  • Loading branch information
anuchandy and conniey authored Oct 24, 2023
1 parent 74ade0c commit 680e1e7
Showing 1 changed file with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1310,8 +1310,13 @@ public ServiceBusSessionProcessorClientBuilder maxAutoLockRenewDuration(Duration
/**
* Sets the maximum amount of time to wait for a message to be received for the currently active session.
* After this time has elapsed, the processor will close the session and attempt to process another session.
* If not specified, the {@link AmqpRetryOptions#getTryTimeout()} will be used.
*
* <p>After the processor delivers a message to the {@link #processMessage(Consumer)} handler, if the processor
* is unable to receive the next message from the session because there is no next message in the session or
* processing the current message takes longer than the {@code sessionIdleTimeout} then the session will time
* out. To avoid inadvertently losing sessions, choose a {@code sessionIdleTimeout} greater than the
* processing time of a message.</p>
*
* <p>If not specified, the {@link AmqpRetryOptions#getTryTimeout()} will be used.</p>
* @param sessionIdleTimeout Session idle timeout.
* @return The updated {@link ServiceBusSessionProcessorClientBuilder} object.
* @throws IllegalArgumentException If {code maxAutoLockRenewDuration} is negative.
Expand Down

0 comments on commit 680e1e7

Please sign in to comment.