diff options
Diffstat (limited to 'mobile/android/thirdparty/ch/boye/httpclientandroidlib/params/HttpConnectionParams.java')
-rw-r--r-- | mobile/android/thirdparty/ch/boye/httpclientandroidlib/params/HttpConnectionParams.java | 243 |
1 files changed, 243 insertions, 0 deletions
diff --git a/mobile/android/thirdparty/ch/boye/httpclientandroidlib/params/HttpConnectionParams.java b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/params/HttpConnectionParams.java new file mode 100644 index 000000000..2efae2c37 --- /dev/null +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/params/HttpConnectionParams.java @@ -0,0 +1,243 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ + +package ch.boye.httpclientandroidlib.params; + +import ch.boye.httpclientandroidlib.util.Args; + +/** + * Utility class for accessing connection parameters in {@link HttpParams}. + * + * @since 4.0 + * + * @deprecated (4.3) use configuration classes provided 'ch.boye.httpclientandroidlib.config' + * and 'ch.boye.httpclientandroidlib.client.config' + */ +@Deprecated +public final class HttpConnectionParams implements CoreConnectionPNames { + + private HttpConnectionParams() { + super(); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#SO_TIMEOUT} parameter. + * If not set, defaults to <code>0</code>. + * + * @param params HTTP parameters. + * @return SO_TIMEOUT. + */ + public static int getSoTimeout(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getIntParameter(CoreConnectionPNames.SO_TIMEOUT, 0); + } + + /** + * Sets value of the {@link CoreConnectionPNames#SO_TIMEOUT} parameter. + * + * @param params HTTP parameters. + * @param timeout SO_TIMEOUT. + */ + public static void setSoTimeout(final HttpParams params, final int timeout) { + Args.notNull(params, "HTTP parameters"); + params.setIntParameter(CoreConnectionPNames.SO_TIMEOUT, timeout); + + } + + /** + * Obtains value of the {@link CoreConnectionPNames#SO_REUSEADDR} parameter. + * If not set, defaults to <code>false</code>. + * + * @param params HTTP parameters. + * @return SO_REUSEADDR. + * + * @since 4.1 + */ + public static boolean getSoReuseaddr(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getBooleanParameter(CoreConnectionPNames.SO_REUSEADDR, false); + } + + /** + * Sets value of the {@link CoreConnectionPNames#SO_REUSEADDR} parameter. + * + * @param params HTTP parameters. + * @param reuseaddr SO_REUSEADDR. + * + * @since 4.1 + */ + public static void setSoReuseaddr(final HttpParams params, final boolean reuseaddr) { + Args.notNull(params, "HTTP parameters"); + params.setBooleanParameter(CoreConnectionPNames.SO_REUSEADDR, reuseaddr); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#TCP_NODELAY} parameter. + * If not set, defaults to <code>true</code>. + * + * @param params HTTP parameters. + * @return Nagle's algorithm flag + */ + public static boolean getTcpNoDelay(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getBooleanParameter(CoreConnectionPNames.TCP_NODELAY, true); + } + + /** + * Sets value of the {@link CoreConnectionPNames#TCP_NODELAY} parameter. + * + * @param params HTTP parameters. + * @param value Nagle's algorithm flag + */ + public static void setTcpNoDelay(final HttpParams params, final boolean value) { + Args.notNull(params, "HTTP parameters"); + params.setBooleanParameter(CoreConnectionPNames.TCP_NODELAY, value); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#SOCKET_BUFFER_SIZE} + * parameter. If not set, defaults to <code>-1</code>. + * + * @param params HTTP parameters. + * @return socket buffer size + */ + public static int getSocketBufferSize(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getIntParameter(CoreConnectionPNames.SOCKET_BUFFER_SIZE, -1); + } + + /** + * Sets value of the {@link CoreConnectionPNames#SOCKET_BUFFER_SIZE} + * parameter. + * + * @param params HTTP parameters. + * @param size socket buffer size + */ + public static void setSocketBufferSize(final HttpParams params, final int size) { + Args.notNull(params, "HTTP parameters"); + params.setIntParameter(CoreConnectionPNames.SOCKET_BUFFER_SIZE, size); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#SO_LINGER} parameter. + * If not set, defaults to <code>-1</code>. + * + * @param params HTTP parameters. + * @return SO_LINGER. + */ + public static int getLinger(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getIntParameter(CoreConnectionPNames.SO_LINGER, -1); + } + + /** + * Sets value of the {@link CoreConnectionPNames#SO_LINGER} parameter. + * + * @param params HTTP parameters. + * @param value SO_LINGER. + */ + public static void setLinger(final HttpParams params, final int value) { + Args.notNull(params, "HTTP parameters"); + params.setIntParameter(CoreConnectionPNames.SO_LINGER, value); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#CONNECTION_TIMEOUT} + * parameter. If not set, defaults to <code>0</code>. + * + * @param params HTTP parameters. + * @return connect timeout. + */ + public static int getConnectionTimeout(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getIntParameter(CoreConnectionPNames.CONNECTION_TIMEOUT, 0); + } + + /** + * Sets value of the {@link CoreConnectionPNames#CONNECTION_TIMEOUT} + * parameter. + * + * @param params HTTP parameters. + * @param timeout connect timeout. + */ + public static void setConnectionTimeout(final HttpParams params, final int timeout) { + Args.notNull(params, "HTTP parameters"); + params.setIntParameter(CoreConnectionPNames.CONNECTION_TIMEOUT, timeout); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#STALE_CONNECTION_CHECK} + * parameter. If not set, defaults to <code>true</code>. + * + * @param params HTTP parameters. + * @return stale connection check flag. + */ + public static boolean isStaleCheckingEnabled(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getBooleanParameter(CoreConnectionPNames.STALE_CONNECTION_CHECK, true); + } + + /** + * Sets value of the {@link CoreConnectionPNames#STALE_CONNECTION_CHECK} + * parameter. + * + * @param params HTTP parameters. + * @param value stale connection check flag. + */ + public static void setStaleCheckingEnabled(final HttpParams params, final boolean value) { + Args.notNull(params, "HTTP parameters"); + params.setBooleanParameter(CoreConnectionPNames.STALE_CONNECTION_CHECK, value); + } + + /** + * Obtains value of the {@link CoreConnectionPNames#SO_KEEPALIVE} parameter. + * If not set, defaults to <code>false</code>. + * + * @param params HTTP parameters. + * @return SO_KEEPALIVE. + * + * @since 4.2 + */ + public static boolean getSoKeepalive(final HttpParams params) { + Args.notNull(params, "HTTP parameters"); + return params.getBooleanParameter(CoreConnectionPNames.SO_KEEPALIVE, false); + } + + /** + * Sets value of the {@link CoreConnectionPNames#SO_KEEPALIVE} parameter. + * + * @param params HTTP parameters. + * @param enableKeepalive SO_KEEPALIVE. + * + * @since 4.2 + */ + public static void setSoKeepalive(final HttpParams params, final boolean enableKeepalive) { + Args.notNull(params, "HTTP parameters"); + params.setBooleanParameter(CoreConnectionPNames.SO_KEEPALIVE, enableKeepalive); + } + +} |