|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.impl.nio.NHttpConnectionBase
public class NHttpConnectionBase
This class serves as a base for all NHttpConnection
implementations
and implements functionality common to both client and server
HTTP connections.
The following parameters can be used to customize the behavior of this class:
Field Summary | |
---|---|
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 HttpRequest |
request
|
protected HttpResponse |
response
|
protected IOSession |
session
|
protected int |
status
|
Fields inherited from interface org.apache.http.nio.NHttpConnection |
---|
ACTIVE, CLOSED, CLOSING |
Constructor Summary | |
---|---|
NHttpConnectionBase(IOSession session,
ByteBufferAllocator allocator,
HttpParams params)
Creates a new instance of this class given the underlying I/O session. |
Method Summary | |
---|---|
protected void |
assertNotClosed()
Assets if the connection is still open. |
void |
close()
Closes this connection gracefully. |
protected HttpConnectionMetricsImpl |
createConnectionMetrics(HttpTransportMetrics inTransportMetric,
HttpTransportMetrics outTransportMetric)
|
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 HttpTransportMetricsImpl |
createTransportMetrics()
|
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()
|
int |
getSocketTimeout()
Returns the socket timeout value. |
int |
getStatus()
Returns status of the connection: |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final HttpContext context
protected final ContentLengthStrategy incomingContentStrategy
protected final ContentLengthStrategy outgoingContentStrategy
protected final SessionInputBufferImpl inbuf
protected final SessionOutputBufferImpl outbuf
protected final HttpTransportMetricsImpl inTransportMetrics
protected final HttpTransportMetricsImpl outTransportMetrics
protected final HttpConnectionMetricsImpl connMetrics
protected IOSession session
protected volatile ContentDecoder contentDecoder
protected volatile boolean hasBufferedInput
protected volatile ContentEncoder contentEncoder
protected volatile boolean hasBufferedOutput
protected volatile HttpRequest request
protected volatile HttpResponse response
protected volatile int status
Constructor Detail |
---|
public NHttpConnectionBase(IOSession session, ByteBufferAllocator allocator, HttpParams params)
session
- the underlying I/O session.allocator
- byte buffer allocator.params
- HTTP parameters.Method Detail |
---|
protected HttpTransportMetricsImpl createTransportMetrics()
protected HttpConnectionMetricsImpl createConnectionMetrics(HttpTransportMetrics inTransportMetric, HttpTransportMetrics outTransportMetric)
public int getStatus()
NHttpConnection
NHttpConnection.ACTIVE
: connection is active.
NHttpConnection.CLOSING
: connection is being closed.
NHttpConnection.CLOSED
: connection has been closed.
getStatus
in interface NHttpConnection
public HttpContext getContext()
NHttpConnection
getContext
in interface NHttpConnection
public HttpRequest getHttpRequest()
NHttpConnection
null
.
getHttpRequest
in interface NHttpConnection
null
otherwise.public HttpResponse getHttpResponse()
NHttpConnection
getHttpResponse
in interface NHttpConnection
null
otherwise.public void requestInput()
IOControl
requestInput
in interface IOControl
public void requestOutput()
IOControl
requestOutput
in interface IOControl
public void suspendInput()
IOControl
suspendInput
in interface IOControl
public void suspendOutput()
IOControl
suspendOutput
in interface IOControl
protected HttpEntity prepareDecoder(HttpMessage message) throws HttpException
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.
HttpException
- in case of an HTTP protocol violation.protected ContentDecoder createContentDecoder(long len, java.nio.channels.ReadableByteChannel channel, SessionInputBuffer buffer, HttpTransportMetricsImpl metrics)
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.
protected void prepareEncoder(HttpMessage message) throws HttpException
ContentEncoder
implementation based on the
properties of the given HttpMessage
.
message
- the HTTP message.
HttpException
- in case of an HTTP protocol violation.protected ContentEncoder createContentEncoder(long len, java.nio.channels.WritableByteChannel channel, SessionOutputBuffer buffer, HttpTransportMetricsImpl metrics)
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.
public boolean hasBufferedInput()
SessionBufferStatus
hasBufferedInput
in interface SessionBufferStatus
true
if the session input buffer contains data,
false
otherwise.public boolean hasBufferedOutput()
SessionBufferStatus
hasBufferedOutput
in interface SessionBufferStatus
true
if the session output buffer contains data,
false
otherwise.protected void assertNotClosed() throws ConnectionClosedException
ConnectionClosedException
- in case the connection has already
been closed.public void close() throws java.io.IOException
HttpConnection
shutdown
instead.
close
in interface HttpConnection
java.io.IOException
public boolean isOpen()
HttpConnection
isOpen
in interface HttpConnection
public boolean isStale()
HttpConnection
isStale
in interface 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 closedpublic java.net.InetAddress getLocalAddress()
getLocalAddress
in interface HttpInetConnection
public int getLocalPort()
getLocalPort
in interface HttpInetConnection
public java.net.InetAddress getRemoteAddress()
getRemoteAddress
in interface HttpInetConnection
public int getRemotePort()
getRemotePort
in interface HttpInetConnection
public void setSocketTimeout(int timeout)
HttpConnection
setSocketTimeout
in interface HttpConnection
timeout
- timeout value in millisecondspublic int getSocketTimeout()
HttpConnection
getSocketTimeout
in interface HttpConnection
0
if timeout is disabled or -1
if
timeout is undefined.public void shutdown() throws java.io.IOException
HttpConnection
shutdown
in interface HttpConnection
shutdown
in interface IOControl
java.io.IOException
public HttpConnectionMetrics getMetrics()
HttpConnection
getMetrics
in interface HttpConnection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |