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`

Constructor Summary

Constructors
Modifier Constructor Description

protected HttpChannelState(HttpChannel channel)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`abortResponse()`
`void`	`addListener(javax.servlet.AsyncListener listener)`
`void`	`asyncError(java.lang.Throwable failure)`
`protected void`	`cancelTimeout()`
`protected void`	`cancelTimeout(AsyncContextEvent event)`
`boolean`	`commitResponse()`
`void`	`complete()`
`protected void`	`completed(java.lang.Throwable failure)`
`boolean`	`completeResponse()`
`protected void`	`completing()`
`void`	`dispatch(javax.servlet.ServletContext context, java.lang.String path)`
`AsyncContextEvent`	`getAsyncContextEvent()`
`java.lang.Object`	`getAttribute(java.lang.String name)`
`Request`	`getBaseRequest()`
`ContextHandler`	`getContextHandler()`
`HttpChannel`	`getHttpChannel()`
`javax.servlet.ServletResponse`	`getServletResponse()`
`javax.servlet.ServletResponse`	`getServletResponse(AsyncContextEvent event)`
`HttpChannelState.State`	`getState()`
`java.lang.String`	`getStatusString()`
`long`	`getTimeout()`
`HttpChannelState.Action`	`handling()`
`boolean`	`hasListener(javax.servlet.AsyncListener listener)`
`boolean`	`isAsync()`
`boolean`	`isAsyncStarted()`
`boolean`	`isExpired()`
`boolean`	`isIdle()`
`boolean`	`isInitial()`
`boolean`	`isResponseCommitted()`
`boolean`	`isResponseCompleted()`
`boolean`	`isSendError()`
`boolean`	`isSuspended()`
`void`	`onContentAdded()`
`protected void`	`onError(java.lang.Throwable th)`
`boolean`	`onReadEof()`
`void`	`onReadIdle()`
`boolean`	`onReadReady()`	Called to signal that the channel is ready for a callback.
`void`	`onReadUnready()`	Called to indicate that more content may be available, but that a handling thread may need to produce (fill/parse) it.
`protected void`	`onTimeout()`
`boolean`	`onWritePossible()`
`boolean`	`partialResponse()`
`protected void`	`recycle()`
`void`	`removeAttribute(java.lang.String name)`
`protected void`	`scheduleDispatch()`
`void`	`sendError(int code, java.lang.String message)`
`void`	`setAttribute(java.lang.String name, java.lang.Object attribute)`
`void`	`setTimeout(long ms)`
`void`	`startAsync(AsyncContextEvent event)`
`protected void`	`timeout()`
`java.lang.String`	`toString()`
`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(javax.servlet.AsyncListener listener)

hasListener

public boolean hasListener(javax.servlet.AsyncListener listener)

isSendError
```
public boolean isSendError()
```

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

getStatusString

public java.lang.String getStatusString()

commitResponse
```
public boolean commitResponse()
```

partialResponse
```
public boolean partialResponse()
```

completeResponse
```
public boolean completeResponse()
```

isResponseCommitted
```
public boolean isResponseCommitted()
```

isResponseCompleted
```
public boolean isResponseCompleted()
```

abortResponse
```
public boolean abortResponse()
```

handling
```
public HttpChannelState.Action handling()
```
Returns:

Next handling of the request should proceed

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)

startAsync

public void startAsync(AsyncContextEvent event)

dispatch

public void dispatch(javax.servlet.ServletContext context,
                     java.lang.String path)

timeout
```
protected void timeout()
```

onTimeout
```
protected void onTimeout()
```

complete
```
public void complete()
```

asyncError

public void asyncError(java.lang.Throwable failure)

onError

protected void onError(java.lang.Throwable th)

sendError

public void sendError(int code,
                      java.lang.String message)

completing
```
protected void completing()
```

completed

protected void completed(java.lang.Throwable failure)

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()
```

isAsync
```
public boolean isAsync()
```

getBaseRequest
```
public Request getBaseRequest()
```

getHttpChannel
```
public HttpChannel getHttpChannel()
```

getContextHandler

public ContextHandler getContextHandler()

getServletResponse

public javax.servlet.ServletResponse getServletResponse()

getServletResponse

public javax.servlet.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)

onReadReady
```
public boolean onReadReady()
```
Called to signal that the channel is ready for a callback.

Returns:

true if woken

onReadEof
```
public boolean onReadEof()
```

onContentAdded
```
public void onContentAdded()
```

onReadIdle
```
public void onReadIdle()
```

onReadUnready
```
public void onReadUnready()
```
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.

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

hasListener

isSendError

setTimeout

getTimeout

getAsyncContextEvent

toString

getStatusString

commitResponse

partialResponse

completeResponse

isResponseCommitted

isResponseCompleted

abortResponse

handling

unhandle

startAsync

dispatch

timeout

onTimeout

complete

asyncError

onError

sendError

completing

completed

recycle

upgrade

scheduleDispatch

cancelTimeout

cancelTimeout

isIdle

isExpired

isInitial

isSuspended

isAsyncStarted

isAsync

getBaseRequest

getHttpChannel

getContextHandler

getServletResponse

getServletResponse

getAttribute

removeAttribute

setAttribute

onReadReady

onReadEof

onContentAdded

onReadIdle

onReadUnready

onWritePossible