org.sandev.basics.structs
Class PingStruct

java.lang.Object
  org.sandev.basics.structs.PingStruct

Direct Known Subclasses:

Ping

public class PingStruct
extends java.lang.Object

The Ping structure is fixed so it stays simple. This allows all the processing that handles pinging to be completely automated, and it pretty much avoids breakage due to bad data being stuffed in there by a buggy node.

Ping is a runtime thing so it is not persistent. There are no derivative forms of Ping.

This message can be transmitted directly outside of a verb form.
This message implements the AuthUser interface using email as the username.

Field Summary

protected java.lang.String	className The fully qualified name of the class representing the node which is generating the ping information.
protected java.lang.String	instanceName The unique instance name of the SAND node generating the ping information.
protected int	nodeStatus The status of the SAND node generating the ping information.

Constructor Summary

PingStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

className

protected java.lang.String className

The fully qualified name of the class representing the node which is generating the ping information. For example:
org.sandev.basics.DataManager

declared default value: ""
declared invalid value: "SANDEV_INVALID_CLASSNAME"
Length in characters, normal: 65 max: 255

instanceName

protected java.lang.String instanceName

The unique instance name of the SAND node generating the ping information. For example:
DataManager1

declared default value: ""
declared invalid value: "SANDEV_INVALID_INSTANCENAME"
Length in characters, normal: 30 max: 255

nodeStatus

protected int nodeStatus

The status of the SAND node generating the ping information. Note that this is similar to the information used by sandman to control nodes, but the purpose is slightly different. A SAND node might ping another SAND node to see if it is ready, whereas the sandman control interface will typically use the control protocol directly. The struct can be thought of as a wrapper of the control protocol which makes the information available for general use.

Refer to the node state specification for details on valid status values.

declared default value: UNDEFINED

enumerated constant values:

• UNDEFINED("unknown") = 0
  
• STOPPED("stopped") = 1
  
• STARTING("starting") = 2
  
• RUNNING("running") = 3
  
• SUSPENDING("suspending") = 4
  
• SUSPENDED("suspended") = 5
  
• RESUMING("resuming") = 6
  
• STOPPING("stopping") = 7
  
• FAILING("failing") = 8
  
• FAILED("failed") = 9
  

declared invalid value: UNDEFINED

Constructor Detail

PingStruct

public PingStruct()