package org.frameworkset.web.request.async;
import org.frameworkset.web.servlet.mvc.NativeWebRequest;
/**
* Extends {@link NativeWebRequest} with methods for asynchronous request processing.
*
* @author Rossen Stoyanchev
* @since 3.2
*/
public interface AsyncWebRequest extends NativeWebRequest {
/**
* Set the time required for concurrent handling to complete.
* This property should not be set when concurrent handling is in progress,
* i.e. when {@link #isAsyncStarted()} is {@code true}.
* @param timeout amount of time in milliseconds; {@code null} means no
* timeout, i.e. rely on the default timeout of the container.
*/
void setTimeout(Long timeout);
/**
* Add a handler to invoke when concurrent handling has timed out.
*/
void addTimeoutHandler(Runnable runnable);
/**
* Add a handle to invoke when request processing completes.
*/
void addCompletionHandler(Runnable runnable);
/**
* 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 IllegalStateException if async processing has completed or is not supported
*/
void startAsync();
/**
* Whether the request is in async mode following a call to {@link #startAsync()}.
* Returns "false" if asynchronous processing never started, has completed,
* or the request was dispatched for further processing.
*/
boolean isAsyncStarted();
/**
* Dispatch the request to the container in order to resume processing after
* concurrent execution in an application thread.
*/
void dispatch();
/**
* Whether asynchronous processing has completed.
*/
boolean isAsyncComplete();
}