vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-24 21:12:05 +01:00
Code Issues Releases Wiki Activity

Add javadoc to XMPPTCPConnectionConfiguration

Browse source
This commit is contained in:
Florian Schmaus 2015-01-17 10:34:37 +01:00
parent d5fb5e1d01
commit 2ea469be10
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
smack-tcp/src/main/java/org/jivesoftware/smack/tcp/XMPPTCPConnectionConfiguration.java
View file

@ -18,6 +18,21 @@ package org.jivesoftware.smack.tcp;
import org.jivesoftware.smack.ConnectionConfiguration; import org.jivesoftware.smack.ConnectionConfiguration;
/**
* A connection configuration for XMPP connections over TCP (the common case).
* <p>
* You can get an instance of the configuration builder with {@link #builder()} and build the final immutable connection
* configuration with {@link Builder#build()}.
* </p>
* <pre>
* {@code
* XMPPTCPConnectionConfiguration conf = XMPPConnectionConfiguration.builder()
* .setServiceName("example.org").setUsernameAndPassword("user", "password")
* .setCompressionEnabled(false).build();
* XMPPTCPConnection connection = new XMPPTCPConnection(conf);
* }
* </pre>
*/
public class XMPPTCPConnectionConfiguration extends ConnectionConfiguration { public class XMPPTCPConnectionConfiguration extends ConnectionConfiguration {
/** /**
@ -65,6 +80,10 @@ public class XMPPTCPConnectionConfiguration extends ConnectionConfiguration {
return new 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 class Builder extends ConnectionConfiguration.Builder<Builder, XMPPTCPConnectionConfiguration> { public static class Builder extends ConnectionConfiguration.Builder<Builder, XMPPTCPConnectionConfiguration> {
private boolean compressionEnabled = false; private boolean compressionEnabled = false;
private int connectTimeout = DEFAULT_CONNECT_TIMEOUT; private int connectTimeout = DEFAULT_CONNECT_TIMEOUT;