Package org.opennms.netmgt.icmp.jni

Class JniPingRequest

java.lang.Object

org.opennms.netmgt.icmp.jni.JniPingRequest

All Implemented Interfaces:

Comparable<Delayed>, Delayed, Request<JniPingRequestId,JniPingRequest,JniPingResponse>, EchoPacket

public class JniPingRequest
extends Object
implements Request<JniPingRequestId,JniPingRequest,JniPingResponse>, EchoPacket

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

Author:

Ben Reed, Mathew Brozowski

Constructor Summary

Constructors

Constructor	Description
JniPingRequest(InetAddress addr, int identifier, int sequenceNumber, long timeout, int retries, int packetsize, PingResponseCallback cb)
JniPingRequest(InetAddress addr, int identifier, int sequenceNumber, long threadId, long timeout, int retries, int packetsize, PingResponseCallback cb)
JniPingRequest(JniPingRequestId id, long timeout, int retries, int packetsize, PingResponseCallback callback)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Delayed request)	compareTo
double	elapsedTime(TimeUnit timeUnit)	Returns the round trip time in the requested TimeUnit (note that a fractional value will be returned if necessary)
long	getDelay(TimeUnit unit)	Indicates how many units of time are remaining until this request times out.
JniPingRequestId	getId()	getId
int	getIdentifier()
static long	getNextTID()
long	getReceivedTimeNanos()
long	getSentTimeNanos()
int	getSequenceNumber()
long	getThreadId()
boolean	isEchoReply()
boolean	isExpired()	isExpired
boolean	isProcessed()	isProcessed
void	processError(Throwable t)	If an error or exception occurs during processing of this request then processError is called with the error or exception object.
boolean	processResponse(JniPingResponse reply)	processResponse
JniPingRequest	processTimeout()	processTimeout
void	send(org.opennms.protocols.icmp.IcmpSocket icmpSocket)	Send this JniPingRequest through the given icmpSocket
String	toString()	toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JniPingRequest

public JniPingRequest(JniPingRequestId id,
                      long timeout,
                      int retries,
                      int packetsize,
                      PingResponseCallback callback)

JniPingRequest

public JniPingRequest(InetAddress addr,
                      int identifier,
                      int sequenceNumber,
                      long threadId,
                      long timeout,
                      int retries,
                      int packetsize,
                      PingResponseCallback cb)

JniPingRequest

public JniPingRequest(InetAddress addr,
                      int identifier,
                      int sequenceNumber,
                      long timeout,
                      int retries,
                      int packetsize,
                      PingResponseCallback cb)

Method Detail

getNextTID

public static final long getNextTID()

processResponse

public boolean processResponse(JniPingResponse reply)

processResponse

Specified by:

processResponse in interface Request<JniPingRequestId,JniPingRequest,JniPingResponse>

Parameters:

reply - a org.opennms.netmgt.icmp.spi.JniPingResponse.PingReply object.

Returns:

a boolean.

processTimeout

public JniPingRequest processTimeout()

processTimeout

Specified by:

processTimeout in interface Request<JniPingRequestId,JniPingRequest,JniPingResponse>

Returns:

a JniPingRequest 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)

Indicates how many units of time are remaining until this request times out. Please note that this is the time REMAINING not the total timeout time. This method is inherited from Delayed

Specified by:

getDelay in interface Delayed

Specified by:

getDelay in interface Request<JniPingRequestId,JniPingRequest,JniPingResponse>

compareTo

public int compareTo(Delayed request)

compareTo

Specified by:

compareTo in interface Comparable<Delayed>

Parameters:

request - a Delayed object.

Returns:

a int.

getId

public JniPingRequestId getId()

getId

Specified by:

getId in interface Request<JniPingRequestId,JniPingRequest,JniPingResponse>

Returns:

a org.opennms.netmgt.icmp.spi.JniPingRequestId.PingRequestId object.

processError

public void processError(Throwable t)

Description copied from interface: Request

If an error or exception occurs during processing of this request then processError is called with the error or exception object.

Specified by:

processError in interface Request<JniPingRequestId,JniPingRequest,JniPingResponse>

isProcessed

public boolean isProcessed()

isProcessed

Specified by:

isProcessed in interface Request<JniPingRequestId,JniPingRequest,JniPingResponse>

Returns:

a boolean.

send

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

Send this JniPingRequest through the given icmpSocket

Parameters:

icmpSocket - a IcmpSocket object.

isEchoReply

public boolean isEchoReply()

Specified by:

isEchoReply in interface EchoPacket

getIdentifier

public int getIdentifier()

Specified by:

getIdentifier in interface EchoPacket

getSequenceNumber

public int getSequenceNumber()

Specified by:

getSequenceNumber in interface EchoPacket

getThreadId

public long getThreadId()

Specified by:

getThreadId in interface EchoPacket

getReceivedTimeNanos

public long getReceivedTimeNanos()

Specified by:

getReceivedTimeNanos in interface EchoPacket

getSentTimeNanos

public long getSentTimeNanos()

Specified by:

getSentTimeNanos in interface EchoPacket

elapsedTime

public double elapsedTime(TimeUnit timeUnit)

Description copied from interface: EchoPacket

Returns the round trip time in the requested TimeUnit (note that a fractional value will be returned if necessary)

Specified by:

elapsedTime in interface EchoPacket