Apache HttpCore 4.4.16 · org.apache.http.HttpConnection

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.io.Closeable.close. Closes this connection gracefully.
public HttpConnectionMetrics	Returns: HttpConnectionMetrics getMetrics() Returns a collection of connection metrics.
public int	Returns: positive value in milliseconds if a timeout is set, `0` if timeout is disabled or `-1` if timeout is undefined. getSocketTimeout() Returns the socket timeout value.
public boolean	Returns: true if it is open, false if it is closed. isOpen() Checks if this connection is open.
public boolean	Returns: `true` if attempts to use this connection are likely to succeed, or `false` if they are likely to fail and this connection should be closed isStale() Checks whether this connection has gone down.
public void	setSocketTimeout(int timeout value in milliseconds timeout) Sets the socket timeout value.
public void	shutdown() Force-closes this connection.

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Redeclares java.io.Closeable.close. Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use `shutdown` instead. Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

public void close() throws IOException

Redeclares java.io.Closeable.close.

Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use shutdown instead.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

getMetrics	back to summary
public HttpConnectionMetrics getMetrics() Returns a collection of connection metrics. Returns:HttpConnectionMetrics HttpConnectionMetrics

getMetrics

back to summary

public HttpConnectionMetrics getMetrics()

Returns a collection of connection metrics.

Returns:HttpConnectionMetrics: HttpConnectionMetrics

getSocketTimeout back to summary

getSocketTimeout	back to summary
public int getSocketTimeout() Returns the socket timeout value. Returns:int positive value in milliseconds if a timeout is set, `0` if timeout is disabled or `-1` if timeout is undefined.

public int getSocketTimeout()

Returns the socket timeout value.

Returns:int: positive value in milliseconds if a timeout is set, 0 if timeout is disabled or -1 if timeout is undefined.

isOpen	back to summary
public boolean isOpen() Checks if this connection is open. Returns:boolean true if it is open, false if it is closed.

isOpen

back to summary

public boolean isOpen()

Checks if this connection is open.

Returns:boolean: true if it is open, false if it is closed.

isStale back to summary

isStale	back to summary
public boolean isStale() Checks whether this connection has gone down. Network connections may get closed during some time of inactivity for several reasons. The next time a read is attempted on such a connection it will throw an IOException. This method tries to alleviate this inconvenience by trying to find out if a connection is still usable. Implementations may do that by attempting a read with a very small timeout. Thus this method may block for a small amount of time before returning a result. It is therefore an expensive operation. Returns:boolean `true` if attempts to use this connection are likely to succeed, or `false` if they are likely to fail and this connection should be closed

public boolean isStale()

Checks whether this connection has gone down. Network connections may get closed during some time of inactivity for several reasons. The next time a read is attempted on such a connection it will throw an IOException. This method tries to alleviate this inconvenience by trying to find out if a connection is still usable. Implementations may do that by attempting a read with a very small timeout. Thus this method may block for a small amount of time before returning a result. It is therefore an expensive operation.

Returns:boolean: true if attempts to use this connection are likely to succeed, or false if they are likely to fail and this connection should be closed

setSocketTimeout	back to summary
public void setSocketTimeout(int timeout) Sets the socket timeout value. Parameters timeout:int timeout value in milliseconds

setSocketTimeout

back to summary

public void setSocketTimeout(int timeout)

Sets the socket timeout value.

Parameters

timeout:int: timeout value in milliseconds

shutdown	back to summary
public void shutdown() throws IOException Force-closes this connection. This is the only method of a connection which may be called from a different thread to terminate the connection. This method will not attempt to flush the transmitter's internal buffer prior to closing the underlying socket.

public Interface HttpConnection

Method Summary

Method Detail