1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/params/CoreConnectionPNames.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 576077 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-09-16 04:50:22 -0700 (Sun, 16 Sep 2007) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.params; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Defines parameter names for connections in HttpCore. 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 576077 $ 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface CoreConnectionPNames { 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Defines the default socket timeout (<tt>SO_TIMEOUT</tt>) in milliseconds which is the 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * timeout for waiting for data. A timeout value of zero is interpreted as an infinite 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * timeout. This value is used when no socket timeout is set in the 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * method parameters. 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Integer}. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see java.net.SocketOptions#SO_TIMEOUT 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String SO_TIMEOUT = "http.socket.timeout"; 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines whether Nagle's algorithm is to be used. The Nagle's algorithm 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * tries to conserve bandwidth by minimizing the number of segments that are 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * sent. When applications wish to decrease network latency and increase 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * performance, they can disable Nagle's algorithm (that is enable TCP_NODELAY). 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Data will be sent earlier, at the cost of an increase in bandwidth consumption. 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Boolean}. 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see java.net.SocketOptions#TCP_NODELAY 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String TCP_NODELAY = "http.tcp.nodelay"; 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines the size of the internal socket buffer used to buffer data 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * while receiving / transmitting HTTP messages. 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Integer}. 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String SOCKET_BUFFER_SIZE = "http.socket.buffer-size"; 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets SO_LINGER with the specified linger time in seconds. The maximum timeout 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * value is platform specific. Value <tt>0</tt> implies that the option is disabled. 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Value <tt>-1</tt> implies that the JRE default is used. The setting only affects 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * socket close. 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Integer}. 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see java.net.SocketOptions#SO_LINGER 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String SO_LINGER = "http.socket.linger"; 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines the timeout until a connection is etablished. A value of zero 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * means the timeout is not used. The default value is zero. 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Integer}. 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String CONNECTION_TIMEOUT = "http.connection.timeout"; 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines whether stale connection check is to be used. Disabling 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * stale connection check may result in slight performance improvement 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * at the risk of getting an I/O error when executing a request over a 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * connection that has been closed at the server side. 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Boolean}. 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String STALE_CONNECTION_CHECK = "http.connection.stalecheck"; 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines the maximum line length limit. If set to a positive value, any HTTP 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * line exceeding this limit will cause an IOException. A negative or zero value 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * will effectively disable the check. 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Integer}. 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String MAX_LINE_LENGTH = "http.connection.max-line-length"; 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Determines the maximum HTTP header count allowed. If set to a positive value, 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the number of HTTP headers received from the data stream exceeding this limit 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * will cause an IOException. A negative or zero value will effectively disable 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the check. 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <p> 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This parameter expects a value of type {@link Integer}. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * </p> 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static final String MAX_HEADER_COUNT = "http.connection.max-header-count"; 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 132