org.opennms.netmgt.ping
Class Pinger

java.lang.Object
  org.opennms.netmgt.ping.Pinger

public class Pinger
extends Object

Author:

Ben Reed, Mathew Brozowski

Field Summary

static int	DEFAULT_RETRIES
static int	DEFAULT_TIMEOUT

Constructor Summary

Pinger()
Constructs a Pinger object.

Method Summary

static void	initialize() Initializes this singleton
static List<Number>	parallelPing(InetAddress host, int count, long timeout, long pingInterval)
static Long	ping(InetAddress host) Ping a remote host, using the default number of retries and timeouts.
static Long	ping(InetAddress host, long timeout, int retries) This method is used to ping a remote host to test for ICMP support.
static void	ping(InetAddress host, long timeout, int retries, short sequenceId, PingResponseCallback cb)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_RETRIES

public static final int DEFAULT_RETRIES

See Also:

Constant Field Values

Constructor Detail

Pinger

public Pinger()
       throws IOException

Constructs a Pinger object.

Throws:

IOException

Method Detail

initialize

public static void initialize()
                       throws IOException

Initializes this singleton

Throws:

IOException

ping

public static void ping(InetAddress host,
                        long timeout,
                        int retries,
                        short sequenceId,
                        PingResponseCallback cb)
                 throws IOException

Throws:

IOException

ping

public static Long ping(InetAddress host,
                        long timeout,
                        int retries)
                 throws InterruptedException,
                        IOException

This method is used to ping a remote host to test for ICMP support. If the remote host responds within the specified period, defined by retries and timeouts, then the response time is returned.

Parameters:

host - The address to poll.

timeout - The time to wait between each retry.

retries - The number of times to retry

Returns:

The response time in microseconds if the host is reachable and has responded with an echo reply, otherwise a null value.

Throws:

InterruptedException

IOException

ping

public static Long ping(InetAddress host)
                 throws IOException,
                        InterruptedException

Ping a remote host, using the default number of retries and timeouts.

Parameters:

host - the host to ping

Returns:

the round-trip time of the packet

Throws:

IOException

InterruptedException

parallelPing

public static List<Number> parallelPing(InetAddress host,
                                        int count,
                                        long timeout,
                                        long pingInterval)
                                 throws IOException,
                                        InterruptedException

Throws:

IOException

InterruptedException