|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opennms.netmgt.discovery.IPPollAddress
This class is used to represent the polling information needed by the discovery process. Each instance encapsulates an internet address, timeout in milliseconds, and a retry count.
Field Summary | |
private java.net.InetAddress |
m_address
The dotted decimal IPv4 address for the poll. |
private int |
m_retries
The number of times to attempt to contact the remote. |
private long |
m_timeout
The timeout for the poller in 1/1000th of a second. |
Constructor Summary | |
private |
IPPollAddress()
The default constructor is marked private and will always throw an UnsupportedOperationException. |
(package private) |
IPPollAddress(java.net.InetAddress ipAddress,
long timeout,
int retries)
Constructs an IPPollAddress object with the specified parameters. |
(package private) |
IPPollAddress(java.lang.String ipAddress,
long timeout,
int retries)
Constructs an IPPollAddress object with the specified parameters. |
Method Summary | |
boolean |
equals(IPPollAddress pollAddr)
Returns true if the passed object is equal to self. |
(package private) java.net.InetAddress |
getAddress()
Returns the internet address encapsulated in the object. |
(package private) int |
getRetries()
Returns the current number of retries set for this address. |
(package private) long |
getTimeout()
Returns the timeout in 1/1000th of a second increments. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private java.net.InetAddress m_address
private long m_timeout
private int m_retries
Constructor Detail |
private IPPollAddress() throws java.lang.UnsupportedOperationException
The default constructor is marked private and will always throw an UnsupportedOperationException. This is to prevent the use of the default constructor.
java.lang.UnsupportedOperationException
- Always thrown.IPPollAddress(java.lang.String ipAddress, long timeout, int retries) throws java.net.UnknownHostException
Constructs an IPPollAddress object with the specified parameters.
ipAddress
- The Dotted Decimal IPv4 Address.timeout
- The timeout between retries in 1/1000th of a second.retries
- The number of times to attempt to contact the address.
java.net.UnknownHostException
- Thrown by the InetAddress class if the hostname cannot be
resolved.IPPollAddress(java.net.InetAddress ipAddress, long timeout, int retries)
Constructs an IPPollAddress object with the specified parameters.
ipAddress
- The Dotted Decimal IPv4 Address.timeout
- The timeout between retries in 1/1000th of a second.retries
- The number of times to attempt to contact the address.Method Detail |
long getTimeout()
Returns the timeout in 1/1000th of a second increments.
int getRetries()
Returns the current number of retries set for this address.
java.net.InetAddress getAddress()
public boolean equals(IPPollAddress pollAddr)
Returns true if the passed object is equal to self. The objects must be equal in address, timeout, and the number of retries.
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |