org.apache.coyote

Class AsyncStateMachine

java.lang.Object

org.apache.coyote.AsyncStateMachine

public class AsyncStateMachine
extends Object

Manages the state transitions for async requests.

 The internal states that are used are:
 DISPATCHED    - Standard request. Not in Async mode.
 STARTING      - ServletRequest.startAsync() has been called but the
                 request in which that call was made has not finished
                 processing.
 STARTED       - ServletRequest.startAsync() has been called and the
                 request in which that call was made has finished
                 processing.
 READ_WRITE_OP - Performing an asynchronous read or write.
 MUST_COMPLETE - complete() has been called before the request in which
                 ServletRequest.startAsync() has finished. As soon as that
                 request finishes, the complete() will be processed.
 COMPLETING    - The call to complete() was made once the request was in
                 the STARTED state. May or may not be triggered by a
                 container thread - depends if start(Runnable) was used
 TIMING_OUT    - The async request has timed out and is waiting for a call
                 to complete(). If that isn't made, the error state will
                 entered.
 MUST_DISPATCH - dispatch() has been called before the request in which
                 ServletRequest.startAsync() has finished. As soon as that
                 request finishes, the dispatch() will be processed.
 DISPATCHING   - The dispatch is being processed.
 ERROR         - Something went wrong.

 |-----------------»------|
 |                       \|/
 |   |----------«-------ERROR-----------------------------------«-------------------------------|
 |   |      complete() /|\/|\\                                                                  |
 |   |                  |  |  \                                                                 |
 |   |    |-----»-------|  |   \-----------»----------|                                         |
 |   |    |                |                          |dispatch()                               |
 |   |    |                |                         \|/                                        |
 |   |    |                |          |--|timeout()   |                                         |
 |   |    |     post()     |          | \|/           |     post()                              |
 |   |    |    |---------- | --»DISPATCHED«---------- | --------------COMPLETING«-----|         |
 |   |    |    |           |   /|\  |                 |                 | /|\         |         |
 |   |    |    |    |---»- | ---|   |                 |                 |--|          |         |
 |   |    ^    ^    |      |        |startAsync()     |               timeout()       |         |
 |   |    |    |    |       \       |                 |                               |         |
 |   |    |    |    |        \      |                 |                               |         |
 |   |    |    |    |         \     |                 |                               |         |
 |   |    |    |    |          \    |                 |                               |         |
 |  \|/   |    |    |           \  \|/     post()     |                               |         |
 | MUST_COMPLETE-«- | ----«------STARTING--»--------- | -------------|                ^         |
 |  /|\    /|\      |  complete()   |                 |              |     complete() |         |
 |   |      |       |               |                 |    post()    |     /----------|         |
 |   |      |       ^               |dispatch()       |    |-----|   |    /                     |
 |   |      |       |               |                 |    |     |   |   /                      |
 |   |      |       |              \|/                |    |    \|/ \|/ /       post()          |
 |   |      |       |         MUST_DISPATCH-----«-----|    |--«--STARTED«---------«---------|   |
 |   |      |       |              /|\   |                      / |   |                     |   |
 |   |      |       |               |    |post()               /  |   |                     ^   |
 ^   |      ^       |               |    |dispatched()        /   |   |asyncOperation()     |   |
 |   |      |       ^               |    |                   /    |   |                     |   |
 |   |      |       |               |    |    |-------------/     |   |»-READ_WRITE_OP--»---|   |
 |   |      |       |               |    |    |    dispatch()     |            |  |  |          |
 |   |      |       |post()         |    |    |          timeout()|            |  |  |   error()|
 |   |      |       |dispatched()   |   \|/  \|/                  |  dispatch()|  |  |-»--------|
 |   |      |       |---«---------- | ---DISPATCHING«-----«------ | ------«----|  |
 |   |      |                       |     |    ^                  |               |
 |   |      |                       |     |----|                  |               |
 |   |      |                       |    timeout()                |               |
 |   |      |                       |                             |               |
 |   |      |                       |       dispatch()           \|/              |
 |   |      |                       |-----------«-----------TIMING_OUT            |
 |   |      |                                                 |   |               |
 |   |      |-------«----------------------------------«------|   |               |
 |   |                          complete()                        |               |
 |   |                                                            |               |
 |«- | ----«-------------------«-------------------------------«--|               |
     |                           error()                                          |
     |                                                  complete()                |
     |----------------------------------------------------------------------------|
 

Constructor Summary

Constructors

Constructor and Description
AsyncStateMachine(AbstractProcessor processor)

Method Summary

Modifier and Type	Method and Description
boolean	asyncComplete()
boolean	asyncDispatch()
void	asyncDispatched()
void	asyncError()
void	asyncOperation()
AbstractEndpoint.Handler.SocketState	asyncPostProcess()
void	asyncRun(Runnable runnable)
void	asyncStart(AsyncContextCallback asyncCtxt)
boolean	asyncTimeout()
long	getLastAsyncStart() Obtain the time that this connection last transitioned to async processing.
boolean	isAsync()
boolean	isAsyncDispatching()
boolean	isAsyncError()
boolean	isAsyncStarted()
boolean	isAsyncTimingOut()
boolean	isCompleting()
void	recycle()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsyncStateMachine

public AsyncStateMachine(AbstractProcessor processor)

Method Detail

isAsync

public boolean isAsync()

isAsyncDispatching

public boolean isAsyncDispatching()

isAsyncStarted

public boolean isAsyncStarted()

isAsyncTimingOut

public boolean isAsyncTimingOut()

isAsyncError

public boolean isAsyncError()

isCompleting

public boolean isCompleting()

getLastAsyncStart

public long getLastAsyncStart()

Obtain the time that this connection last transitioned to async processing.

Returns:

The time (as returned by System.currentTimeMillis()) that this connection last transitioned to async

asyncStart

public void asyncStart(AsyncContextCallback asyncCtxt)

asyncOperation

public void asyncOperation()

asyncPostProcess

public AbstractEndpoint.Handler.SocketState asyncPostProcess()

asyncComplete

public boolean asyncComplete()

asyncTimeout

public boolean asyncTimeout()

asyncDispatch

public boolean asyncDispatch()

asyncDispatched

public void asyncDispatched()

asyncError

public void asyncError()

asyncRun

public void asyncRun(Runnable runnable)

recycle

public void recycle()