depends.org.apache.http.impl.nio

类 NHttpConnectionBase

java.lang.Object

depends.org.apache.http.impl.nio.NHttpConnectionBase

所有已实现的接口:

HttpConnection, HttpInetConnection, IOControl, NHttpConnection, SessionBufferStatus, SocketAccessor, java.io.Closeable, java.lang.AutoCloseable

直接已知子类:

DefaultNHttpClientConnection, DefaultNHttpServerConnection

@NotThreadSafe
public class NHttpConnectionBase
extends java.lang.Object
implements NHttpConnection, HttpInetConnection, SessionBufferStatus, SocketAccessor

This class serves as a base for all NHttpConnection implementations and provides functionality common to both client and server HTTP connections.

从以下版本开始:

4.0

字段概要

字段

限定符和类型	字段和说明
protected HttpConnectionMetricsImpl	connMetrics
protected ContentDecoder	contentDecoder
protected ContentEncoder	contentEncoder
protected HttpContext	context
protected boolean	hasBufferedInput
protected boolean	hasBufferedOutput
protected SessionInputBufferImpl	inbuf
protected ContentLengthStrategy	incomingContentStrategy
protected HttpTransportMetricsImpl	inTransportMetrics
protected SessionOutputBufferImpl	outbuf
protected ContentLengthStrategy	outgoingContentStrategy
protected HttpTransportMetricsImpl	outTransportMetrics
protected java.net.SocketAddress	remote
protected HttpRequest	request
protected HttpResponse	response
protected IOSession	session
protected int	status

从接口继承的字段 depends.org.apache.http.nio.NHttpConnection

ACTIVE, CLOSED, CLOSING

构造器概要

构造器

限定符	构造器和说明
	NHttpConnectionBase(IOSession session, ByteBufferAllocator allocator, HttpParams params) 已过时。 (4.3) use NHttpConnectionBase(IOSession, int, int, ByteBufferAllocator, CharsetDecoder, CharsetEncoder, ContentLengthStrategy, ContentLengthStrategy)
protected	NHttpConnectionBase(IOSession session, int buffersize, int fragmentSizeHint, ByteBufferAllocator allocator, java.nio.charset.CharsetDecoder chardecoder, java.nio.charset.CharsetEncoder charencoder, ContentLengthStrategy incomingContentStrategy, ContentLengthStrategy outgoingContentStrategy) Creates new instance NHttpConnectionBase given the underlying I/O session.

方法概要

方法

