org.jivesoftware.smackx.ping

Class PingManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.ping.PingManager

public class PingManager
extends Manager

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 periodically sends XMPP pings to the server every 30 minutes to avoid NAT timeouts and to test the connection status.

See Also:

XEP-0199:XMPP Ping

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Method Summary

Methods

Modifier and Type	Method and Description
static PingManager	getInstanceFor(XMPPConnection connection) Retrieves a PingManager for the specified XMPPConnection, creating one if it doesn't already exist.
long	getLastReceivedPong() Returns the timestamp when the last XMPP Pong was received.
int	getPingInterval() Get the current ping interval.
boolean	isPingSupported(String jid) Query the specified entity to see if it supports the Ping protocol (XEP-0199)
boolean	ping(String jid) Same as calling ping(String, long) with the defaultpacket reply timeout.
boolean	ping(String jid, long pingTimeout) Pings the given jid.
boolean	pingMyServer() Pings the server.
boolean	pingMyServer(boolean notifyListeners) Pings the server.
void	registerPingFailedListener(PingFailedListener listener) Register a new PingFailedListener
static void	setDefaultPingInterval(int interval) Set the default ping interval which will be used for new connections.
void	setPingInterval(int pingInterval) Set the interval between the server is automatic pinged.
void	unregisterPingFailedListener(PingFailedListener listener) Unregister a PingFailedListener

Methods inherited from class org.jivesoftware.smack.Manager

connection, schedule

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Method Detail

getInstanceFor

public static PingManager getInstanceFor(XMPPConnection connection)

Retrieves a PingManager for the specified XMPPConnection, creating one if it doesn't already exist.

Parameters:

connection - The connection the manager is attached to.

Returns:

The new or existing manager.

setDefaultPingInterval

public static void setDefaultPingInterval(int interval)

Set the default ping interval which will be used for new connections.

Parameters:

interval - the interval in seconds

ping

public boolean ping(String jid,
           long pingTimeout)
             throws SmackException.NotConnectedException,
                    SmackException.NoResponseException

Pings the given jid. This method will return false if an error occurs. The exception to this, is a server ping, which will always return true if the server is reachable, event if there is an error on the ping itself (i.e. ping not supported).

Use isPingSupported(String) to determine if XMPP Ping is supported by the entity.

Parameters:

jid - The id of the entity the ping is being sent to

pingTimeout - The time to wait for a reply

Returns:

true if a reply was received from the entity, false otherwise.

Throws:

SmackException.NoResponseException - if there was no response from the jid.

SmackException.NotConnectedException

ping

public boolean ping(String jid)
             throws SmackException.NotConnectedException,
                    SmackException.NoResponseException

Same as calling ping(String, long) with the defaultpacket reply timeout.

Parameters:

jid - The id of the entity the ping is being sent to

Returns:

true if a reply was received from the entity, false otherwise.

Throws:

SmackException.NotConnectedException

SmackException.NoResponseException - if there was no response from the jid.

isPingSupported

public boolean isPingSupported(String jid)
                        throws SmackException.NoResponseException,
                               XMPPException.XMPPErrorException,
                               SmackException.NotConnectedException

Query the specified entity to see if it supports the Ping protocol (XEP-0199)

Parameters:

jid - The id of the entity the query is being sent to

Returns:

true if it supports ping, false otherwise.

Throws:

XMPPException.XMPPErrorException - An XMPP related error occurred during the request

SmackException.NoResponseException - if there was no response from the jid.

SmackException.NotConnectedException

pingMyServer

public boolean pingMyServer()
                     throws SmackException.NotConnectedException

Pings the server. This method will return true if the server is reachable. It is the equivalent of calling ping with the XMPP domain.

Unlike the ping(String) case, this method will return true even if isPingSupported(String) is false.

Returns:

true if a reply was received from the server, false otherwise.

Throws:

SmackException.NotConnectedException

pingMyServer

public boolean pingMyServer(boolean notifyListeners)
                     throws SmackException.NotConnectedException

Pings the server. This method will return true if the server is reachable. It is the equivalent of calling ping with the XMPP domain.

Unlike the ping(String) case, this method will return true even if isPingSupported(String) is false.

Parameters:

notifyListeners - Notify the PingFailedListener in case of error if true

Returns:

true if the user's server could be pinged.

Throws:

SmackException.NotConnectedException

setPingInterval

public void setPingInterval(int pingInterval)

Set the interval between the server is automatic pinged. A negative value disables automatic server pings.

Parameters:

pingInterval - the interval between the ping

getPingInterval

public int getPingInterval()

Get the current ping interval.

Returns:

the interval between pings in seconds

registerPingFailedListener

public void registerPingFailedListener(PingFailedListener listener)

Register a new PingFailedListener

Parameters:

listener - the listener to invoke

unregisterPingFailedListener

public void unregisterPingFailedListener(PingFailedListener listener)

Unregister a PingFailedListener

Parameters:

listener - the listener to remove

getLastReceivedPong

public long getLastReceivedPong()

Returns the timestamp when the last XMPP Pong was received.

Returns:

the timestamp of the last XMPP Pong