TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.hyades.internal.execution.local.common
Class CommandElement

java.lang.Object
  extended by org.eclipse.hyades.internal.execution.local.common.CommandElement
All Implemented Interfaces:
Constants
Direct Known Subclasses:
AgentConfigurationCommand, AgentScopingInformationCommand, AuthenticateCommand, AuthenticationFailedCommand, AuthenticationSuccessfulCommand, GetPropertyListCommand, LaunchProcessCommand, ManageFileCommand, PropertyListCommand, QueryProcessListCommand, RegisteredProcessListCommand, ResourceLocation, ServerSecurityInfoCommand, ShutdownCommand, SimpleProcessCommand

public abstract class CommandElement
extends java.lang.Object
implements Constants


Field Summary
protected  long _context
           
protected  long _tag
           
 
Fields inherited from interface org.eclipse.hyades.internal.execution.local.common.Constants
CTL_PORT_NUM_CLIENT, CTL_PORT_NUM_SERVER, DATA_PORT_NUM_CLIENT, DEFAULT_TIMEOUT, MAX_COMMAND_LINE_LENGTH, MAX_DATA_LENGTH, MAX_MESSAGE_LENGTH, MESSAGE_HEADER_LENGTH, RA_ACKNOWLEDGEMENT_MESSAGE, RA_AGENT_ACTIVE, RA_AGENT_ATTACHED, RA_AGENT_CONFIGURATION, RA_AGENT_CONTROLLER_AVAILABLE, RA_AGENT_CONTROLLER_UNAVAILABLE, RA_AGENT_DETACHED, RA_AGENT_DETAILS, RA_AGENT_INACTIVE, RA_AGENT_LIST, RA_AGENT_QUERY_STATE, RA_AGENT_REQUEST_MONITOR, RA_AGENT_REQUEST_MONITOR_PORT, RA_AGENT_SCOPING_INFORMATION, RA_ATTACH_FAILED, RA_ATTACH_SUCCESSFUL, RA_ATTACH_TO_AGENT, RA_AUTHENTICATE, RA_AUTHENTICATION_FAILED, RA_AUTHENTICATION_SUCCESSFUL, RA_BINARY_CUSTOM_COMMAND, RA_CONSOLE_INFO, RA_CONTROL_MESSAGE, RA_CONTROLLER_MONITOR_PEER, RA_CONTROLLER_REQUEST_MONITOR, RA_CONTROLLER_REQUEST_MONITOR_PORT, RA_CUSTOM_COMMAND, RA_DELETE_FILE, RA_DETACH_FROM_AGENT, RA_ERROR_STRING, RA_GET_FILE, RA_GET_PROPERTY_LIST, RA_KILL_PROCESS, RA_LAUNCH_PROCESS, RA_LOCAL_AGENT_ACTIVE, RA_MAGIC, RA_MAGIC_0, RA_MAGIC_1, RA_MAGIC_2, RA_MAGIC_3, RA_MANAGE_FILE, RA_MASTER_ADDRESS, RA_PEER_UNREACHABLE, RA_PIPE_NAMESPACE, RA_PIPE_NAMESPACE_WIN32, RA_PROCESS_EXITED, RA_PROCESS_LAUNCHED, RA_PROCESS_LIST, RA_PROPERTY_LIST, RA_PUT_FILE, RA_QUERY_AGENT_DETAILS, RA_QUERY_AGENT_LIST, RA_QUERY_PROCESS_LIST, RA_REGISTER_AGENT_NOTIFICATION, RA_RESOURCE_LOCATION, RA_SERVER_SECURITY_REQUIREMENTS, RA_SET_NAME_VALUE_PAIR, RA_SHUTDOWN, RA_START_MONITORING_AGENT_LOCAL, RA_START_MONITORING_AGENT_REMOTE, RA_STOP_MONITORING_AGENT, RA_VERSION, sizeofByte, sizeofChar, sizeofLong, sizeofShort
 
Constructor Summary
CommandElement()
           
 
Method Summary
 long getContext()
          Return the context of this command element
 int getSize()
          Return the size of this command in number of bytes
 long getTag()
          Return the command tag
 int readFromBuffer(byte[] buffer, int offset)
          Construct the command by reading the buffer
 void setContext(long context)
          Set the command's context
 int writeToBuffer(byte[] buffer, int offset)
          Serialize the command into the byte buffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_tag

protected long _tag

_context

protected long _context
Constructor Detail

CommandElement

public CommandElement()
Method Detail

getContext

public long getContext()
Return the context of this command element

Returns:
context

getSize

public int getSize()
Return the size of this command in number of bytes

Returns:
size

getTag

public long getTag()
Return the command tag

Returns:
tag

readFromBuffer

public int readFromBuffer(byte[] buffer,
                          int offset)
Construct the command by reading the buffer

Parameters:
buffer - Buffer containing serialized command
offset - Start position for reading
Returns:

setContext

public void setContext(long context)
Set the command's context

Parameters:
context -

writeToBuffer

public int writeToBuffer(byte[] buffer,
                         int offset)
Serialize the command into the byte buffer

Parameters:
buffer - Buffer containing serialized command
offset - Start position for reading
Returns:

TPTP 4.6.0 Platform Project
Internal API Specification