1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.nio.protocol;
29
30 import java.io.IOException;
31
32 import org.apache.http.HttpException;
33 import org.apache.http.HttpResponse;
34
35 /**
36 * Callback interface to submit HTTP responses asynchronously.
37 * <p>
38 * The {@link NHttpRequestHandler#handle(org.apache.http.HttpRequest, HttpResponse, NHttpResponseTrigger, org.apache.http.protocol.HttpContext)}
39 * method does not have to submit a response immediately. It can defer
40 * transmission of the HTTP response back to the client without blocking the
41 * I/O thread by delegating the process of handling the HTTP request to a worker
42 * thread. The worker thread in its turn can use the instance of
43 * {@link NHttpResponseTrigger} passed as a parameter to submit a response as at
44 * a later point of time once the response becomes available.
45 *
46 * @since 4.0
47 *
48 * @deprecated (4.2) use {@link HttpAsyncExchange}
49 */
50 @Deprecated
51 public interface NHttpResponseTrigger {
52
53 /**
54 * Submits a response to be sent back to the client as a result of
55 * processing of the request.
56 */
57 void submitResponse(HttpResponse response);
58
59 /**
60 * Reports a protocol exception thrown while processing the request.
61 */
62 void handleException(HttpException ex);
63
64 /**
65 * Report an IOException thrown while processing the request.
66 */
67 void handleException(IOException ex);
68
69 }