rocks.xmpp.extensions.ping

Class PingManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.ping.PingManager

public final class PingManager
extends ExtensionManager

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

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

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

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

features, xmppSession

Method Summary

Modifier and Type	Method and Description
long	getPingInterval() Gets the ping interval in seconds.
void	ping(rocks.xmpp.core.Jid jid) Pings the given XMPP entity.
void	pingServer() Pings the connected server.
void	setEnabled(boolean enabled)
void	setPingInterval(long pingInterval) Sets the automatic ping interval in seconds.

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

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

ping

public void ping(rocks.xmpp.core.Jid jid)
          throws rocks.xmpp.core.XmppException

Pings the given XMPP entity.

Parameters:

jid - The JID to ping.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

pingServer

public void pingServer()
                throws rocks.xmpp.core.XmppException

Pings the connected server.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

getPingInterval

public long getPingInterval()

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

Returns:

The ping interval in seconds.

See Also:

setPingInterval(long)

setPingInterval

public void setPingInterval(long pingInterval)

Sets the automatic ping interval in seconds. 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()

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class ExtensionManager