Skip to content

Commit 642e580

Browse files
committed
[Java] Update javadoc for publication unblocking when using the Publication.tryClaim.
1 parent a69f6ed commit 642e580

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

aeron-client/src/main/java/io/aeron/ExclusivePublication.java

+2
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,8 @@ public long offer(
437437
* available.
438438
* <p>
439439
* <b>Note:</b> This method can only be used for message lengths less than MTU length minus header.
440+
* If the claim is held for more than the aeron.publication.unblock.timeout system property then the driver will
441+
* assume the publication thread is dead and will unblock the claim thus allowing other threads to make progress.
440442
* <pre>{@code
441443
* final ExclusiveBufferClaim bufferClaim = new ExclusiveBufferClaim();
442444
*

aeron-client/src/main/java/io/aeron/Publication.java

+2
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,8 @@ public long offer(
417417
* Once the message has been written then {@link BufferClaim#commit()} should be called thus making it available.
418418
* <p>
419419
* <b>Note:</b> This method can only be used for message lengths less than MTU length minus header.
420+
* If the claim is held for more than the aeron.publication.unblock.timeout system property then the driver will
421+
* assume the publication thread is dead and will unblock the claim thus allowing other threads to make progress.
420422
* <pre>{@code
421423
* final BufferClaim bufferClaim = new BufferClaim(); // Can be stored and reused to avoid allocation
422424
*

0 commit comments

Comments
 (0)