/** * * Copyright 2014 Florian Schmaus * * Licensed 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. */ package org.jivesoftware.smack.tcp; import org.jivesoftware.smack.ConnectionConfiguration; /** * A connection configuration for XMPP connections over TCP (the common case). *
* You can get an instance of the configuration builder with {@link #builder()} and build the final immutable connection * configuration with {@link Builder#build()}. *
** {@code * XMPPTCPConnectionConfiguration conf = XMPPConnectionConfiguration.builder() * .setXmppDomain("example.org").setUsernameAndPassword("user", "password") * .setCompressionEnabled(false).build(); * XMPPTCPConnection connection = new XMPPTCPConnection(conf); * } **/ public final class XMPPTCPConnectionConfiguration extends ConnectionConfiguration { /** * The default connect timeout in milliseconds. Preinitialized with 30000 (30 seconds). If this value is changed, * new Builder instances will use the new value as default. */ public static int DEFAULT_CONNECT_TIMEOUT = 30000; private final boolean compressionEnabled; /** * How long the socket will wait until a TCP connection is established (in milliseconds). */ private final int connectTimeout; private XMPPTCPConnectionConfiguration(Builder builder) { super(builder); compressionEnabled = builder.compressionEnabled; connectTimeout = builder.connectTimeout; } /** * Returns true if the connection is going to use stream compression. Stream compression * will be requested after TLS was established (if TLS was enabled) and only if the server * offered stream compression. With stream compression network traffic can be reduced * up to 90%. By default compression is disabled. * * @return true if the connection is going to use stream compression. */ @Override public boolean isCompressionEnabled() { return compressionEnabled; } /** * How long the socket will wait until a TCP connection is established (in milliseconds). Defaults to {@link #DEFAULT_CONNECT_TIMEOUT}. * * @return the timeout value in milliseconds. */ public int getConnectTimeout() { return connectTimeout; } public static Builder builder() { return new Builder(); } /** * A configuration builder for XMPP connections over TCP. Use {@link XMPPTCPConnectionConfiguration#builder()} to * obtain a new instance and {@link #build} to build the configuration. */ public static final class Builder extends ConnectionConfiguration.Builder