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.hc.core5.http.io; 29 30 import org.apache.hc.core5.annotation.Internal; 31 import org.apache.hc.core5.http.ClassicHttpRequest; 32 33 import java.io.IOException; 34 import java.io.InputStream; 35 36 /** 37 * Represents a strategy to determine how frequently the client should check for an out of order response. 38 * An out of order response is sent before the server has read the full request. If the client fails to 39 * check for an early response then a {@link java.net.SocketException} or {@link java.net.SocketTimeoutException} 40 * may be thrown while writing the request entity after a timeout is reached on either the client or server. 41 * 42 * @since 5.1 43 */ 44 @Internal 45 public interface ResponseOutOfOrderStrategy { 46 47 /** 48 * Called before each write to the to a socket {@link java.io.OutputStream} with the number of 49 * bytes that have already been sent, and the size of the write that will occur if this check 50 * does not encounter an out of order response. 51 * 52 * @param request The current request. 53 * @param connection The connection used to send the current request. 54 * @param inputStream The response stream, this may be used to check for an early response. 55 * @param totalBytesSent Number of bytes that have already been sent. 56 * @param nextWriteSize The size of a socket write operation that will follow this check. 57 * @return True if an early response was detected, otherwise false. 58 * @throws IOException in case of a network failure while checking for an early response. 59 */ 60 boolean isEarlyResponseDetected( 61 ClassicHttpRequest request, 62 HttpClientConnection connection, 63 InputStream inputStream, 64 long totalBytesSent, 65 long nextWriteSize) throws IOException; 66 }