TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.execution.client.core.internal
Interface IControlMessage

All Superinterfaces:
IMessage
All Known Implementing Classes:
ControlMessage

public interface IControlMessage
extends IMessage

Interface for batching commands into a single context


Method Summary
 void appendCommand(org.eclipse.tptp.platform.execution.util.ICommandElement command)
          Append the passed command to the command list
 org.eclipse.tptp.platform.execution.util.ICommandElement getCommand(int offset)
          Get the command at the offset specified
 int getCommandCount()
          Get the command count
 TPTPString getKey()
          Get the Key
 long getLength()
          Get the message length
 int getSize()
          Get message size
 int readFromBuffer(byte[] buffer, int offset)
          Read from the buffer
 void setKey(TPTPString key)
          Set the Key
 int writeToBuffer(byte[] buffer, int offset)
          Write to Buffer
 
Methods inherited from interface org.eclipse.tptp.platform.execution.util.internal.IMessage
getTicket, getType, getVersion, setTicket, setVersion
 

Method Detail

appendCommand

void appendCommand(org.eclipse.tptp.platform.execution.util.ICommandElement command)
Append the passed command to the command list


getCommand

org.eclipse.tptp.platform.execution.util.ICommandElement getCommand(int offset)
Get the command at the offset specified


getCommandCount

int getCommandCount()
Get the command count


getKey

TPTPString getKey()
Get the Key


setKey

void setKey(TPTPString key)
Set the Key


getLength

long getLength()
Get the message length


getSize

int getSize()
Get message size

Specified by:
getSize in interface IMessage

readFromBuffer

int readFromBuffer(byte[] buffer,
                   int offset)
Read from the buffer

Specified by:
readFromBuffer in interface IMessage

writeToBuffer

int writeToBuffer(byte[] buffer,
                  int offset)
Write to Buffer

Specified by:
writeToBuffer in interface IMessage

TPTP 4.6.0 Platform Project
Internal API Specification