Package org.apache.hc.core5.http.io
Interface HttpClientConnection
- All Superinterfaces:
AutoCloseable
,BHttpConnection
,Closeable
,HttpConnection
,ModalCloseable
,SocketModalCloseable
- All Known Implementing Classes:
DefaultBHttpClientConnection
,LoggingBHttpClientConnection
A client-side HTTP connection, which can be used for sending
requests and receiving responses.
- Since:
- 4.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks whether this connection is in a consistent state.void
receiveResponseEntity
(ClassicHttpResponse response) Receives the next response entity available from this connection and attaches it to an existing HttpResponse object.Receives the request line and headers of the next response available from this connection.void
sendRequestEntity
(ClassicHttpRequest request) Sends the request entity over the connection.void
sendRequestHeader
(ClassicHttpRequest request) Sends the request line and all headers over the connection.void
terminateRequest
(ClassicHttpRequest request) Terminates request prematurely potentially leaving the connection in a inconsistent state.Methods inherited from interface org.apache.hc.core5.http.io.BHttpConnection
flush, isDataAvailable, isStale
Methods inherited from interface org.apache.hc.core5.http.HttpConnection
close, getEndpointDetails, getLocalAddress, getProtocolVersion, getRemoteAddress, getSSLSession, isOpen
Methods inherited from interface org.apache.hc.core5.io.ModalCloseable
close
Methods inherited from interface org.apache.hc.core5.http.SocketModalCloseable
getSocketTimeout, setSocketTimeout
-
Method Details
-
isConsistent
boolean isConsistent()Checks whether this connection is in a consistent state.- Returns:
true
if the connection is known to be in a inconsistent state and cannot be re-used.- Since:
- 5.0
- See Also:
-
sendRequestHeader
Sends the request line and all headers over the connection.- Parameters:
request
- the request whose headers to send.- Throws:
HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O error
-
terminateRequest
Terminates request prematurely potentially leaving the connection in a inconsistent state.- Parameters:
request
- the request to be terminated prematurely.- Throws:
HttpException
IOException
- Since:
- 5.0
- See Also:
-
sendRequestEntity
Sends the request entity over the connection.- Parameters:
request
- the request whose entity to send.- Throws:
HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O error
-
receiveResponseHeader
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 or
null
if the connection has been closed by the opposite endpoint. - Throws:
HttpException
- in case of HTTP protocol violationIOException
- in case of an I/O error
-
receiveResponseEntity
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
- in case of HTTP protocol violationIOException
- in case of an I/O error
-