org.opennms.sms.ping

Class SmsPinger

java.lang.Object

org.opennms.sms.ping.SmsPinger

public class SmsPinger
extends Object

SmsPinger class.

Version:

$Id: $

Author:

Ben Reed, Mathew Brozowski, Ben Reed, Mathew Brozowski

Constructor Summary

Constructors

Constructor and Description
SmsPinger()

Method Summary

Methods

Modifier and Type	Method and Description
static void	initialize() Initializes this singleton
static Long	ping(String host) Ping a remote host, using the default number of retries and timeouts.
static Long	ping(String phoneNumber, long timeout, int retries) This method is used to ping a remote host to test for ICMP support.
static void	ping(String phoneNumber, long timeout, int retries, PingResponseCallback cb) ping
static void	setSmsPingTracker(SmsPingTracker pingTracker) setSmsPingTracker

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsPinger

public SmsPinger()

Method Detail

initialize

public static void initialize()
                       throws IOException

Initializes this singleton

Throws:

IOException - if any.

setSmsPingTracker

public static void setSmsPingTracker(SmsPingTracker pingTracker)

setSmsPingTracker

Parameters:

pingTracker - a SmsPingTracker object.

ping

public static void ping(String phoneNumber,
        long timeout,
        int retries,
        PingResponseCallback cb)
                 throws Exception

ping

Parameters:

phoneNumber - a String object.

timeout - a long.

retries - a int.

cb - a PingResponseCallback object.

Throws:

Exception - if any.

ping

public static Long ping(String phoneNumber,
        long timeout,
        int retries)
                 throws InterruptedException,
                        Exception

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:

phoneNumber - 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 - if any.

IOException - if any.

Exception - if any.

ping

public static Long ping(String host)
                 throws Exception,
                        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 - if any.

InterruptedException - if any.

Exception - if any.