org.eclipse.jetty.server

Class HttpConnection

java.lang.Object

org.eclipse.jetty.io.AbstractConnection

org.eclipse.jetty.server.HttpConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, Connection, Connection.UpgradeFrom, Connection.UpgradeTo, WriteFlusher.Listener, HttpTransport

public class HttpConnection
extends AbstractConnection
implements Runnable, HttpTransport, WriteFlusher.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

A Connection that handles the HTTP protocol.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Connection

Connection.Listener, Connection.UpgradeFrom, Connection.UpgradeTo

Field Summary

Fields

Modifier and Type	Field and Description
static HttpField	CONNECTION_CLOSE
static String	UPGRADE_CONNECTION_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
HttpConnection(HttpConfiguration config, Connector connector, EndPoint endPoint, HttpCompliance compliance, boolean recordComplianceViolations)

Method Summary

Modifier and Type	Method and Description
void	abort(Throwable failure) Aborts this transport.
void	asyncReadFillInterested()
void	blockingReadFailure(Throwable e)
void	blockingReadFillInterested()
long	getBytesIn()
long	getBytesOut()
Connector	getConnector()
static HttpConnection	getCurrentConnection() Get the current connection that this thread is dispatched to.
HttpGenerator	getGenerator()
HttpChannel	getHttpChannel()
HttpConfiguration	getHttpConfiguration()
long	getMessagesIn()
long	getMessagesOut()
HttpParser	getParser()
ByteBuffer	getRequestBuffer()
Server	getServer()
boolean	isOptimizedForDirectBuffers() Is the underlying transport optimized for DirectBuffer usage
boolean	isPushSupported()
boolean	isRecordHttpComplianceViolations()
boolean	isRequestBufferEmpty()
void	onClose() Callback method invoked when this connection is closed.
void	onCompleted() Called to indicated the end of the current request/response cycle (which may be some time after the last content is sent).
void	onFillable() Callback method invoked when the endpoint is ready to be read.
void	onFlushed(long bytes) Invoked when a WriteFlusher flushed bytes in a non-blocking way, as part of a - possibly larger - write.
void	onOpen() Callback method invoked when this connection is opened.
ByteBuffer	onUpgradeFrom() Takes the input buffer from the connection on upgrade.
void	onUpgradeTo(ByteBuffer buffer) Callback method invoked when this connection is upgraded.
void	push(MetaData.Request request)
void	run()
void	send(MetaData.Response info, boolean head, ByteBuffer content, boolean lastContent, Callback callback) Asynchronous call to send a response (or part) over the transport
String	toConnectionString()

Methods inherited from class org.eclipse.jetty.io.AbstractConnection

addListener, close, fillInterested, getCreatedTimeStamp, getEndPoint, getInputBufferSize, isFillInterested, onIdleExpired, removeListener, setInputBufferSize, toString, tryFillInterested, tryFillInterested

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_CLOSE

public static final HttpField CONNECTION_CLOSE

UPGRADE_CONNECTION_ATTRIBUTE

public static final String UPGRADE_CONNECTION_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

HttpConnection

public HttpConnection(HttpConfiguration config,
                      Connector connector,
                      EndPoint endPoint,
                      HttpCompliance compliance,
                      boolean recordComplianceViolations)

Method Detail

getCurrentConnection

public static HttpConnection getCurrentConnection()

Get the current connection that this thread is dispatched to. Note that a thread may be processing a request asynchronously and thus not be dispatched to the connection.

Returns:

the current HttpConnection or null

See Also:

for a more general way to access the HttpConnection

getHttpConfiguration

public HttpConfiguration getHttpConfiguration()

isRecordHttpComplianceViolations

public boolean isRecordHttpComplianceViolations()

getServer

public Server getServer()

getConnector

public Connector getConnector()

getHttpChannel

public HttpChannel getHttpChannel()

getParser

public HttpParser getParser()

getGenerator

public HttpGenerator getGenerator()

isOptimizedForDirectBuffers

public boolean isOptimizedForDirectBuffers()

Description copied from interface: HttpTransport

Is the underlying transport optimized for DirectBuffer usage

Specified by:

isOptimizedForDirectBuffers in interface HttpTransport

Returns:

True if direct buffers can be used optimally.

getMessagesIn

public long getMessagesIn()

Specified by:

getMessagesIn in interface Connection

Overrides:

getMessagesIn in class AbstractConnection

getMessagesOut

public long getMessagesOut()

Specified by:

getMessagesOut in interface Connection

Overrides:

getMessagesOut in class AbstractConnection

onUpgradeFrom

public ByteBuffer onUpgradeFrom()

