DefaultBHttpServerConnection (aliyun-http-apache 0.2.0-beta API)

java.lang.Object
- org.apache.hc.core5.http.impl.io.DefaultBHttpServerConnection

所有已实现的接口:

Closeable, AutoCloseable, HttpConnection, BHttpConnection, HttpServerConnection, SocketModalCloseable, ModalCloseable
```
public class DefaultBHttpServerConnection
extends Object
implements HttpServerConnection
```
Default implementation of HttpServerConnection.

从以下版本开始:

4.3

构造器概要

构造器
构造器和说明
`DefaultBHttpServerConnection(String scheme, Http1Config http1Config)`
`DefaultBHttpServerConnection(String scheme, Http1Config http1Config, CharsetDecoder charDecoder, CharsetEncoder charEncoder)`
`DefaultBHttpServerConnection(String scheme, Http1Config http1Config, CharsetDecoder charDecoder, CharsetEncoder charEncoder, ContentLengthStrategy incomingContentStrategy, ContentLengthStrategy outgoingContentStrategy, HttpMessageParserFactory<ClassicHttpRequest> requestParserFactory, HttpMessageWriterFactory<ClassicHttpResponse> responseWriterFactory)` Creates new instance of DefaultBHttpServerConnection.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected boolean`	`awaitInput(Timeout timeout)`
`void`	`bind(Socket socket)` Binds this connection to the given `Socket`.
`protected void`	`bind(SocketHolder socketHolder)`
`void`	`close()` Closes this connection gracefully.
`void`	`close(CloseMode closeMode)` 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)`
`protected SocketHolder`	`ensureOpen()`
`void`	`flush()` Writes out all pending buffered data over the open connection.
`EndpointDetails`	`getEndpointDetails()` Returns this connection's endpoint details.
`SocketAddress`	`getLocalAddress()` Returns this connection's local address or `null` if it is not bound yet.
`ProtocolVersion`	`getProtocolVersion()` Returns this connection's protocol version or `null` if unknown.
`SocketAddress`	`getRemoteAddress()` Returns this connection's remote address or `null` if it is not connected yet or unconnected.
`protected SocketHolder`	`getSocketHolder()`
`Timeout`	`getSocketTimeout()` Returns the socket timeout value.
`SSLSession`	`getSSLSession()` Returns this connection's SSL session or `null` if TLS has not been activated.
`protected void`	`incrementRequestCount()`
`protected void`	`incrementResponseCount()`
`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.
`protected void`	`onRequestReceived(ClassicHttpRequest request)`
`protected void`	`onResponseSubmitted(ClassicHttpResponse response)`
`void`	`receiveRequestEntity(ClassicHttpRequest request)` Receives the next request entity available from this connection and attaches it to an existing request.
`ClassicHttpRequest`	`receiveRequestHeader()` Receives the request line and all headers available from this connection.
`void`	`sendResponseEntity(ClassicHttpResponse response)` Sends the response entity of a response over this connection.
`void`	`sendResponseHeader(ClassicHttpResponse response)` Sends the response line and headers of a response over this connection.
`void`	`setSocketTimeout(Timeout timeout)` Sets the socket timeout value.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.apache.hc.core5.http.io.BHttpConnection
flush, isDataAvailable, isStale

从接口继承的方法 org.apache.hc.core5.http.HttpConnection
close, getEndpointDetails, getLocalAddress, getProtocolVersion, getRemoteAddress, getSSLSession, isOpen

从接口继承的方法 org.apache.hc.core5.http.SocketModalCloseable
getSocketTimeout, setSocketTimeout

从接口继承的方法 org.apache.hc.core5.io.ModalCloseable
close

- 构造器详细资料
  - DefaultBHttpServerConnection
```
public DefaultBHttpServerConnection(String scheme,
                                    Http1Config http1Config,
                                    CharsetDecoder charDecoder,
                                    CharsetEncoder charEncoder,
                                    ContentLengthStrategy incomingContentStrategy,
                                    ContentLengthStrategy outgoingContentStrategy,
                                    HttpMessageParserFactory<ClassicHttpRequest> requestParserFactory,
                                    HttpMessageWriterFactory<ClassicHttpResponse> responseWriterFactory)
```
    Creates new instance of DefaultBHttpServerConnection.
    
    参数:
    
    scheme - protocol scheme
    
    http1Config - Message http1Config. If null Http1Config.DEFAULT will be used.
    
    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.
    
    incomingContentStrategy - incoming content length strategy. If null DefaultContentLengthStrategy.INSTANCE will be used.
    
    outgoingContentStrategy - outgoing content length strategy. If null DefaultContentLengthStrategy.INSTANCE will be used.
    
    requestParserFactory - request parser factory. If null DefaultHttpRequestParserFactory.INSTANCE will be used.
    
    responseWriterFactory - response writer factory. If null DefaultHttpResponseWriterFactory.INSTANCE will be used.
  - DefaultBHttpServerConnection
```
public DefaultBHttpServerConnection(String scheme,
                                    Http1Config http1Config,
                                    CharsetDecoder charDecoder,
                                    CharsetEncoder charEncoder)
```
  - DefaultBHttpServerConnection
```
public DefaultBHttpServerConnection(String scheme,
                                    Http1Config http1Config)
```
- 方法详细资料
  - onRequestReceived
```
protected void onRequestReceived(ClassicHttpRequest request)
```
  - onResponseSubmitted
```
protected void onResponseSubmitted(ClassicHttpResponse response)
```
  - bind
```
public void bind(Socket socket)
          throws 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.
    
    参数:
    
    socket - the socket.
    
    抛出:
    
    IOException - in case of an I/O error.
  - receiveRequestHeader
```
public ClassicHttpRequest receiveRequestHeader()
                                        throws HttpException,
                                               IOException
```
    从接口复制的说明: HttpServerConnection
    
    Receives the request line and all headers available from this connection. The caller should examine the returned request and decide if to receive a request entity as well.
    
    指定者:
    
    receiveRequestHeader 在接口中 HttpServerConnection
    
    返回:
    
    a new HttpRequest object whose request line and headers are initialized or null if the connection has been closed by the opposite endpoint.
    
    抛出:
    
    HttpException - in case of HTTP protocol violation
    
    IOException - in case of an I/O error
  - receiveRequestEntity
```
public void receiveRequestEntity(ClassicHttpRequest request)
                          throws HttpException,
                                 IOException
```
    从接口复制的说明: HttpServerConnection
    
    Receives the next request entity available from this connection and attaches it to an existing request.
    
    指定者:
    
    receiveRequestEntity 在接口中 HttpServerConnection
    
    参数:
    
    request - the request to attach the entity to.
    
    抛出:
    
    HttpException - in case of HTTP protocol violation
    
    IOException - in case of an I/O error
  - sendResponseHeader
```
public void sendResponseHeader(ClassicHttpResponse response)
                        throws HttpException,
                               IOException
```
    从接口复制的说明: HttpServerConnection
    
    Sends the response line and headers of a response over this connection.
    
    指定者:
    
    sendResponseHeader 在接口中 HttpServerConnection
    
    参数:
    
    response - the response whose headers to send.
    
    抛出:
    
    HttpException - in case of HTTP protocol violation
    
    IOException - in case of an I/O error
  - sendResponseEntity
```
public void sendResponseEntity(ClassicHttpResponse response)
                        throws HttpException,
                               IOException
```
    从接口复制的说明: HttpServerConnection
    
    Sends the response entity of a response over this connection.
    
    指定者:
    
    sendResponseEntity 在接口中 HttpServerConnection
    
    参数:
    
    response - the response whose entity to send.
    
    抛出:
    
    HttpException - in case of HTTP protocol violation
    
    IOException - in case of an I/O error
  - ensureOpen
```
protected SocketHolder ensureOpen()
                           throws IOException
```
    抛出:
    
    IOException
  - bind
```
protected void bind(SocketHolder socketHolder)
             throws IOException
```
    抛出:
    
    IOException
  - isOpen
```
public boolean isOpen()
```
    从接口复制的说明: HttpConnection
    
    Checks if this connection is open.
    
    指定者:
    
    isOpen 在接口中 HttpConnection
    
    返回:
    
    true if it is open, false if it is closed.
  - getProtocolVersion
```
public ProtocolVersion getProtocolVersion()
```
    从接口复制的说明: HttpConnection
    
    Returns this connection's protocol version or null if unknown.
    
    指定者:
    
    getProtocolVersion 在接口中 HttpConnection
    
    返回:
    
    this connection's protocol version or null if unknown.
    
    从以下版本开始:
    
    5.0
  - getSocketHolder
```
protected SocketHolder getSocketHolder()
```
  - createContentOutputStream
```
protected OutputStream createContentOutputStream(long len,
                                                 SessionOutputBuffer buffer,
                                                 OutputStream outputStream,
                                                 Supplier<List<? extends Header>> trailers)
```
  - createContentInputStream
