Package org.apache.http.impl.nio

Class NHttpConnectionBase

java.lang.Object

org.apache.http.impl.nio.NHttpConnectionBase

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultNHttpClientConnection, DefaultNHttpServerConnection

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.

Since:

4.0

Field Summary

Fields inherited from interface org.apache.http.nio.NHttpConnection

ACTIVE, CLOSED, CLOSING

Constructor Summary

Constructors

Constructor	Description
NHttpConnectionBase(IOSession session, ByteBufferAllocator allocator, HttpParams params)	Deprecated. (4.3) use NHttpConnectionBase(IOSession, int, int, ByteBufferAllocator, CharsetDecoder, CharsetEncoder, ContentLengthStrategy, ContentLengthStrategy)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this connection gracefully.
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:
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.
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()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NHttpConnectionBase

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

Deprecated.

(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.

Parameters:

session - the underlying I/O session.

allocator - byte buffer allocator.

params - HTTP parameters.

Method Detail

getStatus

public int getStatus()

Description copied from interface: NHttpConnection

Returns status of the connection:

NHttpConnection.ACTIVE: connection is active.

NHttpConnection.CLOSING: connection is being closed.

NHttpConnection.CLOSED: connection has been closed.

Specified by:

getStatus in interface NHttpConnection

Returns:

connection status.

getContext

public HttpContext getContext()

Description copied from interface: NHttpConnection

Returns an HTTP execution context associated with this connection.

Specified by:

getContext in interface NHttpConnection

Returns:

HTTP context

getHttpRequest

public HttpRequest getHttpRequest()

Description copied from interface: NHttpConnection

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

Specified by:

getHttpRequest in interface NHttpConnection

Returns:

HTTP request, if available, null otherwise.

getHttpResponse

public HttpResponse getHttpResponse()

Description copied from interface: NHttpConnection

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

Specified by:

getHttpResponse in interface NHttpConnection

Returns:

HTTP response, if available, null otherwise.

requestInput

public void requestInput()

Description copied from interface: IOControl

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

Specified by:

requestInput in interface IOControl

requestOutput

public void requestOutput()

Description copied from interface: IOControl

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

Specified by:

requestOutput in interface IOControl

suspendInput

public void suspendInput()

Description copied from interface: IOControl

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

Specified by:

suspendInput in interface IOControl

suspendOutput

public void suspendOutput()

Description copied from interface: IOControl

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

Specified by:

suspendOutput in interface IOControl

hasBufferedInput

public boolean hasBufferedInput()

Description copied from interface: SessionBufferStatus

Determines if the session input buffer contains data.

Specified by:

hasBufferedInput in interface SessionBufferStatus

Returns:

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

hasBufferedOutput

public boolean hasBufferedOutput()

Description copied from interface: SessionBufferStatus

Determines if the session output buffer contains data.

Specified by:

hasBufferedOutput in interface SessionBufferStatus

Returns:

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

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

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.

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

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

Specified by:

shutdown in interface IOControl

Throws:

java.io.IOException - in an error occurs

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

getSocket

public java.net.Socket getSocket()

Description copied from interface: SocketAccessor

Return the underlying socket

Specified by:

getSocket in interface SocketAccessor

Returns:

- the underlying Socket, may be null.