ServletServerHttpAsyncRequestControl (Spring Framework 5.1.5.RELEASE API)

java.lang.Object
- org.springframework.http.server.ServletServerHttpAsyncRequestControl

実装されているすべてのインターフェース:
java.util.EventListener, AsyncListenerEE, ServerHttpAsyncRequestControl
```
public class ServletServerHttpAsyncRequestControl
extends java.lang.Object
implements ServerHttpAsyncRequestControl, AsyncListenerEE
```
サーブレットコンテナー（Servlet 3.0+）で使用する ServerHttpAsyncRequestControl。
導入:
4.0
作成者:
Rossen Stoyanchev

コンストラクターの概要

コンストラクター
コンストラクターと説明
`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()` のバリエーション。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

クラス ServletServerHttpAsyncRequestControl

コンストラクターの概要

方法の概要

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

ServletServerHttpAsyncRequestControl

メソッドの詳細

isStarted

isCompleted

start

start

complete

onComplete

onStartAsync

onError

onTimeout