Package org.jivesoftware.smack.tcp

Class XMPPTCPConnectionConfiguration

java.lang.Object

org.jivesoftware.smack.ConnectionConfiguration

org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration

public final class XMPPTCPConnectionConfiguration
extends 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 = XMPPTCPConnectionConfiguration.builder()
     .setXmppDomain("example.org").setUsernameAndPassword("user", "password")
     .setCompressionEnabled(false).build();
 XMPPTCPConnection connection = new XMPPTCPConnection(conf);
 
 

Nested Class Summary

Nested Classes

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

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

ConnectionConfiguration.DnssecMode, ConnectionConfiguration.SecurityMode

Field Summary

Fields

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

Fields inherited from class org.jivesoftware.smack.ConnectionConfiguration

allowNullOrEmptyUsername, host, hostAddress, port, proxy, xmppServiceDomain, xmppServiceDomainDnsName

Method Summary

Modifier and Type	Method	Description
static XMPPTCPConnectionConfiguration.Builder	builder()
int	getConnectTimeout()	How long the socket will wait until a TCP connection is established (in milliseconds).

Methods inherited from class org.jivesoftware.smack.ConnectionConfiguration

getAuthzid, getCallbackHandler, getDebuggerFactory, getDnssecMode, getEnabledSaslMechanisms, getEnabledSSLCiphers, getEnabledSSLProtocols, getHost, getHostAddress, getHostnameVerifier, getHostString, getLanguage, getPassword, getPort, getProxyInfo, getResource, getSecurityMode, getServiceName, getSocketFactory, getUsername, getXmlLang, getXMPPServiceDomain, getXmppServiceDomainAsDnsNameIfPossible, isCompressionEnabled, isEnabledSaslMechanism, isSendPresence

Methods inherited from class java.lang.Object

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

Field Details

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 Details

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()