Apache HttpClient 4.5.14 · org.apache.http.conn.BasicEofSensorWatcher

Modifier and Type	Field and Description
protected final boolean	attemptReuse Whether to keep the connection alive.
protected final ManagedClientConnection	managedConn The connection to auto-release.

Constructor Summary

Access	Constructor and Description
public	BasicEofSensorWatcher(final ManagedClientConnection the connection to auto-release conn, final boolean whether the connection should be re-used reuse) Deprecated as a consequence of `ManagedClientConnection` being deprecated. Creates a new watcher for auto-releasing a connection.

Method Summary

Modifier and Type	Method and Description
public boolean	eofDetected(final InputStream the underlying stream which has reached EOF wrapped) Implements org.apache.http.conn.EofSensorWatcher.eofDetected. Indicates that EOF is detected.
public boolean	streamAbort(final InputStream the underlying stream which has not reached EOF wrapped) Implements org.apache.http.conn.EofSensorWatcher.streamAbort. Indicates that the `stream` is aborted.
public boolean	streamClosed(final InputStream the underlying stream which has not reached EOF wrapped) Implements org.apache.http.conn.EofSensorWatcher.streamClosed. Indicates that the `stream` is closed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attemptReuse	back to summary
protected final boolean attemptReuse Whether to keep the connection alive.

managedConn	back to summary
protected final ManagedClientConnection managedConn Deprecated as a consequence of `ManagedClientConnection` being deprecated. See corresponding docs for further information. The connection to auto-release.

Constructor Detail

BasicEofSensorWatcher back to summary

BasicEofSensorWatcher	back to summary
public BasicEofSensorWatcher(final ManagedClientConnection conn, final boolean reuse) Deprecated as a consequence of `ManagedClientConnection` being deprecated. See corresponding docs for further information. Creates a new watcher for auto-releasing a connection. Parameters conn:ManagedClientConnection the connection to auto-release reuse:boolean whether the connection should be re-used

public BasicEofSensorWatcher(final ManagedClientConnection conn, final boolean reuse)

Deprecated

as a consequence of ManagedClientConnection being deprecated. See corresponding docs for further information.

Creates a new watcher for auto-releasing a connection.

Parameters

conn:ManagedClientConnection: the connection to auto-release
reuse:boolean: whether the connection should be re-used

Method Detail

eofDetected back to summary

eofDetected	back to summary
public boolean eofDetected(final InputStream wrapped) throws IOException Implements org.apache.http.conn.EofSensorWatcher.eofDetected. Doc from org.apache.http.conn.EofSensorWatcher.eofDetected. Indicates that EOF is detected. Parameters wrapped:InputStream the underlying stream which has reached EOF Returns:boolean `true` if `wrapped` should be closed, `false` if it should be left alone Annotations @Override Exceptions IOException: in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if `false` was returned.

public boolean eofDetected(final InputStream wrapped) throws IOException

Implements org.apache.http.conn.EofSensorWatcher.eofDetected.

Doc from org.apache.http.conn.EofSensorWatcher.eofDetected.

Indicates that EOF is detected.

Parameters

wrapped:InputStream: the underlying stream which has reached EOF

Returns:boolean

true if wrapped should be closed, false if it should be left alone

Annotations

@Override

Exceptions

IOException:: in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

streamAbort back to summary

streamAbort	back to summary
public boolean streamAbort(final InputStream wrapped) throws IOException Implements org.apache.http.conn.EofSensorWatcher.streamAbort. Doc from org.apache.http.conn.EofSensorWatcher.streamAbort. Indicates that the `stream` is aborted. This method will be called only if EOF was not detected before aborting. Otherwise, `eofDetected` is called. This method will also be invoked when an input operation causes an IOException to be thrown to make sure the input stream gets shut down. Parameters wrapped:InputStream the underlying stream which has not reached EOF Returns:boolean `true` if `wrapped` should be closed, `false` if it should be left alone Annotations @Override Exceptions IOException: in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if `false` was returned.

public boolean streamAbort(final InputStream wrapped) throws IOException

Implements org.apache.http.conn.EofSensorWatcher.streamAbort.

Doc from org.apache.http.conn.EofSensorWatcher.streamAbort.

Indicates that the stream is aborted. This method will be called only if EOF was not detected before aborting. Otherwise, eofDetected is called.

This method will also be invoked when an input operation causes an IOException to be thrown to make sure the input stream gets shut down.

Parameters

wrapped:InputStream: the underlying stream which has not reached EOF

Returns:boolean

true if wrapped should be closed, false if it should be left alone

Annotations

@Override

Exceptions

IOException:: in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

streamClosed back to summary

streamClosed	back to summary
public boolean streamClosed(final InputStream wrapped) throws IOException Implements org.apache.http.conn.EofSensorWatcher.streamClosed. Doc from org.apache.http.conn.EofSensorWatcher.streamClosed. Indicates that the `stream` is closed. This method will be called only if EOF was not detected before closing. Otherwise, `eofDetected` is called. Parameters wrapped:InputStream the underlying stream which has not reached EOF Returns:boolean `true` if `wrapped` should be closed, `false` if it should be left alone Annotations @Override Exceptions IOException: in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if `false` was returned.

public boolean streamClosed(final InputStream wrapped) throws IOException

Implements org.apache.http.conn.EofSensorWatcher.streamClosed.

Doc from org.apache.http.conn.EofSensorWatcher.streamClosed.

Indicates that the stream is closed. This method will be called only if EOF was not detected before closing. Otherwise, eofDetected is called.

Parameters

wrapped:InputStream: the underlying stream which has not reached EOF

Returns:boolean

true if wrapped should be closed, false if it should be left alone

Annotations

@Override

Exceptions

IOException:: in case of an IO problem, for example if the watcher itself closes the underlying stream. The caller will leave the wrapped stream alone, as if false was returned.

public Class BasicEofSensorWatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail