org.opennms.netmgt.ping
Class PingRequest

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

All Implemented Interfaces:

Comparable<Delayed>, Delayed, org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

public final class PingRequest
extends Object
implements org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

This class is used to encapsulate a ping request. A request consist of the pingable address and a signaled state.

Version:

$Id: $

Author:

Ben Reed, Mathew Brozowski, Ben Reed, Mathew Brozowski

Field Summary

static short

FILTER_ID Constant FILTER_ID=(short) (new java.util.Random(System.currentTimeMillis())).nextInt()

Method Summary

int	compareTo(Delayed request) compareTo
void	createRequestPacket() createRequestPacket
InetAddress	getAddress() getAddress
long	getDelay(TimeUnit unit)
long	getExpiration() getExpiration
PingRequestId	getId() getId
org.opennms.protocols.icmp.ICMPEchoPacket	getRequest() getRequest
org.opennms.protocols.icmp.ICMPEchoPacket	getResponse() getResponse
int	getRetries() getRetries
short	getSequenceId() getSequenceId
long	getTid() getTid
long	getTimeout() getTimeout
boolean	isExpired() isExpired
boolean	isProcessed() isProcessed
void	processError(Throwable t)
boolean	processResponse(PingReply reply) processResponse
PingRequest	processTimeout() processTimeout
void	sendRequest(org.opennms.protocols.icmp.IcmpSocket icmpSocket) Send this PingRequest through the given icmpSocket
String	toString() toString

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_ID

public static final short FILTER_ID

Constant FILTER_ID=(short) (new java.util.Random(System.currentTimeMillis())).nextInt()

Method Detail

getAddress

public InetAddress getAddress()

getAddress

Returns:

a InetAddress object.

getTid

public long getTid()

getTid

Returns:

a long.

getSequenceId

public short getSequenceId()

getSequenceId

Returns:

a short.

getRetries

public int getRetries()

getRetries

Returns:

a int.

getTimeout

public long getTimeout()

getTimeout

Returns:

a long.

getRequest

public org.opennms.protocols.icmp.ICMPEchoPacket getRequest()

getRequest

Returns:

a ICMPEchoPacket object.

getResponse

public org.opennms.protocols.icmp.ICMPEchoPacket getResponse()

getResponse

Returns:

a ICMPEchoPacket object.

getExpiration

public long getExpiration()

getExpiration

Returns:

a long.

sendRequest

public void sendRequest(org.opennms.protocols.icmp.IcmpSocket icmpSocket)

Send this PingRequest through the given icmpSocket

Parameters:

icmpSocket - a IcmpSocket object.

createRequestPacket

public void createRequestPacket()

createRequestPacket

processResponse

public boolean processResponse(PingReply reply)

processResponse

Specified by:

processResponse in interface org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

Parameters:

reply - a PingReply object.

Returns:

a boolean.

processTimeout

public PingRequest processTimeout()

processTimeout

Specified by:

processTimeout in interface org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

Returns:

a PingRequest object.

isExpired

public boolean isExpired()

isExpired

Returns:

a boolean.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

getDelay

public long getDelay(TimeUnit unit)

Specified by:

getDelay in interface Delayed

Specified by:

getDelay in interface org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

compareTo

public int compareTo(Delayed request)

compareTo

Specified by:

compareTo in interface Comparable<Delayed>

Parameters:

request - a Delayed object.

Returns:

a int.

getId

public PingRequestId getId()

getId

Specified by:

getId in interface org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

Returns:

a PingRequestId object.

processError

public void processError(Throwable t)

Specified by:

processError in interface org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

isProcessed

public boolean isProcessed()

isProcessed

Specified by:

isProcessed in interface org.opennms.protocols.rt.Request<PingRequestId,PingRequest,PingReply>

Returns:

a boolean.