001/* 002 * Copyright 2002-2014 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.http.server; 018 019/** 020 * A control that can put the processing of an HTTP request in asynchronous mode during 021 * which the response remains open until explicitly closed. 022 * 023 * @author Rossen Stoyanchev 024 * @since 4.0 025 */ 026public interface ServerHttpAsyncRequestControl { 027 028 /** 029 * Enable asynchronous processing after which the response remains open until a call 030 * to {@link #complete()} is made or the server times out the request. Once enabled, 031 * additional calls to this method are ignored. 032 */ 033 void start(); 034 035 /** 036 * A variation on {@link #start()} that allows specifying a timeout value to use to 037 * use for asynchronous processing. If {@link #complete()} is not called within the 038 * specified value, the request times out. 039 */ 040 void start(long timeout); 041 042 /** 043 * Return whether asynchronous request processing has been started. 044 */ 045 boolean isStarted(); 046 047 /** 048 * Mark asynchronous request processing as completed. 049 */ 050 void complete(); 051 052 /** 053 * Return whether asynchronous request processing has been completed. 054 */ 055 boolean isCompleted(); 056 057}