com.sun.n1.sps.model.util
Interface PingResult

public interface PingResult

This class encapsulates the result of a ping request as returned by the command "net.ping".

Method Summary

java.lang.String	failureCodeString() Returns a string representing the failure code.
java.lang.String	failureString() Returns an arbitrary string describing the reason for failure.
RoxAddress	getDestinationId() The destination of the ping.
byte	getTTL() Returns the value of the time to live value.
boolean	isSuccess() True if ping was successful.
long	timeTakenMillis() Time taken in milliseconds for the response.

Method Detail

timeTakenMillis

long timeTakenMillis()

Time taken in milliseconds for the response. Valid only if the ping was successful.

Returns:

The time taken in milliseconds.

isSuccess

boolean isSuccess()

True if ping was successful.

Returns:

true if the ping was sucessful, false otherwise.

getDestinationId

RoxAddress getDestinationId()

The destination of the ping.

Returns:

The RoxAddress of the destination system.

failureString

java.lang.String failureString()

Returns an arbitrary string describing the reason for failure. The return value is valid only if ping failed.

Returns:

The arbitary string describing the reason for the failure.

getTTL

byte getTTL()

Returns the value of the time to live value.

Returns:

The byte value of the time to live value.

failureCodeString

java.lang.String failureCodeString()

Returns a string representing the failure code.

Returns:

The string respresenting the failure code.