HttpChannelState (Jetty :: Server Core 9.4.12.v20180830 API)

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

```
public class HttpChannelState
extends java.lang.Object
```
Implementation of AsyncContext interface that holds the state of request-response cycle.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HttpChannelState.Action`	The actions to take as the channel moves from state to state.
`static class`	`HttpChannelState.State`	The state of the HttpChannel,used to control the overall lifecycle.

Constructor Summary

Constructors
Modifier Constructor Description

protected HttpChannelState(HttpChannel channel)

Constructors
Modifier	Constructor	Description
`protected`	`HttpChannelState(HttpChannel channel)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addListener(AsyncListener listener)`
`void`	`asyncError(java.lang.Throwable failure)`
`protected void`	`cancelTimeout()`
`protected void`	`cancelTimeout(AsyncContextEvent event)`
`void`	`complete()`
`void`	`dispatch(ServletContext context, java.lang.String path)`
`void`	`errorComplete()`
`AsyncContextEvent`	`getAsyncContextEvent()`
`java.lang.Object`	`getAttribute(java.lang.String name)`
`Request`	`getBaseRequest()`
`ContextHandler`	`getContextHandler()`
`HttpChannel`	`getHttpChannel()`
`ServletResponse`	`getServletResponse()`
`ServletResponse`	`getServletResponse(AsyncContextEvent event)`
`HttpChannelState.State`	`getState()`
`java.lang.String`	`getStatusString()`
`long`	`getTimeout()`
`protected HttpChannelState.Action`	`handling()`
`boolean`	`isAsync()`
`boolean`	`isAsyncComplete()`
`boolean`	`isAsyncStarted()`
`boolean`	`isExpired()`
`boolean`	`isIdle()`
`boolean`	`isInitial()`
`boolean`	`isSuspended()`
`protected void`	`onComplete()`
`boolean`	`onContentAdded()`	Called to signal that content is now available to read.
`protected void`	`onError(java.lang.Throwable th)`
`boolean`	`onReadEof()`	Called to signal that a read has read -1.
`boolean`	`onReadPossible()`	Called to indicate that more content may be available, but that a handling thread may need to produce (fill/parse) it.
`boolean`	`onReadReady()`	Called to signal that the channel is ready for a callback.
`void`	`onReadUnready()`	Called to signal async read isReady() has returned false.
`protected void`	`onTimeout()`
`boolean`	`onWritePossible()`
`protected void`	`recycle()`
`void`	`removeAttribute(java.lang.String name)`
`protected void`	`scheduleDispatch()`
`void`	`setAttribute(java.lang.String name, java.lang.Object attribute)`
`void`	`setTimeout(long ms)`
`void`	`startAsync(AsyncContextEvent event)`
`java.lang.String`	`toString()`
`java.lang.String`	`toStringLocked()`
`protected HttpChannelState.Action`	`unhandle()`	Signal that the HttpConnection has finished handling the request.
`void`	`upgrade()`

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

- Constructor Detail
  - HttpChannelState
```
protected HttpChannelState(HttpChannel channel)
```
- Method Detail
  - getState
```
public HttpChannelState.State getState()
```
  - addListener
```
public void addListener(AsyncListener listener)
```
  - setTimeout
```
public void setTimeout(long ms)
```
  - getTimeout
```
public long getTimeout()
```
  - getAsyncContextEvent
```
public AsyncContextEvent getAsyncContextEvent()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toStringLocked
```
public java.lang.String toStringLocked()
```
  - getStatusString
```
public java.lang.String getStatusString()
```
  - handling
```
protected HttpChannelState.Action handling()
```
    Returns:
    
    Next handling of the request should proceed
  - startAsync
```
public void startAsync(AsyncContextEvent event)
```
  - asyncError
```
public void asyncError(java.lang.Throwable failure)
```
  - unhandle
```
protected HttpChannelState.Action unhandle()
```
    Signal that the HttpConnection has finished handling the request. For blocking connectors, this call may block if the request has been suspended (startAsync called).
    
    Returns:
    
    next actions be handled again (eg because of a resume that happened before unhandle was called)
  - dispatch
```
public void dispatch(ServletContext context,
                     java.lang.String path)
```
  - onTimeout
```
protected void onTimeout()
```
  - complete
```
public void complete()
```
  - errorComplete
```
public void errorComplete()
```
  - onError
```
protected void onError(java.lang.Throwable th)
```
  - onComplete
```
protected void onComplete()
```
  - recycle
```
protected void recycle()
```
  - upgrade
```
public void upgrade()
```
  - scheduleDispatch
```
protected void scheduleDispatch()
```
  - cancelTimeout
```
protected void cancelTimeout()
```
  - cancelTimeout
```
protected void cancelTimeout(AsyncContextEvent event)
```
  - isIdle
```
public boolean isIdle()
```
  - isExpired
```
public boolean isExpired()
```
  - isInitial
```
public boolean isInitial()
```
  - isSuspended
```
public boolean isSuspended()
```
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
  - isAsyncComplete
```
public boolean isAsyncComplete()
```
  - isAsync
```
public boolean isAsync()
```
  - getBaseRequest
```
public Request getBaseRequest()
```
  - getHttpChannel
```
public HttpChannel getHttpChannel()
```
  - getContextHandler
```
public ContextHandler getContextHandler()
```
  - getServletResponse
```
public ServletResponse getServletResponse()
```
  - getServletResponse
```
public ServletResponse getServletResponse(AsyncContextEvent event)
```
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
  - setAttribute
```
public void setAttribute(java.lang.String name,
                         java.lang.Object attribute)
```
  - onReadUnready
```
public void onReadUnready()
```
    Called to signal async read isReady() has returned false. This indicates that there is no content available to be consumed and that once the channel enters the ASYNC_WAIT state it will register for read interest by calling HttpChannel.onAsyncWaitForContent() either from this method or from a subsequent call to unhandle().
  - onContentAdded
```
public boolean onContentAdded()
```
    Called to signal that content is now available to read. If the channel is in ASYNC_WAIT state and unready (ie isReady() has returned false), then the state is changed to ASYNC_WOKEN and true is returned.
    
    Returns:
    
    True IFF the channel was unready and in ASYNC_WAIT state
  - onReadReady
```
public boolean onReadReady()
```
    Called to signal that the channel is ready for a callback. This is similar to calling onReadUnready() followed by onContentAdded(), except that as content is already available, read interest is never set.
    
    Returns:
    
    true if woken
  - onReadPossible
```
public boolean onReadPossible()
```
    Called to indicate that more content may be available, but that a handling thread may need to produce (fill/parse) it. Typically called by the async read success callback.
    
    Returns:
    
    true if more content may be available
  - onReadEof
```
public boolean onReadEof()
```
    Called to signal that a read has read -1. Will wake if the read was called while in ASYNC_WAIT state
    
    Returns:
    
    true if woken
  - onWritePossible
```
public boolean onWritePossible()
```

Class HttpChannelState

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpChannelState

Method Detail

getState

addListener

setTimeout

getTimeout

getAsyncContextEvent

toString

toStringLocked

getStatusString

handling

startAsync

asyncError

unhandle

dispatch

onTimeout

complete

errorComplete

onError

onComplete

recycle

upgrade

scheduleDispatch

cancelTimeout

cancelTimeout

isIdle

isExpired

isInitial

isSuspended

isAsyncStarted

isAsyncComplete

isAsync

getBaseRequest

getHttpChannel

getContextHandler

getServletResponse

getServletResponse

getAttribute

removeAttribute

setAttribute

onReadUnready

onContentAdded

onReadReady

onReadPossible

onReadEof

onWritePossible