From dd049012ce46a783fc9c79be76aec48fe0edd7ac Mon Sep 17 00:00:00 2001 From: akwizgran Date: Fri, 8 May 2020 15:41:32 +0100 Subject: [PATCH] Add javadoc. --- .../org/briarproject/bramble/api/io/TimeoutMonitor.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/bramble-api/src/main/java/org/briarproject/bramble/api/io/TimeoutMonitor.java b/bramble-api/src/main/java/org/briarproject/bramble/api/io/TimeoutMonitor.java index 04c1dc3cb..92d440946 100644 --- a/bramble-api/src/main/java/org/briarproject/bramble/api/io/TimeoutMonitor.java +++ b/bramble-api/src/main/java/org/briarproject/bramble/api/io/TimeoutMonitor.java @@ -4,5 +4,12 @@ import java.io.InputStream; public interface TimeoutMonitor { + /** + * Returns an {@link InputStream} that wraps the given stream and allows + * read timeouts to be detected. + * + * @param timeoutMs The read timeout in milliseconds. Timeouts will be + * detected eventually but are not guaranteed to be detected immediately. + */ InputStream createTimeoutInputStream(InputStream in, long timeoutMs); }