* Use {@link #isPingSupported(String)} to determine if XMPP Ping is supported
* by the entity.
*
* @param jid The id of the entity the ping is being sent to
* @param pingTimeout The time to wait for a reply
* @return true if a reply was received from the entity, false otherwise.
*/
public boolean ping(String jid, long pingTimeout) {
Ping ping = new Ping(jid);
try {
connection().createPacketCollectorAndSend(ping).nextResultOrThrow();
}
catch (XMPPException exc) {
return (jid.equals(connection().getServiceName()) && (exc.getSmackError() != SmackError.NO_RESPONSE_FROM_SERVER));
}
return true;
}
/**
* Same as calling {@link #ping(String, long)} with the defaultpacket reply
* timeout.
*
* @param jid The id of the entity the ping is being sent to
* @return true if a reply was received from the entity, false otherwise.
*/
public boolean ping(String jid) {
return ping(jid, connection().getPacketReplyTimeout());
}
/**
* Query the specified entity to see if it supports the Ping protocol (XEP-0199)
*
* @param jid The id of the entity the query is being sent to
* @return true if it supports ping, false otherwise.
* @throws XMPPException An XMPP related error occurred during the request
*/
public boolean isPingSupported(String jid) throws XMPPException {
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, PingManager.NAMESPACE);
}
/**
* 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 {@link #ping(String)} case, this method will return true even if
* {@link #isPingSupported(String)} is false.
*
* @return true if a reply was received from the server, false otherwise.
*/
public boolean pingMyServer() {
return pingMyServer(true);
}
/**
* 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 {@link #ping(String)} case, this method will return true even if * {@link #isPingSupported(String)} is false. * * @param notifyListeners Notify the PingFailedListener in case of error if true * @return */ public boolean pingMyServer(boolean notifyListeners) { boolean res = ping(connection().getServiceName()); if (res) { pongReceived(); } else if (notifyListeners) { for (PingFailedListener l : pingFailedListeners) l.pingFailed(); } return res; } /** * Set the interval between the server is automatic pinged. A negative value disables automatic server pings. * * @param pingInterval the interval between the ping */ public void setPingInterval(int pingInterval) { this.pingInterval = pingInterval; maybeSchedulePingServerTask(); } /** * Get the current ping interval. * * @return the interval between pings in seconds */ public int getPingInterval() { return pingInterval; } /** * Register a new PingFailedListener * * @param listener the listener to invoke */ public void registerPingFailedListener(PingFailedListener listener) { pingFailedListeners.add(listener); } /** * Unregister a PingFailedListener * * @param listener the listener to remove */ public void unregisterPingFailedListener(PingFailedListener listener) { pingFailedListeners.remove(listener); } /** * Returns the time of the last successful Ping with the * users server. If there was no successful Ping (e.g. because this * feature is disabled) -1 will be returned. * * @return */ public long getLastSuccessfulPing() { return Math.max(lastSuccessfulAutomaticPing, lastSuccessfulManualPing); } /** * Cancels any existing periodic ping task if there is one and schedules a new ping task if * pingInterval is greater then zero. */ private synchronized void maybeSchedulePingServerTask() { maybeStopPingServerTask(); if (pingInterval > 0) { LOGGER.fine("Scheduling ServerPingTask in " + pingInterval + " seconds"); nextAutomaticPing = connection().schedule(pingServerRunnable, pingInterval, TimeUnit.SECONDS); } } private void maybeStopPingServerTask() { if (nextAutomaticPing != null) { nextAutomaticPing.cancel(true); nextAutomaticPing = null; } } private void pongReceived() { lastSuccessfulManualPing = System.currentTimeMillis(); } private final Runnable pingServerRunnable = new Runnable() { private static final int DELTA = 1000; // 1 seconds private static final int TRIES = 3; // 3 tries public void run() { LOGGER.fine("ServerPingTask run()"); XMPPConnection connection = connection(); if (connection == null) { // connection has been collected by GC // which means we can stop the thread by breaking the loop return; } if (connection.isAuthenticated()) { boolean res = false; for (int i = 0; i < TRIES; i++) { if (i != 0) { try { Thread.sleep(DELTA); } catch (InterruptedException e) { // We received an interrupt // This only happens if we should stop pinging return; } } res = pingMyServer(false); // stop when we receive a pong back if (res) { lastSuccessfulAutomaticPing = System.currentTimeMillis(); break; } } LOGGER.fine("ServerPingTask res=" + res); if (!res) { for (PingFailedListener l : pingFailedListeners) { l.pingFailed(); } } else { // Ping was successful, wind-up the periodic task again maybeSchedulePingServerTask(); } } else { LOGGER.warning("ServerPingTask: XMPPConnection was not authenticated"); } } }; }