```
protected InputStream createContentInputStream(long len,
                                               SessionInputBuffer buffer,
                                               InputStream inputStream)
```
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
```
    从接口复制的说明: HttpConnection
    
    Returns this connection's remote address or null if it is not connected yet or unconnected.
    
    指定者:
    
    getRemoteAddress 在接口中 HttpConnection
    
    返回:
    
    this connection's remote address or null if it is not connected yet or unconnected.
  - getLocalAddress
```
public SocketAddress getLocalAddress()
```
    从接口复制的说明: HttpConnection
    
    Returns this connection's local address or null if it is not bound yet.
    
    指定者:
    
    getLocalAddress 在接口中 HttpConnection
    
    返回:
    
    this connection's local address or null if it is not bound yet.
  - setSocketTimeout
```
public void setSocketTimeout(Timeout timeout)
```
    从接口复制的说明: SocketModalCloseable
    
    Sets the socket timeout value.
    
    指定者:
    
    setSocketTimeout 在接口中 SocketModalCloseable
    
    参数:
    
    timeout - timeout value
  - getSocketTimeout
```
public Timeout getSocketTimeout()
```
    从接口复制的说明: SocketModalCloseable
    
    Returns the socket timeout value.
    
    指定者:
    
    getSocketTimeout 在接口中 SocketModalCloseable
    
    返回:
    
    timeout value.
  - close
```
public void close(CloseMode closeMode)
```
    从接口复制的说明: 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.
    
    指定者:
    
    close 在接口中 ModalCloseable
    
    参数:
    
    closeMode - How to close the receiver.
  - close
```
public void close()
           throws IOException
```
    从接口复制的说明: 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.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 HttpConnection
    
    抛出:
    
    IOException
  - awaitInput
```
protected boolean awaitInput(Timeout timeout)
                      throws IOException
```
    抛出:
    
    IOException
  - isDataAvailable
```
public boolean isDataAvailable(Timeout timeout)
                        throws IOException
```
    从接口复制的说明: 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.
    
    指定者:
    
    isDataAvailable 在接口中 BHttpConnection
    
    参数:
    
    timeout - the maximum time to wait for data
    
    返回:
    
    true if data is available; false if there was no data available even after waiting for timeout.
    
    抛出:
    
    IOException - if an error happens on the connection
  - isStale
```
public boolean isStale()
                throws IOException
```
    从接口复制的说明: 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.
    
    指定者:
    
    isStale 在接口中 BHttpConnection
    
    返回:
    
    true if attempts to use this connection are likely to fail and this connection should be closed, or false if they are likely to succeed
    
    抛出:
    
    IOException
  - flush
```
public void flush()
           throws IOException
```
    从接口复制的说明: BHttpConnection
    
    Writes out all pending buffered data over the open connection.
    
    指定者:
    
    flush 在接口中 BHttpConnection
    
    抛出:
    
    IOException - in case of an I/O error
  - incrementRequestCount
```
protected void incrementRequestCount()
```
  - incrementResponseCount
```
protected void incrementResponseCount()
```
  - getSSLSession
```
public SSLSession getSSLSession()
```
    从接口复制的说明: HttpConnection
    
    Returns this connection's SSL session or null if TLS has not been activated.
    
    指定者:
    
    getSSLSession 在接口中 HttpConnection
    
    返回:
    
    this connection's SSL session or null if TLS has not been activated.
  - getEndpointDetails
```
public EndpointDetails getEndpointDetails()
```
    从接口复制的说明: HttpConnection
    
    Returns this connection's endpoint details.
    
    指定者:
    
    getEndpointDetails 在接口中 HttpConnection
    
    返回:
    
    this connection's endpoint details.
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 DefaultBHttpServerConnection

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.hc.core5.http.io.BHttpConnection

从接口继承的方法 org.apache.hc.core5.http.HttpConnection

从接口继承的方法 org.apache.hc.core5.http.SocketModalCloseable

从接口继承的方法 org.apache.hc.core5.io.ModalCloseable

构造器详细资料

DefaultBHttpServerConnection

DefaultBHttpServerConnection

DefaultBHttpServerConnection

方法详细资料

onRequestReceived

onResponseSubmitted

bind

receiveRequestHeader

receiveRequestEntity

sendResponseHeader

sendResponseEntity

ensureOpen

bind

isOpen

getProtocolVersion

getSocketHolder

createContentOutputStream

createContentInputStream

getRemoteAddress

getLocalAddress

setSocketTimeout

getSocketTimeout

close

close

awaitInput

isDataAvailable

isStale

flush

incrementRequestCount

incrementResponseCount

getSSLSession

getEndpointDetails

toString