org.jivesoftware.smack.tcp

Class XMPPTCPConnectionConfiguration

java.lang.Object

org.jivesoftware.smack.ConnectionConfiguration

org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration

public class XMPPTCPConnectionConfiguration
extends 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 builder() and build the final immutable connection configuration with XMPPTCPConnectionConfiguration.Builder.build().

 
 XMPPTCPConnectionConfiguration conf = XMPPConnectionConfiguration.builder()
     .setServiceName("example.org").setUsernameAndPassword("user", "password")
     .setCompressionEnabled(false).build();
 XMPPTCPConnection connection = new XMPPTCPConnection(conf);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMPPTCPConnectionConfiguration.Builder A configuration builder for XMPP connections over TCP.

Nested classes/interfaces inherited from class org.jivesoftware.smack.ConnectionConfiguration

org.jivesoftware.smack.ConnectionConfiguration.SecurityMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT The default connect timeout in milliseconds.

Fields inherited from class org.jivesoftware.smack.ConnectionConfiguration

allowNullOrEmptyUsername, host, port, proxy, serviceName

Method Summary

Modifier and Type	Method and Description
static XMPPTCPConnectionConfiguration.Builder	builder()
int	getConnectTimeout() How long the socket will wait until a TCP connection is established (in milliseconds).
boolean	isCompressionEnabled() Returns true if the connection is going to use stream compression.

Methods inherited from class org.jivesoftware.smack.ConnectionConfiguration

getCallbackHandler, getCustomSSLContext, getEnabledSSLCiphers, getEnabledSSLProtocols, getHostnameVerifier, getKeystorePath, getKeystoreType, getPassword, getPKCS11Library, getResource, getSecurityMode, getServiceName, getSocketFactory, getUsername, isDebuggerEnabled, isLegacySessionDisabled, isSendPresence

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONNECT_TIMEOUT

public static int DEFAULT_CONNECT_TIMEOUT

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.

Method Detail

isCompressionEnabled

public boolean isCompressionEnabled()

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.

Overrides:

isCompressionEnabled in class org.jivesoftware.smack.ConnectionConfiguration

Returns:

true if the connection is going to use stream compression.

getConnectTimeout

public int getConnectTimeout()

How long the socket will wait until a TCP connection is established (in milliseconds). Defaults to DEFAULT_CONNECT_TIMEOUT.

Returns:

the timeout value in milliseconds.

builder

public static XMPPTCPConnectionConfiguration.Builder builder()