Top Description Methods
org.apache.http

public Interface HttpClientConnection

extends HttpConnection
Known Direct Implementers
org.apache.http.impl.AbstractHttpClientConnection, org.apache.http.impl.DefaultBHttpClientConnection
Imports
java.io.IOException
A client-side HTTP connection, which can be used for sending requests and receiving responses.
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public void
flush()

Writes out all pending buffered data over the open connection.

public boolean

Returns:

true if data is available; false if there was no data available even after waiting for timeout milliseconds.
isResponseAvailable(int
the maximum time in milliseconds to wait for data
timeout)

Checks if response data is available from the connection.

public void
receiveResponseEntity(HttpResponse
the response to attach the entity to
response)

Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.

public HttpResponse

Returns:

a new HttpResponse object with status line and headers initialized.
receiveResponseHeader()

Receives the request line and headers of the next response available from this connection.

public void
sendRequestEntity(HttpEntityEnclosingRequest
the request whose entity to send.
request)

Sends the request entity over the connection.

public void
sendRequestHeader(HttpRequest
the request whose headers to send.
request)

Sends the request line and all headers over the connection.

Inherited from org.apache.http.HttpConnection:
closegetMetricsgetSocketTimeoutisOpenisStalesetSocketTimeoutshutdown

Method Detail

flushback to summary
public void flush() throws IOException

Writes out all pending buffered data over the open connection.

Exceptions
IOException:
in case of an I/O error
isResponseAvailableback to summary
public boolean isResponseAvailable(int timeout) throws IOException

Checks if response data is available from the connection. May wait for the specified time until some data becomes available. Note that some implementations may completely ignore the timeout parameter.

Parameters
timeout:int

the maximum time in milliseconds to wait for data

Returns:boolean

true if data is available; false if there was no data available even after waiting for timeout milliseconds.

Exceptions
IOException:
if an error happens on the connection
receiveResponseEntityback to summary
public void receiveResponseEntity(HttpResponse response) throws HttpException, IOException

Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.

Parameters
response:HttpResponse

the response to attach the entity to

Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error
receiveResponseHeaderback to summary
public HttpResponse receiveResponseHeader() throws HttpException, IOException

Receives the request line and headers of the next response available from this connection. The caller should examine the HttpResponse object to find out if it should try to receive a response entity as well.

Returns:HttpResponse

a new HttpResponse object with status line and headers initialized.

Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error
sendRequestEntityback to summary
public void sendRequestEntity(HttpEntityEnclosingRequest request) throws HttpException, IOException

Sends the request entity over the connection.

Parameters
request:HttpEntityEnclosingRequest

the request whose entity to send.

Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error
sendRequestHeaderback to summary
public void sendRequestHeader(HttpRequest request) throws HttpException, IOException

Sends the request line and all headers over the connection.

Parameters
request:HttpRequest

the request whose headers to send.

Exceptions
HttpException:
in case of HTTP protocol violation
IOException:
in case of an I/O error