java.lang.Object
- org.eclipse.jetty.server.HttpChannel

All Implemented Interfaces:

java.lang.Runnable, HttpOutput.Interceptor

Direct Known Subclasses:

HttpChannelOverFCGI, HttpChannelOverHttp
```
public class HttpChannel
extends java.lang.Object
implements java.lang.Runnable, HttpOutput.Interceptor
```
HttpChannel represents a single endpoint for HTTP semantic processing. The HttpChannel is both an HttpParser.RequestHandler, where it passively receives events from an incoming HTTP request, and a Runnable, where it actively takes control of the request/response life cycle and calls the application (perhaps suspending and resuming with multiple calls to run). The HttpChannel signals the switch from passive mode to active mode by returning true to one of the HttpParser.RequestHandler callbacks. The completion of the active phase is signalled by a call to HttpTransport.completed().

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`(package private) static interface`	`HttpChannel.Dispatchable`
`static interface`	`HttpChannel.Listener`	Listener for `HttpChannel` events.
`private class`	`HttpChannel.Send100Callback`
`private class`	`HttpChannel.SendCallback`
`static class`	`HttpChannel.TransientListeners`	Deprecated.

Field Summary

Fields
Modifier and Type	Field	Description
`private HttpChannel.Listener`	`_combinedListener`
`private MetaData.Response`	`_committedMetaData`
`private HttpConfiguration`	`_configuration`
`private Connector`	`_connector`
`private EndPoint`	`_endPoint`
`private java.util.concurrent.Executor`	`_executor`
`private long`	`_oldIdleTimeout`
`private Request`	`_request`
`private RequestLog`	`_requestLog`
`private java.util.concurrent.atomic.AtomicLong`	`_requests`
`private Response`	`_response`
`private HttpChannelState`	`_state`
`private HttpFields`	`_trailers`
`private java.util.function.Supplier<HttpFields>`	`_trailerSupplier`
`private java.util.List<HttpChannel.Listener>`	`_transientListeners`	Deprecated.
`private HttpTransport`	`_transport`
`private long`	`_written`	Bytes written after interception (eg after compression)
`private static Logger`	`LOG`
`static HttpChannel.Listener`	`NOOP_LISTENER`

Constructor Summary

Constructors
Constructor Description

HttpChannel(Connector connector, HttpConfiguration configuration, EndPoint endPoint, HttpTransport transport)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`abort(java.lang.Throwable failure)`	If a write or similar operation to this channel fails, then this method should be called.
`boolean`	`addListener(HttpChannel.Listener listener)`	Deprecated.
`void`	`addRequestLog(RequestLog requestLog)`
`protected void`	`commit(MetaData.Response info)`
`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.
`private void`	`dispatch(javax.servlet.DispatcherType type, HttpChannel.Dispatchable dispatchable)`
`void`	`ensureConsumeAllOrNotPersistent()`
`protected void`	`execute(java.lang.Runnable task)`
`protected java.lang.String`	`formatAddrOrHost(java.lang.String addr)`	Format the address or host returned from Request methods
`ByteBufferPool`	`getByteBufferPool()`
`long`	`getBytesWritten()`
`MetaData.Response`	`getCommittedMetaData()`
`Connection`	`getConnection()`
`Connector`	`getConnector()`
`EndPoint`	`getEndPoint()`
`HttpConfiguration`	`getHttpConfiguration()`
`HttpTransport`	`getHttpTransport()`
`long`	`getIdleTimeout()`	Get the idle timeout.
`java.net.InetSocketAddress`	`getLocalAddress()`
`java.lang.String`	`getLocalName()`	Return the local name of the connected channel.
`int`	`getLocalPort()`	Return the Local Port of the connected channel.
`HttpOutput.Interceptor`	`getNextInterceptor()`
`java.net.InetSocketAddress`	`getRemoteAddress()`
`Request`	`getRequest()`
`RequestLog`	`getRequestLog()`
`long`	`getRequests()`
`Response`	`getResponse()`
`Scheduler`	`getScheduler()`
`Server`	`getServer()`
`HostPort`	`getServerAuthority()`
`HttpChannelState`	`getState()`
`java.util.List<HttpChannel.Listener>`	`getTransientListeners()`	Deprecated.
`boolean`	`handle()`
`protected void`	`handleException(java.lang.Throwable failure)`	Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application.
`boolean`	`isCommitted()`
`boolean`	`isExpecting100Continue()`
`boolean`	`isExpecting102Processing()`
`boolean`	`isOptimizedForDirectBuffers()`
`boolean`	`isPersistent()`
`boolean`	`isRequestCompleted()`
`boolean`	`isResponseCompleted()`
`boolean`	`isSendError()`
`protected HttpInput`	`newHttpInput(HttpChannelState state)`
`protected HttpOutput`	`newHttpOutput()`
`private void`	`notifyEvent1(java.util.function.Function<HttpChannel.Listener,java.util.function.Consumer<Request>> function, Request request)`
`private void`	`notifyEvent2(java.util.function.Function<HttpChannel.Listener,java.util.function.BiConsumer<Request,java.lang.Throwable>> function, Request request, java.lang.Throwable failure)`
`private void`	`notifyEvent2(java.util.function.Function<HttpChannel.Listener,java.util.function.BiConsumer<Request,java.nio.ByteBuffer>> function, Request request, java.nio.ByteBuffer content)`
`void`	`onAsyncWaitForContent()`
`void`	`onBadMessage(BadMessageException failure)`
`void`	`onBlockWaitForContent()`
`void`	`onBlockWaitForContentFailure(java.lang.Throwable failure)`
`void`	`onCompleted()`
`boolean`	`onContent(HttpInput.Content content)`
`boolean`	`onContentComplete()`
`boolean`	`onEarlyEOF()`
`void`	`onRequest(MetaData.Request request)`
`boolean`	`onRequestComplete()`
`void`	`onTrailers(HttpFields trailers)`
`void`	`recycle()`
`boolean`	`removeListener(HttpChannel.Listener listener)`	Deprecated.
`void`	`resetBuffer()`	Reset the buffers.
`void`	`run()`
`boolean`	`sendResponse(MetaData.Response info, java.nio.ByteBuffer content, boolean complete)`
`boolean`	`sendResponse(MetaData.Response info, java.nio.ByteBuffer content, boolean complete, Callback callback)`
`void`	`sendResponseAndComplete()`
`void`	`setIdleTimeout(long timeoutMs)`	Set the idle timeout.
`void`	`setRequestLog(RequestLog requestLog)`
`java.lang.String`	`toString()`
`protected java.lang.Throwable`	`unwrap(java.lang.Throwable failure, java.lang.Class<?>... targets)`	Unwrap failure causes to find target class
`boolean`	`useDirectBuffers()`
`void`	`write(java.nio.ByteBuffer content, boolean complete, Callback callback)`	Non-Blocking write, committing the response if needed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NOOP_LISTENER
```
public static HttpChannel.Listener NOOP_LISTENER
```
  - LOG
```
private static final Logger LOG
```
  - _requests
```
private final java.util.concurrent.atomic.AtomicLong _requests
```
  - _connector
```
private final Connector _connector
```
  - _executor
```
private final java.util.concurrent.Executor _executor
```
  - _configuration
```
private final HttpConfiguration _configuration
```
  - _endPoint
```
private final EndPoint _endPoint
```
  - _transport
```
private final HttpTransport _transport
```
  - _state
```
private final HttpChannelState _state
```
  - _request
```
private final Request _request
```
  - _response
```
private final Response _response
```
  - _combinedListener
```
private final HttpChannel.Listener _combinedListener
```
  - _transientListeners
```
@Deprecated
private final java.util.List<HttpChannel.Listener> _transientListeners
```
    Deprecated.
  - _trailers
```
private HttpFields _trailers
```
  - _trailerSupplier
```
private final java.util.function.Supplier<HttpFields> _trailerSupplier
```
  - _committedMetaData
```
private MetaData.Response _committedMetaData
```
  - _requestLog
```
private RequestLog _requestLog
```
  - _oldIdleTimeout
```
private long _oldIdleTimeout
```
  - _written
```
private long _written
```
    Bytes written after interception (eg after compression)
- Constructor Detail
  - HttpChannel
```
public HttpChannel(Connector connector,
                   HttpConfiguration configuration,
                   EndPoint endPoint,
                   HttpTransport transport)
```
- Method Detail
  - isSendError
```
public boolean isSendError()
```
  - formatAddrOrHost
```
protected java.lang.String formatAddrOrHost(java.lang.String addr)
```
    Format the address or host returned from Request methods
    
    Parameters:
    
    addr - The address or host
    
    Returns:
    
    Default implementation returns HostPort.normalizeHost(String)
  - newHttpInput
```
protected HttpInput newHttpInput(HttpChannelState state)
```
  - newHttpOutput
```
protected HttpOutput newHttpOutput()
```
  - getState
```
public HttpChannelState getState()
```
  - addListener
```
@Deprecated
public boolean addListener(HttpChannel.Listener listener)
```
    Deprecated.
    
    Add a transient Listener to the HttpChannel.
    Listeners added by this method will only be notified if the HttpChannel has been constructed with an instance of HttpChannel.TransientListeners as an AbstractConnector provided listener
    
    Transient listeners are removed after every request cycle
    
    Parameters:
    
    listener - the listener to add
    
    Returns:
    
    true if the listener was added.
  - removeListener
```
@Deprecated
public boolean removeListener(HttpChannel.Listener listener)
```
    Deprecated.
  - getTransientListeners
```
@Deprecated
public java.util.List<HttpChannel.Listener> getTransientListeners()
```
    Deprecated.
  - getBytesWritten
```
public long getBytesWritten()
```
  - getRequests
```
public long getRequests()
```
    Returns:
    
    the number of requests handled by this connection
  - getConnector
```
public Connector getConnector()
```
  - getHttpTransport
```
public HttpTransport getHttpTransport()
```
  - getRequestLog
```
public RequestLog getRequestLog()
```
  - setRequestLog
```
public void setRequestLog(RequestLog requestLog)
```
  - addRequestLog
```
public void addRequestLog(RequestLog requestLog)
```
  - getCommittedMetaData
```
public MetaData.Response getCommittedMetaData()
```
  - getIdleTimeout
```
public long getIdleTimeout()
```
    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.
    
    Returns:
    
    the idle timeout (in milliseconds)
  - setIdleTimeout
```
public void setIdleTimeout(long timeoutMs)
```
    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.
    
    Parameters:
    
    timeoutMs - the idle timeout in milliseconds
  - getByteBufferPool
```
public ByteBufferPool getByteBufferPool()
```
  - getHttpConfiguration
```
public HttpConfiguration getHttpConfiguration()
```
  - isOptimizedForDirectBuffers
```
public boolean isOptimizedForDirectBuffers()
```
    Specified by:
    
    isOptimizedForDirectBuffers in interface HttpOutput.Interceptor
    
    Returns:
    
    True if the Interceptor is optimized to receive direct ByteBuffers in the HttpOutput.Interceptor.write(ByteBuffer, boolean, Callback) method. If false is returned, then passing direct buffers may cause inefficiencies.
  - getServer
```
public Server getServer()
```
  - getRequest
```
public Request getRequest()
```
  - getResponse
```
public Response getResponse()
```
  - getConnection
```
public Connection getConnection()
```
  - getEndPoint
```
public EndPoint getEndPoint()
```
  - getLocalName
```
public java.lang.String getLocalName()
```
    Return the local name of the connected channel.
    
    This is the host name after the connector is bound and the connection is accepted.
    
    Value can be overridden by HttpConfiguration.setLocalAddress(SocketAddress).
    
    Note: some connectors are not based on IP networking, and default behavior here will result in a null return. Use HttpConfiguration.setLocalAddress(SocketAddress) to set the value to an acceptable host name.
    
    Returns:
    
    the local name, or null
  - getLocalPort
```
public int getLocalPort()
```
    Return the Local Port of the connected channel.
    
    This is the port the connector is bound to and is accepting connections on.
    
    Value can be overridden by HttpConfiguration.setLocalAddress(SocketAddress).
    
    Note: some connectors are not based on IP networking, and default behavior here will result in a value of 0 returned. Use HttpConfiguration.setLocalAddress(SocketAddress) to set the value to an acceptable port.
    
    Returns:
    
    the local port, or 0 if unspecified
  - getLocalAddress
```
public java.net.InetSocketAddress getLocalAddress()
```
  - getRemoteAddress
```
public java.net.InetSocketAddress getRemoteAddress()
```
  - getServerAuthority
```
public HostPort getServerAuthority()
```
    Returns:
    
    return the HttpConfiguration server authority override
  - continue100
```
public void continue100(int available)
                 throws java.io.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.
    
    Parameters:
    
    available - estimate of the number of bytes that are available
    
    Throws:
    
    java.io.IOException - if the InputStream cannot be created
  - recycle
```
public void recycle()
```
  - onAsyncWaitForContent
```
public void onAsyncWaitForContent()
```
  - onBlockWaitForContent
```
public void onBlockWaitForContent()
```
  - onBlockWaitForContentFailure
```
public void onBlockWaitForContentFailure(java.lang.Throwable failure)
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - handle
```
public boolean handle()
```
    Returns:
    
    True if the channel is ready to continue handling (ie it is not suspended)
  - ensureConsumeAllOrNotPersistent
```
public void ensureConsumeAllOrNotPersistent()
```
  - dispatch
```
private void dispatch(javax.servlet.DispatcherType type,
                      HttpChannel.Dispatchable dispatchable)
               throws java.io.IOException,
                      javax.servlet.ServletException
```
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException
  - handleException
```
protected void handleException(java.lang.Throwable failure)
```
    Sends an error 500, performing a special logic to detect whether the request is suspended, to avoid concurrent writes from the application.
    
    It may happen that the application suspends, and then throws an exception, while an application spawned thread writes the response content; in such case, we attempt to commit the error directly bypassing the ErrorHandler mechanisms and the response OutputStream.
    
    Parameters:
    
    failure - the Throwable that caused the problem
  - unwrap
```
protected java.lang.Throwable unwrap(java.lang.Throwable failure,
                                     java.lang.Class<?>... targets)
```
    Unwrap failure causes to find target class
    
    Parameters:
    
    failure - The throwable to have its causes unwrapped
    
    targets - Exception classes that we should not unwrap
    
    Returns:
    
    A target throwable or null
  - sendResponseAndComplete
```
public void sendResponseAndComplete()
```
  - isExpecting100Continue
```
public boolean isExpecting100Continue()
```
  - isExpecting102Processing
```
public boolean isExpecting102Processing()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - onRequest
```
public void onRequest(MetaData.Request request)
```
  - onContent
```
public boolean onContent(HttpInput.Content content)
```
  - onContentComplete
```
public boolean onContentComplete()
```
  - onTrailers
```
public void onTrailers(HttpFields trailers)
```
  - onRequestComplete
```
public boolean onRequestComplete()
```
  - onCompleted
```
public void onCompleted()
```
  - onEarlyEOF
```
public boolean onEarlyEOF()
```
  - onBadMessage
```
public void onBadMessage(BadMessageException failure)
```
  - sendResponse
```
public boolean sendResponse(MetaData.Response info,
                            java.nio.ByteBuffer content,
                            boolean complete,
                            Callback callback)
```
  - sendResponse
```
public boolean sendResponse(MetaData.Response info,
                            java.nio.ByteBuffer content,
                            boolean complete)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - commit
```
protected void commit(MetaData.Response info)
```
  - isCommitted
```
public boolean isCommitted()
```
  - isRequestCompleted
```
public boolean isRequestCompleted()
```
    Returns:
    
    True if the request lifecycle is completed
  - isResponseCompleted
```
public boolean isResponseCompleted()
```
    Returns:
    
    True if the response is completely written.
  - isPersistent
```
public boolean isPersistent()
```
  - write
```
public void write(java.nio.ByteBuffer content,
                  boolean complete,
                  Callback callback)
```
    Non-Blocking write, committing the response if needed.
    Called as last link in HttpOutput.Filter chain
    
    Specified by:
    
    write in interface HttpOutput.Interceptor
    
    Parameters:
    
    content - the content buffer to write
    
    complete - whether the content is complete for the response
    
    callback - Callback when complete or failed
  - resetBuffer
```
public void resetBuffer()
```
    Description copied from interface: HttpOutput.Interceptor
    
    Reset the buffers.
    If the Interceptor contains buffers then reset them.
    
    Specified by:
    
    resetBuffer in interface HttpOutput.Interceptor
  - getNextInterceptor
```
public HttpOutput.Interceptor getNextInterceptor()
```
    Specified by:
    
    getNextInterceptor in interface HttpOutput.Interceptor
    
    Returns:
    
    The next Interceptor in the chain or null if this is the last Interceptor in the chain.
  - execute
```
protected void execute(java.lang.Runnable task)
```
  - getScheduler
```
public Scheduler getScheduler()
```
  - useDirectBuffers
```
public boolean useDirectBuffers()
```
    Returns:
    
    true if the HttpChannel can efficiently use direct buffer (typically this means it is not over SSL or a multiplexed protocol)
  - abort
```
public void abort(java.lang.Throwable failure)
```
    If a write or similar operation to this channel fails, then this method should be called.
    The standard implementation calls HttpTransport.abort(Throwable).
    
    Parameters:
    
    failure - the failure that caused the abort.
  - notifyEvent1
```
private void notifyEvent1(java.util.function.Function<HttpChannel.Listener,java.util.function.Consumer<Request>> function,
                          Request request)
```
  - notifyEvent2
```
private void notifyEvent2(java.util.function.Function<HttpChannel.Listener,java.util.function.BiConsumer<Request,java.nio.ByteBuffer>> function,
                          Request request,
                          java.nio.ByteBuffer content)
```
  - notifyEvent2
```
private void notifyEvent2(java.util.function.Function<HttpChannel.Listener,java.util.function.BiConsumer<Request,java.lang.Throwable>> function,
                          Request request,
                          java.lang.Throwable failure)
```

Class HttpChannel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOOP_LISTENER

LOG

_requests

_connector

_executor

_configuration

_endPoint

_transport

_state

_request

_response

_combinedListener

_transientListeners

_trailers

_trailerSupplier

_committedMetaData

_requestLog

_oldIdleTimeout

_written

Constructor Detail

HttpChannel

Method Detail

isSendError

formatAddrOrHost

newHttpInput

newHttpOutput

getState

addListener

removeListener

getTransientListeners

getBytesWritten

getRequests

getConnector

getHttpTransport

getRequestLog

setRequestLog

addRequestLog

getCommittedMetaData

getIdleTimeout

setIdleTimeout

getByteBufferPool

getHttpConfiguration

isOptimizedForDirectBuffers

getServer

getRequest

getResponse

getConnection

getEndPoint

getLocalName

getLocalPort

getLocalAddress

getRemoteAddress

getServerAuthority

continue100

recycle

onAsyncWaitForContent

onBlockWaitForContent

onBlockWaitForContentFailure

run

handle

ensureConsumeAllOrNotPersistent

dispatch

handleException

unwrap

sendResponseAndComplete

isExpecting100Continue

isExpecting102Processing

toString

onRequest

onContent

onContentComplete

onTrailers

onRequestComplete