Package org.apache.hc.core5.http.impl.io
Class BHttpConnectionBase
java.lang.Object
org.apache.hc.core5.http.impl.io.BHttpConnectionBase
- All Implemented Interfaces:
Closeable
,AutoCloseable
,HttpConnection
,BHttpConnection
,SocketModalCloseable
,ModalCloseable
- Direct Known Subclasses:
DefaultBHttpClientConnection
,DefaultBHttpServerConnection
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
(package private) final BasicHttpConnectionMetrics
(package private) EndpointDetails
(package private) final Http1Config
(package private) final SessionInputBufferImpl
(package private) final SessionOutputBufferImpl
(package private) final AtomicReference
<SocketHolder> private static final Timeout
(package private) ProtocolVersion
-
Constructor Summary
ConstructorsConstructorDescriptionBHttpConnectionBase
(Http1Config http1Config, CharsetDecoder charDecoder, CharsetEncoder charEncoder) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
awaitInput
(Timeout timeout) protected void
Binds this connection to the givenSocket
.protected void
bind
(SocketHolder socketHolder) void
close()
Closes this connection gracefully.void
Closes this process or endpoint and releases any system resources associated with it.protected InputStream
createContentInputStream
(long len, SessionInputBuffer buffer, InputStream inputStream) protected OutputStream
createContentOutputStream
(long len, SessionOutputBuffer buffer, OutputStream outputStream, Supplier<List<? extends Header>> trailers) (package private) HttpEntity
createIncomingEntity
(HttpMessage message, SessionInputBuffer inBuffer, InputStream inputStream, long len) protected SocketHolder
private int
fillInputBuffer
(Timeout timeout) void
flush()
Writes out all pending buffered data over the open connection.private byte[]
Returns this connection's endpoint details.Returns this connection's local address ornull
if it is not bound yet.Returns this connection's protocol version ornull
if unknown.Returns this connection's remote address ornull
if it is not connected yet or unconnected.protected SocketHolder
Returns the socket timeout value.Returns this connection's SSL session ornull
if TLS has not been activated.protected void
protected void
boolean
isDataAvailable
(Timeout timeout) Checks if input data is available from the connection.boolean
isOpen()
Checks if this connection is open.boolean
isStale()
Checks whether this connection has gone down.void
setSocketTimeout
(Timeout timeout) Sets the socket timeout value.toString()
-
Field Details
-
STALE_CHECK_TIMEOUT
-
http1Config
-
inBuffer
-
outbuffer
-
connMetrics
-
socketHolderRef
-
chunkedRequestBuffer
private byte[] chunkedRequestBuffer -
version
-
endpointDetails
-
-
Constructor Details
-
BHttpConnectionBase
BHttpConnectionBase(Http1Config http1Config, CharsetDecoder charDecoder, CharsetEncoder charEncoder)
-
-
Method Details
-
ensureOpen
- Throws:
IOException
-
bind
Binds this connection to the givenSocket
. This socket will be used by the connection to send and receive data.After this method's execution the connection status will be reported as open and the
isOpen()
will returntrue
.- Parameters:
socket
- the socket.- Throws:
IOException
- in case of an I/O error.
-
bind
- Throws:
IOException
-
isOpen
public boolean isOpen()Description copied from interface:HttpConnection
Checks if this connection is open.- Specified by:
isOpen
in interfaceHttpConnection
- Returns:
- true if it is open, false if it is closed.
-
getProtocolVersion
Description copied from interface:HttpConnection
Returns this connection's protocol version ornull
if unknown.- Specified by:
getProtocolVersion
in interfaceHttpConnection
- Returns:
- this connection's protocol version or
null
if unknown. - Since:
- 5.0
-
getSocketHolder
-
createContentOutputStream
protected OutputStream createContentOutputStream(long len, SessionOutputBuffer buffer, OutputStream outputStream, Supplier<List<? extends Header>> trailers) -
getChunkedRequestBuffer
private byte[] getChunkedRequestBuffer() -
createContentInputStream
protected InputStream createContentInputStream(long len, SessionInputBuffer buffer, InputStream inputStream) -
createIncomingEntity
HttpEntity createIncomingEntity(HttpMessage message, SessionInputBuffer inBuffer, InputStream inputStream, long len) -
getRemoteAddress
Description copied from interface:HttpConnection
Returns this connection's remote address ornull
if it is not connected yet or unconnected.- Specified by:
getRemoteAddress
in interfaceHttpConnection
- Returns:
- this connection's remote address or
null
if it is not connected yet or unconnected.
-
getLocalAddress
Description copied from interface:HttpConnection
Returns this connection's local address ornull
if it is not bound yet.- Specified by:
getLocalAddress
in interfaceHttpConnection
- Returns:
- this connection's local address or
null
if it is not bound yet.
-
setSocketTimeout
Description copied from interface:SocketModalCloseable
Sets the socket timeout value.- Specified by:
setSocketTimeout
in interfaceSocketModalCloseable
- Parameters:
timeout
- timeout value
-
getSocketTimeout
Description copied from interface:SocketModalCloseable
Returns the socket timeout value.- Specified by:
getSocketTimeout
in interfaceSocketModalCloseable
- Returns:
- timeout value.
-
close
Description copied from interface:ModalCloseable
Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.- Specified by:
close
in interfaceModalCloseable
- Parameters:
closeMode
- How to close the receiver.
-
close
Description copied from interface:HttpConnection
Closes this connection gracefully. This method will attempt to flush the internal output buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Useshutdown
instead.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceHttpConnection
- Throws:
IOException
-
fillInputBuffer
- Throws:
IOException
-
awaitInput
- Throws:
IOException
-
isDataAvailable
Description copied from interface:BHttpConnection
Checks if input 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.- Specified by:
isDataAvailable
in interfaceBHttpConnection
- Parameters:
timeout
- the maximum time to wait for data- Returns:
- true if data is available; false if there was no data available
even after waiting for
timeout
. - Throws:
IOException
- if an error happens on the connection
-
isStale
Description copied from interface:BHttpConnection
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.- Specified by:
isStale
in interfaceBHttpConnection
- Returns:
true
if attempts to use this connection are likely to fail and this connection should be closed, orfalse
if they are likely to succeed- Throws:
IOException
-
flush
Description copied from interface:BHttpConnection
Writes out all pending buffered data over the open connection.- Specified by:
flush
in interfaceBHttpConnection
- Throws:
IOException
- in case of an I/O error
-
incrementRequestCount
protected void incrementRequestCount() -
incrementResponseCount
protected void incrementResponseCount() -
getSSLSession
Description copied from interface:HttpConnection
Returns this connection's SSL session ornull
if TLS has not been activated.- Specified by:
getSSLSession
in interfaceHttpConnection
- Returns:
- this connection's SSL session or
null
if TLS has not been activated.
-
getEndpointDetails
Description copied from interface:HttpConnection
Returns this connection's endpoint details.- Specified by:
getEndpointDetails
in interfaceHttpConnection
- Returns:
- this connection's endpoint details.
-
toString
-