Description copied from interface: Connection.UpgradeFrom

Takes the input buffer from the connection on upgrade.

This method is used to take any unconsumed input from a connection during an upgrade.

Specified by:

onUpgradeFrom in interface Connection.UpgradeFrom

Returns:

A buffer of unconsumed input. The caller must return the buffer to the bufferpool when consumed and this connection must not.

onUpgradeTo

public void onUpgradeTo(ByteBuffer buffer)

Description copied from interface: Connection.UpgradeTo

Callback method invoked when this connection is upgraded.

This must be called before Connection.onOpen().

Specified by:

onUpgradeTo in interface Connection.UpgradeTo

Parameters:

buffer - An optional buffer that can contain prefilled data. Typically this results from an upgrade of one protocol to the other where the old connection has buffered data destined for the new connection. The new connection must take ownership of the buffer and is responsible for returning it to the buffer pool

onFlushed

public void onFlushed(long bytes)
               throws IOException

Description copied from interface: WriteFlusher.Listener

Invoked when a WriteFlusher flushed bytes in a non-blocking way, as part of a - possibly larger - write.

This method may be invoked multiple times, for example when writing a large buffer: a first flush of bytes, then the connection became TCP congested, and a subsequent flush of bytes when the connection became writable again.

This method is never invoked concurrently, but may be invoked by different threads, so implementations may not rely on thread-local variables.

Implementations may throw an IOException to signal that the write should fail, for example if the implementation enforces a minimum data rate.

Specified by:

onFlushed in interface WriteFlusher.Listener

Parameters:

bytes - the number of bytes flushed

Throws:

IOException - if the write should fail

getRequestBuffer

public ByteBuffer getRequestBuffer()

isRequestBufferEmpty

public boolean isRequestBufferEmpty()

onFillable

public void onFillable()

Description copied from class: AbstractConnection

Callback method invoked when the endpoint is ready to be read.

Specified by:

onFillable in class AbstractConnection

See Also:

AbstractConnection.fillInterested()

onCompleted

public void onCompleted()

Description copied from interface: HttpTransport

Called to indicated the end of the current request/response cycle (which may be some time after the last content is sent).

Specified by:

onCompleted in interface HttpTransport

onOpen

public void onOpen()

Description copied from interface: Connection

Callback method invoked when this connection is opened.

Creators of the connection implementation are responsible for calling this method.

Specified by:

onOpen in interface Connection

Overrides:

onOpen in class AbstractConnection

onClose

public void onClose()

Description copied from interface: Connection

Callback method invoked when this connection is closed.

Creators of the connection implementation are responsible for calling this method.

Specified by:

onClose in interface Connection

Overrides:

onClose in class AbstractConnection

run

public void run()

Specified by:

run in interface Runnable

send

public void send(MetaData.Response info,
                 boolean head,
                 ByteBuffer content,
                 boolean lastContent,
                 Callback callback)

Description copied from interface: HttpTransport

Asynchronous call to send a response (or part) over the transport

Specified by:

send in interface HttpTransport

Parameters:

info - The header info to send, or null if just sending more data. The first call to send for a response must have a non null info.

head - True if the response if for a HEAD request (and the data should not be sent).

content - A buffer of content to be sent.

lastContent - True if the content is the last content for the current response.

callback - The Callback instance that success or failure of the send is notified on

abort

public void abort(Throwable failure)

Description copied from interface: HttpTransport

Aborts this transport.

This method should terminate the transport in a way that can indicate an abnormal response to the client, for example by abruptly close the connection.

This method is called when an error response needs to be sent, but the response is already committed, or when a write failure is detected. If abort is called, HttpTransport.onCompleted() is not called

Specified by:

abort in interface HttpTransport

Parameters:

failure - the failure that caused the abort.

isPushSupported

public boolean isPushSupported()

Specified by:

isPushSupported in interface HttpTransport

Returns:

true if responses can be pushed over this transport

push

public void push(MetaData.Request request)

Specified by:

push in interface HttpTransport

Parameters:

request - A request to use as the basis for generating a pushed response.

asyncReadFillInterested

public void asyncReadFillInterested()

blockingReadFillInterested

public void blockingReadFillInterested()

blockingReadFailure

public void blockingReadFailure(Throwable e)

getBytesIn

public long getBytesIn()

Specified by:

getBytesIn in interface Connection

Overrides:

getBytesIn in class AbstractConnection

getBytesOut

public long getBytesOut()

Specified by:

getBytesOut in interface Connection

Overrides:

getBytesOut in class AbstractConnection

toConnectionString

public String toConnectionString()

Overrides:

toConnectionString in class AbstractConnection