|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
org.apache.http.conn.EofSensorInputStream
public class EofSensorInputStream
A stream wrapper that triggers actions on close()
and EOF.
Primarily used to auto-release an underlying
connection
when the response body is consumed or no longer needed.
This class is based on AutoCloseInputStream
in HttpClient 3.1,
but has notable differences. It does not allow mark/reset, distinguishes
different kinds of event, and does not always close the underlying stream
on EOF. That decision is left to the watcher
.
EofSensorWatcher
Field Summary | |
---|---|
protected java.io.InputStream |
wrappedStream
The wrapped input stream, while accessible. |
Constructor Summary | |
---|---|
EofSensorInputStream(java.io.InputStream in,
EofSensorWatcher watcher)
Creates a new EOF sensor. |
Method Summary | |
---|---|
void |
abortConnection()
Aborts this stream. |
int |
available()
|
protected void |
checkAbort()
Detects stream abort and notifies the watcher. |
protected void |
checkClose()
Detects stream close and notifies the watcher. |
protected void |
checkEOF(int eof)
Detects EOF and notifies the watcher. |
void |
close()
|
protected boolean |
isReadAllowed()
Checks whether the underlying stream can be read from. |
int |
read()
|
int |
read(byte[] b)
|
int |
read(byte[] b,
int off,
int len)
|
void |
releaseConnection()
Same as close() . |
Methods inherited from class java.io.InputStream |
---|
mark, markSupported, reset, skip |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.io.InputStream wrappedStream
null
when the wrapped stream
becomes inaccessible.
Constructor Detail |
---|
public EofSensorInputStream(java.io.InputStream in, EofSensorWatcher watcher)
close
is called.
Otherwise, the watcher decides whether the underlying stream
should be closed before detaching from it.
in
- the wrapped streamwatcher
- the watcher for events, or null
for
auto-close behavior without notificationMethod Detail |
---|
protected boolean isReadAllowed() throws java.io.IOException
true
if the underlying stream is accessible,
false
if this stream is in EOF mode and
detached from the underlying stream
java.io.IOException
- if this stream is already closedpublic int read() throws java.io.IOException
read
in class java.io.InputStream
java.io.IOException
public int read(byte[] b, int off, int len) throws java.io.IOException
read
in class java.io.InputStream
java.io.IOException
public int read(byte[] b) throws java.io.IOException
read
in class java.io.InputStream
java.io.IOException
public int available() throws java.io.IOException
available
in class java.io.InputStream
java.io.IOException
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in class java.io.InputStream
java.io.IOException
protected void checkEOF(int eof) throws java.io.IOException
isReadAllowed
to
check that condition.
eof
- the result of the calling read operation.
A negative value indicates that EOF is reached.
java.io.IOException
- in case of an IO problem on closing the underlying streamprotected void checkClose() throws java.io.IOException
close
.
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.
java.io.IOException
- in case of an IO problem on closing the underlying streamprotected void checkAbort() throws java.io.IOException
abortConnection
.
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 been closed
gracefully.
This stream will be detached from the underlying stream to prevent
multiple notifications to the watcher.
java.io.IOException
- in case of an IO problem on closing the underlying streampublic void releaseConnection() throws java.io.IOException
close()
.
releaseConnection
in interface ConnectionReleaseTrigger
java.io.IOException
- in case of an IO problem. The connection will be released
anyway.public void abortConnection() throws java.io.IOException
close()
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.
abortConnection
in interface ConnectionReleaseTrigger
java.io.IOException
- in case of an IO problem.
The connection will be released anyway.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |