HttpChannel (Jetty :: Server Core 9.4.10.v20180503 API)

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

All Implemented Interfaces:

java.lang.Runnable, HttpOutput.Interceptor

Direct Known Subclasses:

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 a 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

static interface HttpChannel.Listener
Listener for HttpChannel events.

Nested Classes
Modifier and Type	Class	Description
`static interface`	`HttpChannel.Listener`	Listener for `HttpChannel` events.

Constructor Summary

Constructors
Constructor Description

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

Constructors
Constructor	Description
`HttpChannel(Connector connector, HttpConfiguration configuration, EndPoint endPoint, HttpTransport transport)`

Method Summary

All Methods Instance Methods Concrete 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.
`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.
`protected void`	`execute(java.lang.Runnable task)`
`ByteBufferPool`	`getByteBufferPool()`
`long`	`getBytesWritten()`
`MetaData.Response`	`getCommittedMetaData()`
`Connector`	`getConnector()`
`EndPoint`	`getEndPoint()`
`HttpConfiguration`	`getHttpConfiguration()`
`HttpTransport`	`getHttpTransport()`
`long`	`getIdleTimeout()`	Get the idle timeout.
`java.net.InetSocketAddress`	`getLocalAddress()`
`HttpOutput.Interceptor`	`getNextInterceptor()`
`java.net.InetSocketAddress`	`getRemoteAddress()`
`Request`	`getRequest()`
`RequestLog`	`getRequestLog()`
`long`	`getRequests()`
`Response`	`getResponse()`
`Scheduler`	`getScheduler()`
`Server`	`getServer()`
`HttpChannelState`	`getState()`
`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()`
`protected HttpInput`	`newHttpInput(HttpChannelState state)`
`protected HttpOutput`	`newHttpOutput()`
`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()`
`void`	`resetBuffer()`	Reset the buffers.
`void`	`run()`
`protected void`	`sendError(int code, java.lang.String reason)`
`boolean`	`sendResponse(MetaData.Response info, java.nio.ByteBuffer content, boolean complete)`
`protected boolean`	`sendResponse(MetaData.Response info, java.nio.ByteBuffer content, boolean complete, Callback callback)`
`void`	`setIdleTimeout(long timeoutMs)`	Set the idle timeout.
`void`	`setRequestLog(RequestLog requestLog)`
`java.lang.String`	`toString()`
`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

- Constructor Detail
  - HttpChannel
```
public HttpChannel(Connector connector,
                   HttpConfiguration configuration,
                   EndPoint endPoint,
                   HttpTransport transport)
```
- Method Detail
  - newHttpInput
```
protected HttpInput newHttpInput(HttpChannelState state)
```
  - newHttpOutput
```
protected HttpOutput newHttpOutput()
```
  - getState
```
public HttpChannelState getState()
```
  - 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()
```
  - getEndPoint
```
public EndPoint getEndPoint()
```
  - getLocalAddress
```
public java.net.InetSocketAddress getLocalAddress()
```
  - getRemoteAddress
```
public java.net.InetSocketAddress getRemoteAddress()
```
  - 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)
  - sendError
```
protected void sendError(int code,
                         java.lang.String reason)
```
  - 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
  - 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
```
protected 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()
```
  - 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.

Class HttpChannel

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpChannel

Method Detail

newHttpInput

newHttpOutput

getState

getBytesWritten

getRequests

getConnector

getHttpTransport

getRequestLog

setRequestLog

addRequestLog

getCommittedMetaData

getIdleTimeout

setIdleTimeout

getByteBufferPool

getHttpConfiguration

isOptimizedForDirectBuffers

getServer

getRequest

getResponse

getEndPoint

getLocalAddress

getRemoteAddress

continue100

recycle

onAsyncWaitForContent

onBlockWaitForContent

onBlockWaitForContentFailure

run

handle

sendError

handleException

isExpecting100Continue

isExpecting102Processing

toString

onRequest

onContent

onContentComplete

onTrailers

onRequestComplete

onCompleted

onEarlyEOF

onBadMessage

sendResponse

sendResponse

commit

isCommitted

write

resetBuffer

getNextInterceptor

execute

getScheduler

useDirectBuffers

abort