Package org.eclipse.jetty.http2.server

Class HttpChannelOverHTTP2

java.lang.Object

org.eclipse.jetty.server.HttpChannel

org.eclipse.jetty.http2.server.HttpChannelOverHTTP2

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, HTTP2Channel.Server, WriteFlusher.Listener, HttpOutput.Interceptor

Direct Known Subclasses:

HTTP2ServerConnection.ServerHttpChannelOverHTTP2

public class HttpChannelOverHTTP2
extends HttpChannel
implements Closeable, WriteFlusher.Listener, HTTP2Channel.Server

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.server.HttpChannel

HttpChannel.Listener, HttpChannel.TransientListeners

Field Summary

Fields inherited from class org.eclipse.jetty.server.HttpChannel

NOOP_LISTENER

Constructor Summary

Constructors

Constructor	Description
HttpChannelOverHTTP2(Connector connector, HttpConfiguration configuration, EndPoint endPoint, HttpTransportOverHTTP2 transport)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	commit(MetaData.Response info)
protected void	consumeInput()
void	continue100(int available)	If the associated response has the Expect header set to 100 Continue, then accessing the input stream indicates that the handler/servlet is ready for the request body and thus a 100 Continue response is sent.
protected boolean	eof()	Mark the channel's input as EOF.
boolean	failAllContent(Throwable failure)	Fail all content that is currently stored within the channel.
boolean	failed(Throwable x)	Fail the channel's input.
HttpTransportOverHTTP2	getHttpTransport()
long	getIdleTimeout()	Get the idle timeout.
protected IStream	getStream()
EndPoint	getTunnellingEndPoint()
boolean	isExpecting100Continue()
boolean	isIdle()
boolean	isTunnellingSupported()
boolean	isUseOutputDirectByteBuffers()
boolean	needContent()	Notify the channel that content is needed.
Runnable	onData(DataFrame frame, Callback callback)
Runnable	onFailure(Throwable failure, Callback callback)
void	onFlushed(long bytes)	Invoked when a WriteFlusher flushed bytes in a non-blocking way, as part of a - possibly larger - write.
Runnable	onPushRequest(MetaData.Request request)
Runnable	onRequest(HeadersFrame frame)
boolean	onTimeout(Throwable failure, Consumer<Runnable> consumer)
Runnable	onTrailer(HeadersFrame frame)
HttpInput.Content	produceContent()	Produce a HttpInput.Content object with data currently stored within the channel.
void	recycle()
void	setIdleTimeout(long timeoutMs)	Set the idle timeout.
void	setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)
String	toString()

Methods inherited from class org.eclipse.jetty.server.HttpChannel

abort, addListener, addRequestLog, checkAndPrepareUpgrade, ensureConsumeAllOrNotPersistent, execute, formatAddrOrHost, getByteBufferPool, getBytesWritten, getCommittedMetaData, getConnection, getConnector, getEndPoint, getHttpConfiguration, getLocalAddress, getLocalName, getLocalPort, getNextInterceptor, getRemoteAddress, getRequest, getRequestLog, getRequests, getResponse, getScheduler, getServer, getServerAuthority, getState, getTransientListeners, handle, handleException, isCommitted, isExpecting102Processing, isPersistent, isRequestCompleted, isResponseCompleted, isSendError, isUseInputDirectByteBuffers, newHttpOutput, onBadMessage, onCompleted, onContent, onContentComplete, onRequest, onRequestComplete, onTrailers, removeListener, resetBuffer, run, sendErrorOrAbort, sendResponse, sendResponse, sendResponseAndComplete, setRequestLog, unwrap, write

Methods inherited from class java.lang.Object

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

Constructor Details

HttpChannelOverHTTP2

public HttpChannelOverHTTP2(Connector connector,
 HttpConfiguration configuration,
 EndPoint endPoint,
 HttpTransportOverHTTP2 transport)

Method Details

getStream

protected IStream getStream()

isUseOutputDirectByteBuffers

public boolean isUseOutputDirectByteBuffers()

Overrides:

isUseOutputDirectByteBuffers in class HttpChannel

setUseOutputDirectByteBuffers

public void setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)

isExpecting100Continue

public boolean isExpecting100Continue()

Overrides:

isExpecting100Continue in class HttpChannel

setIdleTimeout

public void setIdleTimeout(long timeoutMs)

Description copied from class: HttpChannel

Set the idle timeout.

This is implemented as a call to EndPoint.setIdleTimeout(long), but may be overridden by channels that have timeouts different from their connections.

Overrides:

setIdleTimeout in class HttpChannel

Parameters:

timeoutMs - the idle timeout in milliseconds

getIdleTimeout

public long getIdleTimeout()

Description copied from class: HttpChannel

Get the idle timeout.

This is implemented as a call to EndPoint.getIdleTimeout(), but may be overridden by channels that have timeouts different from their connections.

Overrides:

getIdleTimeout in class HttpChannel

Returns:

the idle timeout (in milliseconds)

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

onRequest

public Runnable onRequest(HeadersFrame frame)

onPushRequest

public Runnable onPushRequest(MetaData.Request request)

getHttpTransport

public HttpTransportOverHTTP2 getHttpTransport()

Overrides:

getHttpTransport in class HttpChannel

recycle

public void recycle()

Overrides:

recycle in class HttpChannel

commit

protected void commit(MetaData.Response info)

Overrides:

commit in class HttpChannel

onData

public Runnable onData(DataFrame frame,
 Callback callback)

Specified by:

onData in interface HTTP2Channel.Server

needContent

public boolean needContent()

Description copied from class: HttpChannel

Notify the channel that content is needed. If some content is immediately available, true is returned and HttpChannel.produceContent() has to be called and will return a non-null object. If no content is immediately available, an attempt to produce content must be made; if new content has been produced, true is returned; otherwise HttpInput.onContentProducible() is called once some content arrives and HttpChannel.produceContent() can be called without returning null. If a failure happens, then HttpInput.onContentProducible() will be called and an error content will return the error on the next call to HttpChannel.produceContent().

Specified by:

needContent in class HttpChannel

Returns:

true if content is immediately available.

produceContent

public HttpInput.Content produceContent()

Description copied from class: HttpChannel

Produce a HttpInput.Content object with data currently stored within the channel. The produced content can be special (meaning calling HttpInput.Content.isSpecial() returns true) if the channel reached a special state, like EOF or an error. Once a special content has been returned, all subsequent calls to this method will always return a special content of the same kind and HttpChannel.needContent() will always return true. The returned content is "raw", i.e.: not decoded.

Specified by:

produceContent in class HttpChannel

Returns:

a HttpInput.Content object if one is immediately available without blocking, null otherwise.

failAllContent

public boolean failAllContent(Throwable failure)

Description copied from class: HttpChannel

Fail all content that is currently stored within the channel.

Specified by:

failAllContent in class HttpChannel

Parameters:

failure - the failure to fail the content with.

Returns:

true if EOF was reached while failing all content, false otherwise.

failed

public boolean failed(Throwable x)

Description copied from class: HttpChannel

Fail the channel's input.

Specified by:

failed in class HttpChannel

Parameters:

x - the failure.

Returns:

true if the channel needs to be rescheduled.

eof

protected boolean eof()

Description copied from class: HttpChannel

Mark the channel's input as EOF.

Specified by:

eof in class HttpChannel

Returns:

true if the channel needs to be rescheduled.

onTrailer

public Runnable onTrailer(HeadersFrame frame)

Specified by:

onTrailer in interface HTTP2Channel.Server

isIdle

public boolean isIdle()

Specified by:

isIdle in interface HTTP2Channel.Server

onTimeout

public boolean onTimeout(Throwable failure,
 Consumer<Runnable> consumer)

Specified by:

onTimeout in interface HTTP2Channel.Server

onFailure

public Runnable onFailure(Throwable failure,
 Callback callback)

Specified by:

onFailure in interface HTTP2Channel.Server

consumeInput

protected void consumeInput()

continue100

public void continue100(int available)
                 throws IOException

If the associated response has the Expect header set to 100 Continue, then accessing the input stream indicates that the handler/servlet is ready for the request body and thus a 100 Continue response is sent.

Overrides:

continue100 in class HttpChannel

Parameters:

available - estimate of the number of bytes that are available

Throws:

IOException - if the InputStream cannot be created

isTunnellingSupported

public boolean isTunnellingSupported()

Overrides:

isTunnellingSupported in class HttpChannel

getTunnellingEndPoint

public EndPoint getTunnellingEndPoint()

Overrides:

getTunnellingEndPoint in class HttpChannel

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

toString

public String toString()

Overrides:

toString in class HttpChannel