java.lang.Object
- org.apache.http.impl.BHttpConnectionBase

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, HttpConnection, HttpInetConnection

Direct Known Subclasses:

DefaultBHttpClientConnection, DefaultBHttpServerConnection
```
public class BHttpConnectionBase
extends java.lang.Object
implements HttpInetConnection
```
This class serves as a base for all HttpConnection implementations and provides functionality common to both client and server HTTP connections.

Since:

4.0

Field Summary

Fields
Modifier and Type	Field	Description
`private HttpConnectionMetricsImpl`	`connMetrics`
`private SessionInputBufferImpl`	`inBuffer`
`private ContentLengthStrategy`	`incomingContentStrategy`
`private MessageConstraints`	`messageConstraints`
`private SessionOutputBufferImpl`	`outbuffer`
`private ContentLengthStrategy`	`outgoingContentStrategy`
`private java.util.concurrent.atomic.AtomicReference<java.net.Socket>`	`socketHolder`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`BHttpConnectionBase(int bufferSize, int fragmentSizeHint, java.nio.charset.CharsetDecoder charDecoder, java.nio.charset.CharsetEncoder charEncoder, MessageConstraints messageConstraints, ContentLengthStrategy incomingContentStrategy, ContentLengthStrategy outgoingContentStrategy)`	Creates new instance of BHttpConnectionBase.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`awaitInput(int timeout)`
`protected void`	`bind(java.net.Socket socket)`	Binds this connection to the given `Socket`.
`void`	`close()`	Closes this connection gracefully.
`protected java.io.InputStream`	`createInputStream(long len, SessionInputBuffer inBuffer)`
`protected java.io.OutputStream`	`createOutputStream(long len, SessionOutputBuffer outbuffer)`
`protected void`	`doFlush()`
`protected void`	`ensureOpen()`
`private int`	`fillInputBuffer(int timeout)`
`java.net.InetAddress`	`getLocalAddress()`
`int`	`getLocalPort()`
`HttpConnectionMetrics`	`getMetrics()`	Returns a collection of connection metrics.
`java.net.InetAddress`	`getRemoteAddress()`
`int`	`getRemotePort()`
`protected SessionInputBuffer`	`getSessionInputBuffer()`
`protected SessionOutputBuffer`	`getSessionOutputBuffer()`
`protected java.net.Socket`	`getSocket()`
`protected java.io.InputStream`	`getSocketInputStream(java.net.Socket socket)`
`protected java.io.OutputStream`	`getSocketOutputStream(java.net.Socket socket)`
`int`	`getSocketTimeout()`	Returns the socket timeout value.
`protected void`	`incrementRequestCount()`
`protected void`	`incrementResponseCount()`
`boolean`	`isOpen()`	Checks if this connection is open.
`boolean`	`isStale()`	Checks whether this connection has gone down.
`protected HttpEntity`	`prepareInput(HttpMessage message)`
`protected java.io.OutputStream`	`prepareOutput(HttpMessage message)`
`void`	`setSocketTimeout(int timeout)`	Sets the socket timeout value.
`void`	`shutdown()`	Force-closes this connection.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - inBuffer
```
private final SessionInputBufferImpl inBuffer
```
  - outbuffer
```
private final SessionOutputBufferImpl outbuffer
```
  - messageConstraints
```
private final MessageConstraints messageConstraints
```
  - connMetrics
```
private final HttpConnectionMetricsImpl connMetrics
```
  - incomingContentStrategy
```
private final ContentLengthStrategy incomingContentStrategy
```
  - outgoingContentStrategy
```
private final ContentLengthStrategy outgoingContentStrategy
```
  - socketHolder
```
private final java.util.concurrent.atomic.AtomicReference<java.net.Socket> socketHolder
```
- Constructor Detail
  - BHttpConnectionBase
```
protected BHttpConnectionBase(int bufferSize,
                              int fragmentSizeHint,
                              java.nio.charset.CharsetDecoder charDecoder,
                              java.nio.charset.CharsetEncoder charEncoder,
                              MessageConstraints messageConstraints,
                              ContentLengthStrategy incomingContentStrategy,
                              ContentLengthStrategy outgoingContentStrategy)
```
    Creates new instance of BHttpConnectionBase.
    
    Parameters:
    
    bufferSize - buffer size. Must be a positive number.
    
    fragmentSizeHint - fragment size hint.
    
    charDecoder - decoder to be used for decoding HTTP protocol elements. If null simple type cast will be used for byte to char conversion.
    
    charEncoder - encoder to be used for encoding HTTP protocol elements. If null simple type cast will be used for char to byte conversion.
    
    messageConstraints - Message constraints. If null MessageConstraints.DEFAULT will be used.
    
    incomingContentStrategy - incoming content length strategy. If null LaxContentLengthStrategy.INSTANCE will be used.
    
    outgoingContentStrategy - outgoing content length strategy. If null StrictContentLengthStrategy.INSTANCE will be used.
