public class ServletServerHttpAsyncRequestControl extends ObjectSE implements ServerHttpAsyncRequestControl, AsyncListenerEE
ServerHttpAsyncRequestControl
。コンストラクターと説明 |
---|
ServletServerHttpAsyncRequestControl(ServletServerHttpRequest request, ServletServerHttpResponse response) それぞれ型 ServletServerHttpRequest および ServletServerHttpResponse であると予想されるリクエストとレスポンスのペアを受け入れるコンストラクター。 |
修飾子と型 | メソッドと説明 |
---|---|
void | complete() 非同期リクエスト処理を完了としてマークします。 |
boolean | isCompleted() 非同期リクエスト処理が完了したかどうかを返します。 |
boolean | isStarted() 非同期リクエスト処理が開始されているかどうかを返します。 |
void | onComplete(AsyncEventEE event) この AsyncListener に非同期操作が完了したことを通知します。 |
void | onError(AsyncEventEE event) この AsyncListener に、非同期操作の補完に失敗したことを通知します。 |
void | onStartAsync(AsyncEventEE event) ServletRequest.startAsync() EE メソッドの 1 つを呼び出して、新しい非同期サイクルが開始されていることを、この AsyncListener に通知します。 |
void | onTimeout(AsyncEventEE event) この AsyncListener に、非同期操作がタイムアウトしたことを通知します。 |
void | start() 非同期処理を有効にしてから、 ServerHttpAsyncRequestControl.complete() への呼び出しが行われるか、サーバーがリクエストをタイムアウトするまで、レスポンスは開いたままになります。 |
void | start(long timeout) 非同期処理に使用するタイムアウト値を指定できる ServerHttpAsyncRequestControl.start() のバリエーション。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public ServletServerHttpAsyncRequestControl(ServletServerHttpRequest request, ServletServerHttpResponse response)
ServletServerHttpRequest
および ServletServerHttpResponse
であると予想されるリクエストとレスポンスのペアを受け入れるコンストラクター。public boolean isStarted()
ServerHttpAsyncRequestControl
ServerHttpAsyncRequestControl
の isStarted
public boolean isCompleted()
ServerHttpAsyncRequestControl
ServerHttpAsyncRequestControl
の isCompleted
public void start()
ServerHttpAsyncRequestControl
ServerHttpAsyncRequestControl.complete()
への呼び出しが行われるか、サーバーがリクエストをタイムアウトするまで、レスポンスは開いたままになります。有効にすると、このメソッドへの追加の呼び出しは無視されます。ServerHttpAsyncRequestControl
の start
public void start(long timeout)
ServerHttpAsyncRequestControl
ServerHttpAsyncRequestControl.start()
のバリエーション。ServerHttpAsyncRequestControl.complete()
が指定された値内で呼び出されない場合、リクエストはタイムアウトします。ServerHttpAsyncRequestControl
の start
public void complete()
ServerHttpAsyncRequestControl
ServerHttpAsyncRequestControl
の complete
public void onComplete(AsyncEventEE event) throws IOExceptionSE
javax.servlet.AsyncListenerEE
完了した非同期操作に対応する AsyncContext
EE は、特定のイベントで getAsyncContext
EE を呼び出すことによって取得できます。
さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)
EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest
EE および getSuppliedResponse
EE を呼び出すことで取得できます。
AsyncListenerEE
の onCompleteEE
event
- 非同期操作が完了したことを示す AsyncEventIOExceptionSE
- 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合 public void onStartAsync(AsyncEventEE event) throws IOExceptionSE
javax.servlet.AsyncListenerEE
ServletRequest.startAsync()
EE メソッドの 1 つを呼び出して、新しい非同期サイクルが開始されていることを、この AsyncListener に通知します。 再初期化される非同期操作に対応する AsyncContext
EE は、特定の event で getAsyncContext
EE を呼び出すことで取得できます。
さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)
EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest
EE および getSuppliedResponse
EE を呼び出すことで取得できます。
この AsyncListener は、指定された AsyncEvent の一部として配信される AsyncContext に自身を(AsyncContext.addListener(javax.servlet.AsyncListener)
EE への呼び出しを介して)登録しない限り、新しい非同期サイクルに関連するイベントを受け取りません。
AsyncListenerEE
の onStartAsyncEE
event
- 新しい非同期サイクルが開始されていることを示す AsyncEventIOExceptionSE
- 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合 public void onError(AsyncEventEE event) throws IOExceptionSE
javax.servlet.AsyncListenerEE
完了できなかった非同期操作に対応する AsyncContext
EE は、指定されたイベントで getAsyncContext
EE を呼び出すことによって取得できます。
さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)
EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest
EE および getSuppliedResponse
EE を呼び出すことで取得できます。
AsyncListenerEE
の onErrorEE
event
- 非同期操作が完了できなかったことを示す AsyncEventIOExceptionSE
- 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合 public void onTimeout(AsyncEventEE event) throws IOExceptionSE
javax.servlet.AsyncListenerEE
タイムアウトになった非同期操作に対応する AsyncContext
EE は、指定されたイベントで getAsyncContext
EE を呼び出すことによって取得できます。
さらに、この AsyncListener が AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse)
EE の呼び出しを介して登録されていた場合、提供された ServletRequest および ServletResponse オブジェクトは、指定された event でそれぞれ getSuppliedRequest
EE および getSuppliedResponse
EE を呼び出すことで取得できます。
AsyncListenerEE
の onTimeoutEE
event
- 非同期操作がタイムアウトしたことを示す AsyncEventIOExceptionSE
- 指定された AsyncEvent の処理中に I/O 関連のエラーが発生した場合