org.springframework.web.context.request.async

Interface AsyncWebRequest

    • Method Detail

      • setTimeout

        void setTimeout(@Nullable
                        java.lang.Long timeout)
        Set the time required for concurrent handling to complete. This property should not be set when concurrent handling is in progress, i.e. when isAsyncStarted() is true.
        Parameters:
        timeout - amount of time in milliseconds; null means no timeout, i.e. rely on the default timeout of the container.
      • addTimeoutHandler

        void addTimeoutHandler(java.lang.Runnable runnable)
        Add a handler to invoke when concurrent handling has timed out.
      • addErrorHandler

        void addErrorHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)
        Add a handler to invoke when an error occurred while concurrent handling of a request.
        Since:
        5.0
      • addCompletionHandler

        void addCompletionHandler(java.lang.Runnable runnable)
        Add a handler to invoke when request processing completes.
      • startAsync

        void startAsync()
        Mark the start of asynchronous request processing so that when the main processing thread exits, the response remains open for further processing in another thread.
        Throws:
        java.lang.IllegalStateException - if async processing has completed or is not supported
      • isAsyncStarted

        boolean isAsyncStarted()
        Whether the request is in async mode following a call to startAsync(). Returns "false" if asynchronous processing never started, has completed, or the request was dispatched for further processing.
      • dispatch

        void dispatch()
        Dispatch the request to the container in order to resume processing after concurrent execution in an application thread.
      • isAsyncComplete

        boolean isAsyncComplete()
        Whether asynchronous processing has completed.