Package org.apache.hc.core5.http.io
Class EofSensorInputStream
java.lang.Object
java.io.InputStream
org.apache.hc.core5.http.io.EofSensorInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
A stream wrapper that triggers actions on
close()
and EOF.
Primarily used to auto-release an underlying managed connection when the response
body is consumed or no longer needed.- Since:
- 4.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final EofSensorWatcher
The watcher to be notified, if any.private boolean
Indicates whether this stream itself is closed.private InputStream
The wrapped input stream, while accessible. -
Constructor Summary
ConstructorsConstructorDescriptionEofSensorInputStream
(InputStream in, EofSensorWatcher watcher) Creates a new EOF sensor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
Aborts this stream.int
private void
Detects stream abort and notifies the watcher.private void
Detects stream close and notifies the watcher.private void
checkEOF
(int eof) Detects EOF and notifies the watcher.void
close()
(package private) InputStream
private boolean
Checks whether the underlying stream can be read from.(package private) boolean
int
read()
int
read
(byte[] b) int
read
(byte[] b, int off, int len) Methods inherited from class java.io.InputStream
mark, markSupported, reset, skip
-
Field Details
-
wrappedStream
The wrapped input stream, while accessible. The value changes tonull
when the wrapped stream becomes inaccessible. -
selfClosed
private boolean selfClosedIndicates whether this stream itself is closed. If it isn't, butwrappedStream
isnull
, we're running in EOF mode. All read operations will indicate EOF without accessing the underlying stream. After closing this stream, read operations will trigger anIOException
.- See Also:
-
eofWatcher
The watcher to be notified, if any.
-
-
Constructor Details
-
EofSensorInputStream
Creates a new EOF sensor. If no watcher is passed, the underlying stream will simply be closed when EOF is detected orclose
is called. Otherwise, the watcher decides whether the underlying stream should be closed before detaching from it.- Parameters:
in
- the wrapped streamwatcher
- the watcher for events, ornull
for auto-close behavior without notification
-
-
Method Details
-
isSelfClosed
boolean isSelfClosed() -
getWrappedStream
InputStream getWrappedStream() -
isReadAllowed
Checks whether the underlying stream can be read from.- Returns:
true
if the underlying stream is accessible,false
if this stream is in EOF mode and detached from the underlying stream- Throws:
IOException
- if this stream is already closed
-
read
- Specified by:
read
in classInputStream
- Throws:
IOException
-
read
- Overrides:
read
in classInputStream
- Throws:
IOException
-
read
- Overrides:
read
in classInputStream
- Throws:
IOException
-
available
- Overrides:
available
in classInputStream
- Throws:
IOException
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
-
checkEOF
Detects EOF and notifies the watcher. This method should only be called while the underlying stream is still accessible. UseisReadAllowed
to check that condition.If EOF is detected, the watcher will be notified and this stream is detached from the underlying stream. This prevents multiple notifications from this stream.
- Parameters:
eof
- the result of the calling read operation. A negative value indicates that EOF is reached.- Throws:
IOException
- in case of an IO problem on closing the underlying stream
-
checkClose
Detects stream close and notifies the watcher. There's not much to detect since this is called byclose
. The watcher will only be notified if this stream is closed for the first time and before EOF has been detected. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher.- Throws:
IOException
- in case of an IO problem on closing the underlying stream
-
checkAbort
Detects stream abort and notifies the watcher. There's not much to detect since this is called byabort()
. The watcher will only be notified if this stream is aborted for the first time and before EOF has been detected or the stream has beenclosed
gracefully. This stream will be detached from the underlying stream to prevent multiple notifications to the watcher.- Throws:
IOException
- in case of an IO problem on closing the underlying stream
-
abort
Aborts this stream. This is a special version ofclose()
which prevents re-use of the underlying connection, if any. Calling this method indicates that there should be no attempt to read until the end of the stream.- Throws:
IOException
- in case of an IO problem on closing the underlying stream
-