限定符和类型	方法和说明
protected void	assertNotClosed() Assets if the connection is still open.
protected void	bind(IOSession session) Binds the connection to a different IOSession.
void	close() Closes this connection gracefully.
protected HttpConnectionMetricsImpl	createConnectionMetrics(HttpTransportMetrics inTransportMetric, HttpTransportMetrics outTransportMetric) 已过时。 (4.3) use decorator to add additional metrics.
protected ContentDecoder	createContentDecoder(long len, java.nio.channels.ReadableByteChannel channel, SessionInputBuffer buffer, HttpTransportMetricsImpl metrics) Factory method for ContentDecoder instances.
protected ContentEncoder	createContentEncoder(long len, java.nio.channels.WritableByteChannel channel, SessionOutputBuffer buffer, HttpTransportMetricsImpl metrics) Factory method for ContentEncoder instances.
protected ContentLengthStrategy	createIncomingContentStrategy() 已过时。 (4.3) use constructor.
protected ContentLengthStrategy	createOutgoingContentStrategy() 已过时。 (4.3) use constructor.
protected HttpTransportMetricsImpl	createTransportMetrics() 已过时。 (4.3) no longer used.
HttpContext	getContext() Returns an HTTP execution context associated with this connection.
HttpRequest	getHttpRequest() Returns the current HTTP request if one is being received / transmitted.
HttpResponse	getHttpResponse() Returns the current HTTP response if one is being received / transmitted.
java.net.InetAddress	getLocalAddress()
int	getLocalPort()
HttpConnectionMetrics	getMetrics() Returns a collection of connection metrics.
java.net.InetAddress	getRemoteAddress()
int	getRemotePort()
java.net.Socket	getSocket() Return the underlying socket
int	getSocketTimeout() Returns the socket timeout value.
int	getStatus() Returns status of the connection: NHttpConnection.ACTIVE: connection is active.
boolean	hasBufferedInput() Determines if the session input buffer contains data.
boolean	hasBufferedOutput() Determines if the session output buffer contains data.
boolean	isOpen() Checks if this connection is open.
boolean	isStale() Checks whether this connection has gone down.
protected HttpEntity	prepareDecoder(HttpMessage message) Initializes a specific ContentDecoder implementation based on the properties of the given HttpMessage and generates an instance of HttpEntity matching the properties of the content decoder.
protected void	prepareEncoder(HttpMessage message) Initializes a specific ContentEncoder implementation based on the properties of the given HttpMessage.
void	requestInput() Requests event notifications to be triggered when the underlying channel is ready for input operations.
void	requestOutput() Requests event notifications to be triggered when the underlying channel is ready for output operations.
void	setSocketTimeout(int timeout) Sets the socket timeout value.
void	shutdown() Force-closes this connection.
void	suspendInput() Suspends event notifications about the underlying channel being ready for input operations.
void	suspendOutput() Suspends event notifications about the underlying channel being ready for output operations.
java.lang.String	toString()

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

incomingContentStrategy

protected final ContentLengthStrategy incomingContentStrategy

outgoingContentStrategy

protected final ContentLengthStrategy outgoingContentStrategy

inbuf

protected final SessionInputBufferImpl inbuf

outbuf

protected final SessionOutputBufferImpl outbuf

inTransportMetrics

protected final HttpTransportMetricsImpl inTransportMetrics

outTransportMetrics

protected final HttpTransportMetricsImpl outTransportMetrics

connMetrics

protected final HttpConnectionMetricsImpl connMetrics

context

protected HttpContext context

session

protected IOSession session

remote

protected java.net.SocketAddress remote

contentDecoder

protected volatile ContentDecoder contentDecoder

hasBufferedInput

protected volatile boolean hasBufferedInput

contentEncoder

protected volatile ContentEncoder contentEncoder

hasBufferedOutput

protected volatile boolean hasBufferedOutput

request

protected volatile HttpRequest request

response

protected volatile HttpResponse response

status

protected volatile int status

构造器详细资料

NHttpConnectionBase

@Deprecated
public NHttpConnectionBase(IOSession session,
                              ByteBufferAllocator allocator,
                              HttpParams params)

已过时。 (4.3) use NHttpConnectionBase(IOSession, int, int, ByteBufferAllocator, CharsetDecoder, CharsetEncoder, ContentLengthStrategy, ContentLengthStrategy)

Creates a new instance of this class given the underlying I/O session.

参数:

session - the underlying I/O session.

allocator - byte buffer allocator.

params - HTTP parameters.

NHttpConnectionBase

protected NHttpConnectionBase(IOSession session,
                   int buffersize,
                   int fragmentSizeHint,
                   ByteBufferAllocator allocator,
                   java.nio.charset.CharsetDecoder chardecoder,
                   java.nio.charset.CharsetEncoder charencoder,
                   ContentLengthStrategy incomingContentStrategy,
                   ContentLengthStrategy outgoingContentStrategy)

Creates new instance NHttpConnectionBase given the underlying I/O session.

参数:

session - the underlying I/O session.

buffersize - buffer size. Must be a positive number.

fragmentSizeHint - fragment size hint.

allocator - memory allocator. If null HeapByteBufferAllocator.INSTANCE will be used.

chardecoder - decoder to be used for decoding HTTP protocol elements. If null simple category cast will be used for byte to char conversion.

