org.jivesoftware.smack.tcp

Class XMPPTCPConnectionConfiguration.Builder

java.lang.Object

org.jivesoftware.smack.ConnectionConfiguration.Builder<XMPPTCPConnectionConfiguration.Builder,XMPPTCPConnectionConfiguration>

org.jivesoftware.smack.tcp.XMPPTCPConnectionConfiguration.Builder

Enclosing class:

XMPPTCPConnectionConfiguration

public static class XMPPTCPConnectionConfiguration.Builder
extends ConnectionConfiguration.Builder<XMPPTCPConnectionConfiguration.Builder,XMPPTCPConnectionConfiguration>

A configuration builder for XMPP connections over TCP. Use XMPPTCPConnectionConfiguration.builder() to obtain a new instance and build() to build the configuration.

Method Summary

Modifier and Type	Method and Description
XMPPTCPConnectionConfiguration	build()
protected XMPPTCPConnectionConfiguration.Builder	getThis()
XMPPTCPConnectionConfiguration.Builder	setCompressionEnabled(boolean compressionEnabled) Sets if the connection is going to use stream compression.
XMPPTCPConnectionConfiguration.Builder	setConnectTimeout(int connectTimeout) Set how long the socket will wait until a TCP connection is established (in milliseconds).

Methods inherited from class org.jivesoftware.smack.ConnectionConfiguration.Builder

allowEmptyOrNullUsernames, setCallbackHandler, setCustomSSLContext, setDebuggerEnabled, setEnabledSSLCiphers, setEnabledSSLProtocols, setHost, setHostnameVerifier, setKeystorePath, setKeystoreType, setLegacySessionDisabled, setPKCS11Library, setPort, setProxyInfo, setResource, setSecurityMode, setSendPresence, setServiceName, setSocketFactory, setUsernameAndPassword

Methods inherited from class java.lang.Object

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

Method Detail

setCompressionEnabled

public XMPPTCPConnectionConfiguration.Builder setCompressionEnabled(boolean compressionEnabled)

Sets 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.

Parameters:

compressionEnabled - if the connection is going to use stream compression.

Returns:

a reference to this object.

setConnectTimeout

public XMPPTCPConnectionConfiguration.Builder setConnectTimeout(int connectTimeout)

Set how long the socket will wait until a TCP connection is established (in milliseconds).

Parameters:

connectTimeout - the timeout value to be used in milliseconds.

Returns:

a reference to this object.

getThis

protected XMPPTCPConnectionConfiguration.Builder getThis()

Specified by:

getThis in class ConnectionConfiguration.Builder<XMPPTCPConnectionConfiguration.Builder,XMPPTCPConnectionConfiguration>

build

public XMPPTCPConnectionConfiguration build()

Specified by:

build in class ConnectionConfiguration.Builder<XMPPTCPConnectionConfiguration.Builder,XMPPTCPConnectionConfiguration>