rocks.xmpp.core.session

Class TcpConnectionConfiguration

java.lang.Object

rocks.xmpp.core.session.ConnectionConfiguration

rocks.xmpp.core.session.TcpConnectionConfiguration

public final class TcpConnectionConfiguration
extends ConnectionConfiguration

A configuration for a TCP connection. It allows you to configure various connection settings for a TCP socket connection, most importantly the host address and port, but also a whitespace keep-alive interval, a custom socket factory, a custom SSL context and compression methods.

Usage

In order to create an instance of this class you have to use the builder pattern as shown below.

 
 TcpConnectionConfiguration tcpConfiguration = TcpConnectionConfiguration.builder()
     .hostname("localhost")
     .port(5222)
     .sslContext(sslContext)
     .secure(false)
     .build();
 
 

This class is immutable.

See Also:

BoshConnectionConfiguration, TcpConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpConnectionConfiguration.Builder A builder to create a TcpConnectionConfiguration instance.

Method Summary

Modifier and Type	Method and Description
static TcpConnectionConfiguration.Builder	builder() Creates a new builder for this class.
Connection	createConnection(XmppSession xmppSession) A factory method to create the connection.
static TcpConnectionConfiguration	getDefault() Gets the default configuration.
int	getKeepAliveInterval() Gets the whitespace keep-alive interval.
SocketFactory	getSocketFactory() Gets the socket factory.
static void	setDefault(TcpConnectionConfiguration configuration) Sets the default configuration.
String	toString()

Methods inherited from class rocks.xmpp.core.session.ConnectionConfiguration

getCompressionMethods, getConnectTimeout, getHostname, getHostnameVerifier, getPort, getProxy, getSSLContext, isSecure

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static TcpConnectionConfiguration.Builder builder()

Creates a new builder for this class.

Returns:

The builder.

getDefault

public static TcpConnectionConfiguration getDefault()

Gets the default configuration.

Returns:

The default configuration.

setDefault

public static void setDefault(TcpConnectionConfiguration configuration)

Sets the default configuration.

Parameters:

configuration - The default configuration.

createConnection

public final Connection createConnection(XmppSession xmppSession)

Description copied from class: ConnectionConfiguration

A factory method to create the connection.

Specified by:

createConnection in class ConnectionConfiguration

Parameters:

xmppSession - The XMPP session, which is associated with the connection.

Returns:

The connection.

getKeepAliveInterval

public final int getKeepAliveInterval()

Gets the whitespace keep-alive interval.

Returns:

The whitespace keep-alive interval.

getSocketFactory

public final SocketFactory getSocketFactory()

Gets the socket factory.

Returns:

The socket factory.

toString

public final String toString()

Overrides:

toString in class ConnectionConfiguration