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

Fix #12308 improve CyclicTimeouts javadoc #12465

Merged
merged 4 commits into from
Nov 4, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ private Content()
* @param source the source to copy from
* @param sink the sink to copy to
* @param callback the callback to notify when the copy is complete
* @see #copy(Source, Sink, Chunk.Processor, Callback) to allow processing of individual {@link Chunk}s, including
* @see #copy(Source, Sink, Chunk.Processor, Callback) to allow processing of individual {@code Content.Chunk}s, including
* the ability to ignore transient failures.
*/
public static void copy(Source source, Sink sink, Callback callback)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,11 @@ private void onTimeoutExpired()
}

/**
* <p>Manages the timeout of a new entity.</p>
*
* <p>Schedules a timeout for a new or modified item.</p>
* <p>If an item returned by the {@link #iterator()} has been modified or added so that it may
* now be the earliest expiring item, then this method should be called to schedule the timeout. This need not be called
* for a recurrent timeout during {@code Expirable#onTimeoutExpired()}, nor if the timeout of an existing item is increased.
* However, it is safe and inexpensive to always call this when modifying an items expiry.</p>
* @param expirable the new entity to manage the timeout for
*/
public void schedule(T expirable)
Expand Down
Loading