All Known Implementing Classes:

BestMatchPinger, JnaPinger, Jni6Pinger, JniPinger, NullPinger, TestPinger
```
public interface Pinger
```
Pinger class.

Author:

Ben Reed, Mathew Brozowski

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`initialize4()`	Initialize IPv4 in this Pinger implementation.
`void`	`initialize6()`	Initialize IPv6 in this Pinger implementation.
`boolean`	`isV4Available()`	Whether or not IPv4 is initialized and available for this implementation.
`boolean`	`isV6Available()`	Whether or not IPv6 is initialized and available for this implementation.
`List<Number>`	`parallelPing(InetAddress host, int count, long timeout, long pingInterval)`	Ping a remote host, sending 1 or more packets at the given interval, and then return the response times as a list.
`List<Number>`	`parallelPing(InetAddress host, int count, long timeout, long pingInterval, int size)`	Ping a remote host, sending 1 or more packets at the given interval, and then return the response times as a list.
`Number`	`ping(InetAddress host)`	Ping a remote host, using the default number of retries and timeouts.
`Number`	`ping(InetAddress host, long timeout, int retries)`	This method is used to ping a remote host to test for ICMP support.
`Number`	`ping(InetAddress host, long timeout, int retries, int packetsize)`	This method is used to ping a remote host to test for ICMP support.
`void`	`ping(InetAddress host, long timeout, int retries, int packetsize, int sequenceId, PingResponseCallback cb)`	This method is used to ping a remote host to test for ICMP support.
`void`	`ping(InetAddress host, long timeout, int retries, int sequenceId, PingResponseCallback cb)`	This method is used to ping a remote host to test for ICMP support.
`void`	`setAllowFragmentation(boolean allow)`
`void`	`setTrafficClass(int tc)`

- Method Detail
  - ping
```
void ping(InetAddress host,
          long timeout,
          int retries,
          int packetsize,
          int sequenceId,
          PingResponseCallback cb)
   throws Exception
```
    This method is used to ping a remote host to test for ICMP support. Calls the callback method upon success or error.
    
    Parameters:
    
    host - The InetAddress address to poll.
    
    timeout - The time to wait between each retry.
    
    retries - The number of times to retry.
    
    packetsize - The size in byte of the ICMP packet.
    
    sequenceId - an ID representing the ping
    
    cb - the org.opennms.netmgt.ping.PingResponseCallback callback to call upon success or error
    
    Throws:
    
    Exception
  - ping
```
void ping(InetAddress host,
          long timeout,
          int retries,
          int sequenceId,
          PingResponseCallback cb)
   throws Exception
```
    This method is used to ping a remote host to test for ICMP support. Calls the callback method upon success or error.
    
    Parameters:
    
    host - The InetAddress address to poll.
    
    timeout - The time to wait between each retry.
    
    retries - The number of times to retry.
    
    sequenceId - an ID representing the ping
    
    cb - the org.opennms.netmgt.ping.PingResponseCallback callback to call upon success or error
    
    Throws:
    
    Exception
  - ping
```
Number ping(InetAddress host,
            long timeout,
            int retries,
            int packetsize)
     throws 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:
    
    host - The InetAddress address to poll.
    
    timeout - The time to wait between each retry.
    
    retries - The number of times to retry.
    
    packetsize - The size in byte of the ICMP packet.
    
    Returns:
    
    The response time in microseconds if the host is reachable and has responded with an echo reply, otherwise a null value.
    
    Throws:
    
    Exception
  - ping
```
Number ping(InetAddress host,
            long timeout,
            int retries)
     throws 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:
    
    host - The InetAddress 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:
    
    Exception
  - ping
```
Number ping(InetAddress host)
     throws Exception
```
    Ping a remote host, using the default number of retries and timeouts.
    
    Parameters:
    
    host - The InetAddress address to poll.
    
    Returns:
    
    The response time in microseconds if the host is reachable and has responded with an echo reply, otherwise a null value.
    
    Throws:
    
    IOException - if any.
    
    InterruptedException - if any.
    
    Exception - if any.
  - parallelPing
```
List<Number> parallelPing(InetAddress host,
                          int count,
                          long timeout,
                          long pingInterval,
                          int size)
                   throws Exception
```
    Ping a remote host, sending 1 or more packets at the given interval, and then return the response times as a list.
    
    Parameters:
    
    host - The InetAddress address to poll.
    
    count - The number of packets to send.
    
    timeout - The time to wait between each retry.
    
    pingInterval - The interval at which packets will be sent.
    
    size - The size of the packet to send.
    
    Returns:
    
    a List of response times in microseconds. If, for a given ping request, the host is reachable and has responded with an echo reply, it will contain a number, otherwise a null value.
    
    Throws:
    
    Exception
  - parallelPing
```
List<Number> parallelPing(InetAddress host,
                          int count,
                          long timeout,
                          long pingInterval)
                   throws Exception
```
    Ping a remote host, sending 1 or more packets at the given interval, and then return the response times as a list.
    
    Parameters:
    
    host - The InetAddress address to poll.
    
    count - The number of packets to send.
    
    timeout - The time to wait between each retry.
    
    pingInterval - The interval at which packets will be sent.
    
    Returns:
    
    a List of response times in microseconds. If, for a given ping request, the host is reachable and has responded with an echo reply, it will contain a number, otherwise a null value.
    
    Throws:
    
    Exception
  - setAllowFragmentation
```
void setAllowFragmentation(boolean allow)
                    throws Exception
```
    Throws:
    
    Exception
  - setTrafficClass
```
void setTrafficClass(int tc)
              throws Exception
```
    Throws:
    
    Exception
  - initialize4
```
void initialize4()
          throws Exception
```
    Initialize IPv4 in this Pinger implementation. If unable to do so, implementations should throw an exception.
    
    Throws:
    
    Exception
  - initialize6
```
void initialize6()
          throws Exception
```
    Initialize IPv6 in this Pinger implementation. If unable to do so, implementations should throw an exception.
    
    Throws:
    
    Exception
  - isV4Available
```
boolean isV4Available()
```
    Whether or not IPv4 is initialized and available for this implementation.
  - isV6Available
```
boolean isV6Available()
```
    Whether or not IPv6 is initialized and available for this implementation.
    
    Returns:

Interface Pinger

Method Summary

Method Detail

ping

ping

ping

ping

ping

parallelPing

parallelPing

setAllowFragmentation

setTrafficClass

initialize4

initialize6

isV4Available

isV6Available