001/* 002 * ==================================================================== 003 * Licensed to the Apache Software Foundation (ASF) under one 004 * or more contributor license agreements. See the NOTICE file 005 * distributed with this work for additional information 006 * regarding copyright ownership. The ASF licenses this file 007 * to you under the Apache License, Version 2.0 (the 008 * "License"); you may not use this file except in compliance 009 * with the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, 014 * software distributed under the License is distributed on an 015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 016 * KIND, either express or implied. See the License for the 017 * specific language governing permissions and limitations 018 * under the License. 019 * ==================================================================== 020 * 021 * This software consists of voluntary contributions made by many 022 * individuals on behalf of the Apache Software Foundation. For more 023 * information on the Apache Software Foundation, please see 024 * <http://www.apache.org/>. 025 * 026 */ 027 028package org.apache.http.nio; 029 030import java.io.IOException; 031 032import org.apache.http.HttpException; 033import org.apache.http.HttpRequest; 034 035/** 036 * Abstract non-blocking client-side HTTP connection interface. It can be used 037 * to submit HTTP requests and asynchronously receive HTTP responses. 038 * 039 * @see NHttpConnection 040 * 041 * @since 4.0 042 */ 043public interface NHttpClientConnection extends NHttpConnection { 044 045 /** 046 * Submits {@link HttpRequest} to be sent to the target server. 047 * 048 * @param request HTTP request 049 * @throws IOException if I/O error occurs while submitting the request 050 * @throws HttpException if the HTTP request violates the HTTP protocol. 051 */ 052 void submitRequest(HttpRequest request) throws IOException, HttpException; 053 054 /** 055 * Returns {@code true} if an HTTP request has been submitted to the 056 * target server. 057 * 058 * @return {@code true} if an HTTP request has been submitted, 059 * {@code false} otherwise. 060 */ 061 boolean isRequestSubmitted(); 062 063 /** 064 * Resets output state. This method can be used to prematurely terminate 065 * processing of the outgoing HTTP request. 066 */ 067 void resetOutput(); 068 069 /** 070 * Resets input state. This method can be used to prematurely terminate 071 * processing of the incoming HTTP response. 072 */ 073 void resetInput(); 074 075}