public abstract class

AbstractHttpClientConnection

extends Object
implements HttpClientConnection
java.lang.Object
   ↳ org.apache.http.impl.AbstractHttpClientConnection
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract client-side HTTP connection capable of transmitting and receiving data using arbitrary SessionInputBuffer and SessionOutputBuffer

Summary

Public Constructors
AbstractHttpClientConnection()
Public Methods
void flush()
Writes out all pending buffered data over the open connection.
HttpConnectionMetrics getMetrics()
Returns a collection of connection metrcis
boolean isResponseAvailable(int timeout)
Checks if response data is available from the connection.
boolean isStale()
Checks whether this connection has gone down.
void receiveResponseEntity(HttpResponse response)
Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.
HttpResponse receiveResponseHeader()
Receives the request line and headers of the next response available from this connection.
void sendRequestEntity(HttpEntityEnclosingRequest request)
Sends the request entity over the connection.
void sendRequestHeader(HttpRequest request)
Sends the request line and all headers over the connection.
Protected Methods
abstract void assertOpen()
EntityDeserializer createEntityDeserializer()
EntitySerializer createEntitySerializer()
HttpResponseFactory createHttpResponseFactory()
HttpMessageWriter createRequestWriter(SessionOutputBuffer buffer, HttpParams params)
HttpMessageParser createResponseParser(SessionInputBuffer buffer, HttpResponseFactory responseFactory, HttpParams params)
void doFlush()
void init(SessionInputBuffer inbuffer, SessionOutputBuffer outbuffer, HttpParams params)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.HttpClientConnection
From interface org.apache.http.HttpConnection

Public Constructors

public AbstractHttpClientConnection ()

Since: API Level 1

Public Methods

public void flush ()

Since: API Level 1

Writes out all pending buffered data over the open connection.

Throws
IOException

public HttpConnectionMetrics getMetrics ()

Since: API Level 1

Returns a collection of connection metrcis

Returns
  • HttpConnectionMetrics

public 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

public boolean isStale ()

Since: API Level 1

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
  • 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 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

public 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

public 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

public 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

Protected Methods

protected abstract void assertOpen ()

Since: API Level 1

Throws
IllegalStateException

protected EntityDeserializer createEntityDeserializer ()

Since: API Level 1

protected EntitySerializer createEntitySerializer ()

Since: API Level 1

protected HttpResponseFactory createHttpResponseFactory ()

Since: API Level 1

protected HttpMessageWriter createRequestWriter (SessionOutputBuffer buffer, HttpParams params)

Since: API Level 1

protected HttpMessageParser createResponseParser (SessionInputBuffer buffer, HttpResponseFactory responseFactory, HttpParams params)

Since: API Level 1

protected void doFlush ()

Since: API Level 1

Throws
IOException

protected void init (SessionInputBuffer inbuffer, SessionOutputBuffer outbuffer, HttpParams params)

Since: API Level 1