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;
29
30 import java.io.IOException;
31
32 import org.apache.http.HttpException;
33 import org.apache.http.HttpResponse;
34
35 /**
36 * Abstract non-blocking server-side HTTP connection interface. It can be used
37 * to receive HTTP requests and asynchronously submit HTTP responses.
38 *
39 * @see NHttpConnection
40 *
41 * @since 4.0
42 */
43 public interface NHttpServerConnection extends NHttpConnection {
44
45 /**
46 * Submits {link @HttpResponse} to be sent to the client.
47 *
48 * @param response HTTP response
49 *
50 * @throws IOException if I/O error occurs while submitting the response
51 * @throws HttpException if the HTTP response violates the HTTP protocol.
52 */
53 void submitResponse(HttpResponse response) throws IOException, HttpException;
54
55 /**
56 * Returns {@code true} if an HTTP response has been submitted to the
57 * client.
58 *
59 * @return {@code true} if an HTTP response has been submitted,
60 * {@code false} otherwise.
61 */
62 boolean isResponseSubmitted();
63
64 /**
65 * Resets output state. This method can be used to prematurely terminate
66 * processing of the incoming HTTP request.
67 */
68 void resetInput();
69
70 /**
71 * Resets input state. This method can be used to prematurely terminate
72 * processing of the outgoing HTTP response.
73 */
74 void resetOutput();
75
76 }