charencoder - encoder to be used for encoding HTTP protocol elements. If null simple category cast will be used for char to byte conversion.

incomingContentStrategy - incoming content length strategy. If null LaxContentLengthStrategy.INSTANCE will be used.

outgoingContentStrategy - outgoing content length strategy. If null StrictContentLengthStrategy.INSTANCE will be used.

从以下版本开始:

4.3

方法详细资料

bind

protected void bind(IOSession session)

Binds the connection to a different IOSession. This may be necessary when the underlying I/O session gets upgraded with SSL/TLS encryption.

从以下版本开始:

4.2

createIncomingContentStrategy

@Deprecated
protected ContentLengthStrategy createIncomingContentStrategy()

已过时。 (4.3) use constructor.

从以下版本开始:

4.2

createOutgoingContentStrategy

@Deprecated
protected ContentLengthStrategy createOutgoingContentStrategy()

已过时。 (4.3) use constructor.

从以下版本开始:

4.2

createTransportMetrics

@Deprecated
protected HttpTransportMetricsImpl createTransportMetrics()

已过时。 (4.3) no longer used.

从以下版本开始:

4.1

createConnectionMetrics

@Deprecated
protected HttpConnectionMetricsImpl createConnectionMetrics(HttpTransportMetrics inTransportMetric,
                                                           HttpTransportMetrics outTransportMetric)

已过时。 (4.3) use decorator to add additional metrics.

从以下版本开始:

4.1

getStatus

public int getStatus()

从接口复制的说明: NHttpConnection

Returns status of the connection:

NHttpConnection.ACTIVE: connection is active.

NHttpConnection.CLOSING: connection is being closed.

NHttpConnection.CLOSED: connection has been closed.

指定者:

getStatus 在接口中 NHttpConnection

返回:

connection status.

getContext

public HttpContext getContext()

从接口复制的说明: NHttpConnection

Returns an HTTP execution context associated with this connection.

指定者:

getContext 在接口中 NHttpConnection

返回:

HTTP context

getHttpRequest

public HttpRequest getHttpRequest()

从接口复制的说明: NHttpConnection

Returns the current HTTP request if one is being received / transmitted. Otherwise returns null.

指定者:

getHttpRequest 在接口中 NHttpConnection

返回:

HTTP request, if available, null otherwise.

getHttpResponse

public HttpResponse getHttpResponse()

从接口复制的说明: NHttpConnection

Returns the current HTTP response if one is being received / transmitted. Otherwise returns null.

指定者:

getHttpResponse 在接口中 NHttpConnection

返回:

HTTP response, if available, null otherwise.

requestInput

public void requestInput()

从接口复制的说明: IOControl

Requests event notifications to be triggered when the underlying channel is ready for input operations.

指定者:

requestInput 在接口中 IOControl

requestOutput

public void requestOutput()

从接口复制的说明: IOControl

Requests event notifications to be triggered when the underlying channel is ready for output operations.

指定者:

requestOutput 在接口中 IOControl

suspendInput

public void suspendInput()

从接口复制的说明: IOControl

Suspends event notifications about the underlying channel being ready for input operations.

指定者:

suspendInput 在接口中 IOControl

suspendOutput

public void suspendOutput()

从接口复制的说明: IOControl

Suspends event notifications about the underlying channel being ready for output operations.

指定者:

suspendOutput 在接口中 IOControl

prepareDecoder

protected HttpEntity prepareDecoder(HttpMessage message)
                             throws HttpException

Initializes a specific ContentDecoder implementation based on the properties of the given HttpMessage and generates an instance of HttpEntity matching the properties of the content decoder.

参数:

message - the HTTP message.

返回:

HTTP entity.

抛出:

HttpException - in case of an HTTP protocol violation.

createContentDecoder

protected ContentDecoder createContentDecoder(long len,
                                  java.nio.channels.ReadableByteChannel channel,
                                  SessionInputBuffer buffer,
                                  HttpTransportMetricsImpl metrics)

