Class ServletChannelState
java.lang.Object
org.eclipse.jetty.ee10.servlet.ServletChannelState
holder of the state of request-response cycle.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe actions to take as the channel moves from state to state.static enum -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidaddListener(jakarta.servlet.AsyncListener listener) voidasyncError(Throwable failure) This method is called when a failure occurs asynchronously to normal handling.protected voidprotected voidcancelTimeout(AsyncContextEvent event) voidcomplete()protected voidprotected voidvoidgetAttribute(String name) getState()longhandling()booleanhasListener(jakarta.servlet.AsyncListener listener) booleanbooleanisAsync()booleanbooleanbooleanisIdle()booleanbooleanbooleanbooleanbooleanbooleanprotected booleanbooleanonIdleTimeout(TimeoutException timeout) voidCalled to indicate that the content is being consumed.booleanbooleanCalled to signal that the channel is ready for a callback.voidCalled to indicate that no content is currently available, more content has been demanded and may be available, but that a handling thread may need to produce (fill/parse) it.protected voidbooleanvoidprotected voidrecycle()voidremoveAttribute(String name) protected voidvoidvoidsetAttribute(String name, Object attribute) voidsetTimeout(long ms) voidstartAsync(AsyncContextEvent event) protected voidtimeout()toString()protected ServletChannelState.Actionunhandle()Signal that the HttpConnection has finished handling the request.voidupgrade()
-
Constructor Details
-
ServletChannelState
-
-
Method Details
-
getServletChannel
-
isAborted
public boolean isAborted() -
openOutput
public void openOutput() -
getState
-
addListener
public void addListener(jakarta.servlet.AsyncListener listener) -
hasListener
public boolean hasListener(jakarta.servlet.AsyncListener listener) -
isSendError
public boolean isSendError() -
setTimeout
public void setTimeout(long ms) -
getTimeout
public long getTimeout() -
getAsyncContextEvent
-
toString
-
getStatusString
-
completeResponse
-
isResponseCommitted
public boolean isResponseCommitted() -
isResponseCompleted
public boolean isResponseCompleted() -
abort
-
handling
- Returns:
- Next handling of the request should proceed
-
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 (e.g. because of a resume that happened before unhandle was called)
-
startAsync
-
dispatch
-
timeout
protected void timeout() -
onTimeout
protected void onTimeout() -
complete
public void complete() -
asyncError
This method is called when a failure occurs asynchronously to normal handling. If the request is async, we arrange for the exception to be thrown from the normal handling loop and then actually handled byonError(Throwable)- Parameters:
failure- the error.
-
onIdleTimeout
-
onError
-
sendError
-
completing
protected void completing() -
completed
-
recycle
protected void recycle() -
upgrade
public void upgrade() -
scheduleDispatch
protected void scheduleDispatch() -
cancelTimeout
protected void cancelTimeout() -
cancelTimeout
-
isIdle
public boolean isIdle() -
isExpired
public boolean isExpired() -
isInitial
public boolean isInitial() -
isSuspended
public boolean isSuspended() -
isAsyncStarted
public boolean isAsyncStarted() -
isAsync
public boolean isAsync() -
getContextHandler
-
getAttribute
-
removeAttribute
-
setAttribute
-
onReadReady
public boolean onReadReady()Called to signal that the channel is ready for a callback.- Returns:
- true if woken
-
onReadListenerReady
public boolean onReadListenerReady() -
onReadIdle
public void onReadIdle()Called to indicate that the content is being consumed. -
onReadUnready
public void onReadUnready()Called to indicate that no content is currently available, more content has been demanded and may be available, but that a handling thread may need to produce (fill/parse) it. -
isInputUnready
public boolean isInputUnready() -
onWritePossible
public boolean onWritePossible()
-