public interface

HttpClientConnection

implements HttpConnection
org.apache.http.HttpClientConnection
Known Indirect Subclasses

Class Overview

An HTTP connection for use on the client side. It is used for sending requests and receiving responses.

Summary

Public Methods
abstract void flush()
Writes out all pending buffered data over the open connection.
abstract boolean isResponseAvailable(int timeout)
Checks if response data is available from the connection.
abstract void receiveResponseEntity(HttpResponse response)
Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
abstract HttpResponse receiveResponseHeader()
Receives the request line and headers of the next response available from this connection.
abstract void sendRequestEntity(HttpEntityEnclosingRequest request)
Sends the request entity over the connection.
abstract void sendRequestHeader(HttpRequest request)
Sends the request line and all headers over the connection.
[Expand]
Inherited Methods
From interface org.apache.http.HttpConnection

Public Methods

public abstract void flush ()

Since: API Level 1

Writes out all pending buffered data over the open connection.

Throws
IOException

public abstract boolean isResponseAvailable (int timeout)

Since: API Level 1

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 the maximum time in milliseconds to wait for data
Returns
  • true if data is available; false if there was no data available even after waiting for timeout milliseconds.
Throws
IOException if an error happens on the connection

public abstract void receiveResponseEntity (HttpResponse response)

Since: API Level 1

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

Parameters
response the response to attach the entity to
Throws
HttpException
IOException
HttpException

public abstract HttpResponse receiveResponseHeader ()

Since: API Level 1

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
  • a new HttpResponse object with status line and headers initialized.
Throws
HttpException
IOException
HttpException

public abstract void sendRequestEntity (HttpEntityEnclosingRequest request)

Since: API Level 1

Sends the request entity over the connection.

Parameters
request the request whose entity to send.
Throws
HttpException
IOException
HttpException

public abstract void sendRequestHeader (HttpRequest request)

Since: API Level 1

Sends the request line and all headers over the connection.

Parameters
request the request whose headers to send.
Throws
HttpException
IOException