Factory method for ContentDecoder instances.

参数:

len - content length, if known, ContentLengthStrategy.CHUNKED or ContentLengthStrategy.IDENTITY, if unknown.

channel - the session channel.

buffer - the session buffer.

metrics - transport metrics.

返回:

content decoder.

从以下版本开始:

4.1

prepareEncoder

protected void prepareEncoder(HttpMessage message)
                       throws HttpException

Initializes a specific ContentEncoder implementation based on the properties of the given HttpMessage.

参数:

message - the HTTP message.

抛出:

HttpException - in case of an HTTP protocol violation.

createContentEncoder

protected ContentEncoder createContentEncoder(long len,
                                  java.nio.channels.WritableByteChannel channel,
                                  SessionOutputBuffer buffer,
                                  HttpTransportMetricsImpl metrics)

Factory method for ContentEncoder instances.

参数:

len - content length, if known, ContentLengthStrategy.CHUNKED or ContentLengthStrategy.IDENTITY, if unknown.

channel - the session channel.

buffer - the session buffer.

metrics - transport metrics.

返回:

content encoder.

从以下版本开始:

4.1

hasBufferedInput

public boolean hasBufferedInput()

从接口复制的说明: SessionBufferStatus

Determines if the session input buffer contains data.

指定者:

hasBufferedInput 在接口中 SessionBufferStatus

返回:

true if the session input buffer contains data, false otherwise.

hasBufferedOutput

public boolean hasBufferedOutput()

从接口复制的说明: SessionBufferStatus

Determines if the session output buffer contains data.

指定者:

hasBufferedOutput 在接口中 SessionBufferStatus

返回:

true if the session output buffer contains data, false otherwise.

assertNotClosed

protected void assertNotClosed()
                        throws ConnectionClosedException

Assets if the connection is still open.

抛出:

ConnectionClosedException - in case the connection has already been closed.

close

public void close()
           throws java.io.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 在接口中 HttpConnection

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException

isOpen

public boolean isOpen()

从接口复制的说明: HttpConnection

Checks if this connection is open.

指定者:

isOpen 在接口中 HttpConnection

返回:

true if it is open, false if it is closed.

isStale

public boolean isStale()

从接口复制的说明: 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.

指定者:

isStale 在接口中 HttpConnection

返回:

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

getLocalAddress

public java.net.InetAddress getLocalAddress()

指定者:

getLocalAddress 在接口中 HttpInetConnection

getLocalPort

public int getLocalPort()

指定者:

getLocalPort 在接口中 HttpInetConnection

getRemoteAddress

public java.net.InetAddress getRemoteAddress()

指定者:

getRemoteAddress 在接口中 HttpInetConnection

getRemotePort

public int getRemotePort()

指定者:

getRemotePort 在接口中 HttpInetConnection

setSocketTimeout

public void setSocketTimeout(int timeout)

从接口复制的说明: HttpConnection

Sets the socket timeout value.

指定者:

setSocketTimeout 在接口中 HttpConnection

参数:

timeout - timeout value in milliseconds

getSocketTimeout

public int getSocketTimeout()

从接口复制的说明: HttpConnection

Returns the socket timeout value.

指定者:

getSocketTimeout 在接口中 HttpConnection

返回:

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

从接口复制的说明: 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.

指定者:

shutdown 在接口中 HttpConnection

指定者:

shutdown 在接口中 IOControl

抛出:

java.io.IOException

getMetrics

public HttpConnectionMetrics getMetrics()

从接口复制的说明: HttpConnection

Returns a collection of connection metrics.

指定者:

getMetrics 在接口中 HttpConnection

返回:

HttpConnectionMetrics

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

getSocket

public java.net.Socket getSocket()

从接口复制的说明: SocketAccessor

Return the underlying socket

指定者:

getSocket 在接口中 SocketAccessor

返回:

- the underlying Socket, may be null.