Package org.opennms.netmgt.icmp.jna
Class JnaPingRequest
- java.lang.Object
-
- org.opennms.netmgt.icmp.jna.JnaPingRequest
-
- All Implemented Interfaces:
Comparable<Delayed>
,Delayed
,Request<JnaPingRequestId,JnaPingRequest,JnaPingReply>
,EchoPacket
public class JnaPingRequest extends Object implements Request<JnaPingRequestId,JnaPingRequest,JnaPingReply>, 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 JnaPingRequest(InetAddress addr, int identifier, int sequenceId, long timeout, int retries, int packetsize, PingResponseCallback cb)
JnaPingRequest(InetAddress addr, int identifier, int sequenceId, long threadId, long timeout, int retries, int packetsize, PingResponseCallback cb)
JnaPingRequest(JnaPingRequestId id, long timeout, int retries, int packetsize, PingResponseCallback cb)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Delayed request)
compareTodouble
elapsedTime(TimeUnit timeUnit)
Returns the round trip time in the requested TimeUnit (note that a fractional value will be returned if necessary)InetAddress
getAddress()
long
getDelay(TimeUnit unit)
Indicates how many units of time are remaining until this request times out.JnaPingRequestId
getId()
getIdint
getIdentifier()
static long
getNextTID()
long
getReceivedTimeNanos()
long
getSentTimeNanos()
int
getSequenceNumber()
long
getThreadId()
boolean
isEchoReply()
boolean
isExpired()
isExpiredboolean
isProcessed()
isProcessedvoid
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(JnaPingReply reply)
processResponseJnaPingRequest
processTimeout()
processTimeoutvoid
send(V4Pinger v4, Inet4Address addr4)
void
send(V4Pinger v4, V6Pinger v6)
Send this V4PingRequest through the given icmpSocketvoid
send(V6Pinger v6, Inet6Address addr6)
String
toString()
toString
-
-
-
Constructor Detail
-
JnaPingRequest
public JnaPingRequest(JnaPingRequestId id, long timeout, int retries, int packetsize, PingResponseCallback cb)
-
JnaPingRequest
public JnaPingRequest(InetAddress addr, int identifier, int sequenceId, long threadId, long timeout, int retries, int packetsize, PingResponseCallback cb)
-
JnaPingRequest
public JnaPingRequest(InetAddress addr, int identifier, int sequenceId, long timeout, int retries, int packetsize, PingResponseCallback cb)
-
-
Method Detail
-
getNextTID
public static final long getNextTID()
-
processResponse
public boolean processResponse(JnaPingReply reply)
processResponse
- Specified by:
processResponse
in interfaceRequest<JnaPingRequestId,JnaPingRequest,JnaPingReply>
- Parameters:
reply
- aorg.opennms.netmgt.icmp.spi.JnaPingReply.PingReply
object.- Returns:
- a boolean.
-
processTimeout
public JnaPingRequest processTimeout()
processTimeout
- Specified by:
processTimeout
in interfaceRequest<JnaPingRequestId,JnaPingRequest,JnaPingReply>
- Returns:
- a
org.opennms.netmgt.JnaPingRequest.AbstractPingRequest
object.
-
isExpired
public boolean isExpired()
isExpired
- Returns:
- a boolean.
-
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 interfaceDelayed
- Specified by:
getDelay
in interfaceRequest<JnaPingRequestId,JnaPingRequest,JnaPingReply>
-
compareTo
public int compareTo(Delayed request)
compareTo
- Specified by:
compareTo
in interfaceComparable<Delayed>
- Parameters:
request
- aDelayed
object.- Returns:
- a int.
-
getId
public JnaPingRequestId getId()
getId
- Specified by:
getId
in interfaceRequest<JnaPingRequestId,JnaPingRequest,JnaPingReply>
- Returns:
- a
org.opennms.netmgt.icmp.spi.JnaPingRequestId.PingRequestId
object.
-
processError
public 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.- Specified by:
processError
in interfaceRequest<JnaPingRequestId,JnaPingRequest,JnaPingReply>
-
isProcessed
public boolean isProcessed()
isProcessed
- Specified by:
isProcessed
in interfaceRequest<JnaPingRequestId,JnaPingRequest,JnaPingReply>
- Returns:
- a boolean.
-
send
public void send(V4Pinger v4, V6Pinger v6)
Send this V4PingRequest through the given icmpSocket- Parameters:
icmpSocket
- aIcmpSocket
object.
-
getAddress
public InetAddress getAddress()
-
send
public void send(V6Pinger v6, Inet6Address addr6)
-
send
public void send(V4Pinger v4, Inet4Address addr4)
-
toString
public String toString()
toString
-
isEchoReply
public boolean isEchoReply()
- Specified by:
isEchoReply
in interfaceEchoPacket
-
getIdentifier
public int getIdentifier()
- Specified by:
getIdentifier
in interfaceEchoPacket
-
getSequenceNumber
public int getSequenceNumber()
- Specified by:
getSequenceNumber
in interfaceEchoPacket
-
getThreadId
public long getThreadId()
- Specified by:
getThreadId
in interfaceEchoPacket
-
getReceivedTimeNanos
public long getReceivedTimeNanos()
- Specified by:
getReceivedTimeNanos
in interfaceEchoPacket
-
getSentTimeNanos
public long getSentTimeNanos()
- Specified by:
getSentTimeNanos
in interfaceEchoPacket
-
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 interfaceEchoPacket
-
-