PingManager (Babbler 0.5.1)

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.
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

Methods
Modifier and Type	Method and Description
`long`	`getPingInterval()` Gets the ping interval in seconds.
`boolean`	`ping(Jid jid)` Pings the given XMPP entity.
`boolean`	`ping(Jid jid, long timeout)` Pings the given XMPP entity.
`boolean`	`pingServer()` Pings the connected server.
`void`	`setEnabled(boolean enabled)` Enables or disables support for the extension.
`void`	`setPingInterval(long pingInterval)` Sets the automatic ping interval in seconds.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager
isEnabled

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - ping
```
public final boolean ping(Jid jid)
```
    Pings the given XMPP entity.
    
    Parameters:
    jid - The JID to ping.
    
    Returns:
    True if a response has been received within the timeout and the recipient is available, false otherwise.
  - ping
```
public final boolean ping(Jid jid,
           long timeout)
```
    Pings the given XMPP entity.
    
    Parameters:
    jid - The JID to ping.
    timeout - The timeout in milliseconds.
    
    Returns:
    True if a response has been received within the timeout and the recipient is available, false otherwise.
  - pingServer
```
public final boolean pingServer()
```
    Pings the connected server.
    
    Returns:
    True if a response has been received, false otherwise.
  - getPingInterval
```
public final 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 final 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 final void setEnabled(boolean enabled)
```
    Description copied from class: ExtensionManager
    
    Enables or disables support for the extension.
    
    Overrides:
    
    setEnabled in class ExtensionManager
    
    Parameters:
    enabled - True, if support for the managed extension should be enabled; otherwise false.
    See Also:
    ExtensionManager.isEnabled()

Class PingManager

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

ping

ping

pingServer

getPingInterval

setPingInterval

setEnabled