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