Module com.aoindustries.noc.monitor.portmon

Package com.aoindustries.noc.monitor.portmon

Class DefaultUdpPortMonitor

java.lang.Object

com.aoindustries.noc.monitor.portmon.PortMonitor

com.aoindustries.noc.monitor.portmon.DefaultUdpPortMonitor

public class DefaultUdpPortMonitor
extends PortMonitor

Monitors any UDP port.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class com.aoindustries.noc.monitor.portmon.PortMonitor

canceled, CRLF, ipAddress, port

Constructor Summary

Constructors

Constructor	Description
DefaultUdpPortMonitor(InetAddress ipAddress, Port port)	Creates a new default UDP monitor.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels this port method on a best effort basis.
String	checkPort()	Checks the port.

Methods inherited from class com.aoindustries.noc.monitor.portmon.PortMonitor

getPortMonitor, readLine

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultUdpPortMonitor

public DefaultUdpPortMonitor(InetAddress ipAddress,
 Port port)

Creates a new default UDP monitor.

Method Details

cancel

public void cancel()

Description copied from class: PortMonitor

Cancels this port method on a best effort basis. This will not necessarily cause the checkPort method to return immediately. This should only be used once the result of checkPort is no longer relevant, such as after a timeout. Some monitors may still perform their task arbitrarily long after cancel has been called.

It is critical that subclass implementations of this method not block in any way.

Overrides:

cancel in class PortMonitor

See Also:

• PortMonitor.checkPort()

checkPort

public String checkPort()
                 throws Exception

Description copied from class: PortMonitor

Checks the port. This may take arbitrarily long to complete, and any timeout should be provided externally and call the cancel method. If any error occurs, must throw an exception.

Specified by:

checkPort in class PortMonitor

Returns:

the message indicating success

Throws:

Exception

See Also:

• PortMonitor.cancel()