Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-25 15:52:06 +01:00
Code Issues Releases Wiki Activity

Improve PingManager javadoc

Browse source
This commit is contained in:
Florian Schmaus 2014-12-26 21:29:46 +01:00
parent b17ecb4555
commit 2b664ee88b
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java
View file

@ -51,8 +51,12 @@ import org.jivesoftware.smackx.ping.packet.Ping;
/** /**
* Implements the XMPP Ping as defined by XEP-0199. The XMPP Ping protocol allows one entity to * Implements the XMPP Ping as defined by XEP-0199. The XMPP Ping protocol allows one entity to
* ping any other entity by simply sending a ping to the appropriate JID. PingManger also * ping any other entity by simply sending a ping to the appropriate JID. PingManger also
* periodically sends XMPP pings to the server every 30 minutes to avoid NAT timeouts and to test * periodically sends XMPP pings to the server to avoid NAT timeouts and to test
* the connection status. * the connection status.
* <p>
* The default server ping interval is 30 minutes and can be modified with
* {@link #setDefaultPingInterval(int)} and {@link #setPingInterval(int)}.
* </p>
* *
* @author Florian Schmaus * @author Florian Schmaus
* @see <a href="http://www.xmpp.org/extensions/xep-0199.html">XEP-0199:XMPP Ping</a> * @see <a href="http://www.xmpp.org/extensions/xep-0199.html">XEP-0199:XMPP Ping</a>
@ -90,6 +94,9 @@ public class PingManager extends Manager {
return pingManager; return pingManager;
} }
/**
* The default ping interval in seconds used by new PingManager instances. The default is 30 minutes.
*/
private static int defaultPingInterval = 60 * 30; private static int defaultPingInterval = 60 * 30;
/** /**