Add javadoc.

This commit is contained in:
akwizgran
2020-05-08 15:41:32 +01:00
parent c382ce921c
commit dd049012ce

View File

@@ -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);
}