- Method Detail
  - ensureOpen
```
protected void ensureOpen()
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getSocketInputStream
```
protected java.io.InputStream getSocketInputStream(java.net.Socket socket)
                                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getSocketOutputStream
```
protected java.io.OutputStream getSocketOutputStream(java.net.Socket socket)
                                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - bind
```
protected void bind(java.net.Socket socket)
             throws java.io.IOException
```
    Binds this connection to the given Socket. 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 return true.
    
    Parameters:
    
    socket - the socket.
    
    Throws:
    
    java.io.IOException - in case of an I/O error.
  - getSessionInputBuffer
```
protected SessionInputBuffer getSessionInputBuffer()
```
  - getSessionOutputBuffer
```
protected SessionOutputBuffer getSessionOutputBuffer()
```
  - doFlush
```
protected void doFlush()
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: HttpConnection
    
    Checks if this connection is open.
    
    Specified by:
    
    isOpen in interface HttpConnection
    
    Returns:
    
    true if it is open, false if it is closed.
  - getSocket
```
protected java.net.Socket getSocket()
```
  - createOutputStream
```
protected java.io.OutputStream createOutputStream(long len,
                                                  SessionOutputBuffer outbuffer)
```
  - prepareOutput
```
protected java.io.OutputStream prepareOutput(HttpMessage message)
                                      throws HttpException
```
    Throws:
    
    HttpException
  - createInputStream
```
protected java.io.InputStream createInputStream(long len,
                                                SessionInputBuffer inBuffer)
```
  - prepareInput
```
protected HttpEntity prepareInput(HttpMessage message)
                           throws HttpException
```
    Throws:
    
    HttpException
  - getLocalAddress
```
public java.net.InetAddress getLocalAddress()
```
    Specified by:
    
    getLocalAddress in interface HttpInetConnection
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface HttpInetConnection
  - getRemoteAddress
```
public java.net.InetAddress getRemoteAddress()
```
    Specified by:
    
    getRemoteAddress in interface HttpInetConnection
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface HttpInetConnection
  - setSocketTimeout
```
public void setSocketTimeout(int timeout)
```
    Description copied from interface: HttpConnection
    
    Sets the socket timeout value.
    
    Specified by:
    
    setSocketTimeout in interface HttpConnection
    
    Parameters:
    
    timeout - timeout value in milliseconds
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Description copied from interface: HttpConnection
    
    Returns the socket timeout value.
    
    Specified by:
    
    getSocketTimeout in interface HttpConnection
    
    Returns:
    
    positive value in milliseconds if a timeout is set, 0 if timeout is disabled or -1 if timeout is undefined.
  - shutdown
```
public void shutdown()
              throws java.io.IOException
```
    Description copied from interface: HttpConnection
    
    Force-closes this connection. This is the only method of a connection which may be called from a different thread to terminate the connection. This method will not attempt to flush the transmitter's internal buffer prior to closing the underlying socket.
    
    Specified by:
    
    shutdown in interface HttpConnection
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    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. Use shutdown instead.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface HttpConnection
    
    Throws:
    
    java.io.IOException
  - fillInputBuffer
```
private int fillInputBuffer(int timeout)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - awaitInput
```
protected boolean awaitInput(int timeout)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isStale
```
public boolean isStale()
```
    Description copied from interface: HttpConnection
    
    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 interface HttpConnection
    
    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
  - incrementRequestCount
```
protected void incrementRequestCount()
```
  - incrementResponseCount
```
protected void incrementResponseCount()
```
  - getMetrics
```
public HttpConnectionMetrics getMetrics()
```
    Description copied from interface: HttpConnection
    
    Returns a collection of connection metrics.
    
    Specified by:
    
    getMetrics in interface HttpConnection
    
    Returns:
    
    HttpConnectionMetrics
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BHttpConnectionBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inBuffer

outbuffer

messageConstraints

connMetrics

incomingContentStrategy

outgoingContentStrategy

socketHolder

Constructor Detail

BHttpConnectionBase

Method Detail

ensureOpen

getSocketInputStream

getSocketOutputStream

bind

getSessionInputBuffer

getSessionOutputBuffer

doFlush

isOpen

getSocket

createOutputStream

prepareOutput

createInputStream

prepareInput

getLocalAddress

getLocalPort

getRemoteAddress

getRemotePort

setSocketTimeout

getSocketTimeout

shutdown

close

fillInputBuffer

awaitInput

isStale

incrementRequestCount

incrementResponseCount

getMetrics

toString