rocks.xmpp.extensions.ping

Class PingManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.extensions.ping.PingManager

public final class PingManager
extends Manager

This class implements the application-level ping mechanism as specified in XEP-0199: XMPP Ping.

If enabled, it periodically pings the server to ensure a stable connection. These pings are not sent as long as other stanzas are sent, because they serve the same purpose (telling the server, that we are still available).

For Server-To-Client Pings it automatically responds with a result (pong), if enabled.

It also allows to ping the server manually (Client-To-Server Pings) or to ping other XMPP entities (Client-to-Client Pings).

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getPingInterval() Gets the ping interval.
AsyncResult<java.lang.Boolean>	ping(Jid jid) Pings the given XMPP entity.
AsyncResult<java.lang.Boolean>	pingServer() Pings the connected server.
void	setPingInterval(java.time.Duration pingInterval) Sets the automatic ping interval.

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

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Method Detail

ping

public final AsyncResult<java.lang.Boolean> ping(Jid jid)

Pings the given XMPP entity.

Parameters:

jid - The JID to ping.

Returns:

The async result with true if a response has been received within the timeout and the recipient is available, false otherwise.

pingServer

public final AsyncResult<java.lang.Boolean> pingServer()

Pings the connected server.

Returns:

The async result with true if a response has been received, false otherwise.

getPingInterval

public final java.time.Duration getPingInterval()

Gets the ping interval. The default ping interval is 900 seconds (15 minutes).

Returns:

The ping interval in seconds.

See Also:

setPingInterval(Duration)

setPingInterval

public final void setPingInterval(java.time.Duration pingInterval)

Sets the automatic ping interval. Any scheduled future ping is canceled and a new ping is scheduled after the specified interval.

Parameters:

pingInterval - The ping interval in seconds.

See Also:

getPingInterval()