FileDocCategorySizeDatePackage
HttpConnection.javaAPI DocAndroid 1.5 API4002Wed May 06 22:41:10 BST 2009org.apache.http

HttpConnection

public interface HttpConnection
A generic HTTP connection, useful on client and server side.
author
Oleg Kalnichevski
version
$Revision: 548031 $
since
4.0

Fields Summary
Constructors Summary
Methods Summary
public voidclose()
Closes this connection gracefully. This method will attempt to flush the transmitter's internal buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use {@link #shutdown shutdown} instead.

public org.apache.http.HttpConnectionMetricsgetMetrics()
Returns a collection of connection metrcis

return
HttpConnectionMetrics

public intgetSocketTimeout()
Returns the socket timeout value.

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

public booleanisOpen()
Checks if this connection is open.

return
true if it is open, false if it is closed.

public booleanisStale()
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.

return
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 voidsetSocketTimeout(int timeout)
Sets the socket timeout value.

param
timeout timeout value in milliseconds

public voidshutdown()
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.