com.tivoli.twg.libs
Class CmdPacket

java.lang.Object
  extended bycom.tivoli.twg.libs.IntelByteBuffer
      extended bycom.tivoli.twg.libs.CmdPacket

public class CmdPacket
extends IntelByteBuffer

CmdPacket is access class for low-level Director transport data structure for messages.


Field Summary
static byte AUTH_INPUT_PACKET
           
static byte AUTH_OUTPUT_PACKET
           
static byte CMD_INPUT_PACKET
           
static byte CMD_OUTPUT_PACKET
           
static int CMDPKT_CMD_ID_OFF
           
static int CMDPKT_CMD_RET_CODE_OFF
           
static int CMDPKT_DST_ADDR_LEN_OFF
           
static int CMDPKT_DST_ADDR_OFF_OFF
           
static int CMDPKT_HDR_LEN_OFF
           
static int CMDPKT_LENGTH_OFF
          Offsets of key field in header
static int CMDPKT_MODE_OFF
           
static int CMDPKT_PARM_CNT_OFF
           
static int CMDPKT_PARM_LEN_OFF_OFF
           
static int CMDPKT_PARM_OFF_OFF
           
static int CMDPKT_RET_ADDR_LEN_OFF
           
static int CMDPKT_RET_ADDR_OFF_OFF
           
static int CMDPKT_STEP_OFF
           
static int CMDPKT_TYPE_OFF
           
static int HEADER_LEN
           
static byte PACKET_SESSION_HOLD
           
static byte PACKET_SESSION_IMMED
           
static byte PACKET_SESSION_NONE
           
static byte PACKET_SESSION_PREFERRED
           
static byte PACKET_SESSION_REL
           
static byte PACKET_SESSION_REQUIRED
           
static byte PACKET_SESSION_WAIT
           
static byte SVC_INPUT_PACKET
           
static byte SVC_OUTPUT_PACKET
           
 
Fields inherited from class com.tivoli.twg.libs.IntelByteBuffer
SIZEOF_CHAR, SIZEOF_DOUBLE, SIZEOF_FLOAT, SIZEOF_LONG, SIZEOF_LONG64, SIZEOF_SHORT, SIZEOF_UCHAR, SIZEOF_ULONG, SIZEOF_UNICODE, SIZEOF_USHORT
 
Constructor Summary
CmdPacket(byte[] buf, int off)
          Construct CmdPacket to interpret provided byte array.
CmdPacket(int len, int off)
          Construct CmdPacket to create a packet.
 
Method Summary
 long CmdID()
          Read command ID
 long CmdRetCode()
          Read command/return code
 int DestAddrLen()
          Read destination address length.
 int DestAddrOff()
          Read destination address offset.
 int HeaderLen()
          Read header length field.
 long Length()
          Read length field.
 byte PacketType()
          Read packet type field.
 int ParmCount()
          Read parameter count
 int ParmLenTableOff()
          Read parameter length table offset
 int ParmOff()
          Read parameter list offset
 int ReturnAddrLen()
          Read return address length.
 int ReturnAddrOff()
          Read return address offset.
 byte SessionMode()
          Read session mode.
 void SetCmdID(long val)
          Write command ID
 void SetCmdRetCode(long val)
          Write command/return code.
 void SetDestAddrLen(int val)
          Write destination address length.
 void SetDestAddrOff(int val)
          Write destination address offset.
 void SetHeaderLen(int val)
          Write header length field.
 void SetLength(long val)
          Write length field.
 void SetPacketType(byte val)
          Write packet type.
 void SetParmCount(int val)
          Write parameter count.
 void SetParmLenTableOff(int val)
          Write parameter length table offset.
 void SetParmOff(int val)
          Write parameter list offset.
 void SetReturnAddrLen(int val)
          Write return address length.
 void SetReturnAddrOff(int val)
          Write return address offset.
 void SetSessionMode(byte val)
          Write session mode
 void SetStepNum(int val)
          Write step number on destination address.
 int StepNum()
          Read step number on destination address.
 
Methods inherited from class com.tivoli.twg.libs.IntelByteBuffer
BytesToString, BytesToString, GetASCIIZLength, GetBuffer, GetCompUnicodeLength, GetEncodedUTF8Length, GetIntValueSetLength, GetLengthEncodedLong64ArrayLength, GetLengthEncodedLONGArrayLength, GetLengthEncodedULONGArrayLength, GetLongValueSetLength, GetOffset, GetStart, GetStringValueSetLength, GetUTF8, GetUTF8Length, printBytes, printBytes, ReadASCIIZ, ReadASCIIZ, ReadASCIIZ, ReadCHAR, ReadCHAR, ReadCHAR, ReadCHARArray, ReadCHARArray, ReadCHARArray, ReadCompUnicode, ReadCompUnicode, ReadCompUnicode, ReadDouble, ReadDouble, ReadDouble, ReadDoubleArray, ReadDoubleArray, ReadDoubleArray, ReadF loat, ReadFloat, ReadFloat, ReadFloatArray, ReadFloatArray, ReadFloatArray, ReadIntValueSet, ReadIntValueSet, ReadIntValueSet, ReadLONG, ReadLONG, ReadLONG, ReadLong64, ReadLong64, ReadLong64, ReadLong64Array, ReadLong64Array, ReadLong64Array, ReadLong64LengthEncodedArray, ReadLong64LengthEncodedArray, ReadLong64LengthEncodedArray, ReadLONGArray, ReadLONGArray, ReadLONGArray, ReadLONGLengthEncodedArray, ReadLONGLengthEncodedArray, ReadLONGLengthEncodedArray, ReadLongValueSet, ReadLongValueSet, ReadLongValueSet, ReadSHORT, ReadSHORT, ReadSHORT, ReadSHORTArray, ReadSHORTArray, ReadSHORTArray, ReadStringValueSet, ReadStringValueSet, ReadStringValueSet, ReadUCHAR, ReadUCHAR, ReadUCHAR, ReadUCHARArray, ReadUCHARArray, ReadUCHARArray, ReadULONG, ReadULONG, ReadULONG, ReadULONGArray, ReadULONGArray, ReadULONGArray, ReadULONGLengthEncodedArray, ReadULONGLengthEncodedArray, ReadULONGLengthEncodedArray, ReadUnicode, ReadUnicode, ReadUnicode, ReadUnicodeArray, ReadUnicodeArray, ReadUnicodeArray, ReadUSHORT, ReadUSHORT, ReadUSHORT, ReadUSHORTArray, ReadUSHORTArray, ReadUSHORTArray, ReadUTF8, ReadUTF8, ResetStart, ResizeBuffer, SetBuffer, SetOffset, SetStart, SkipASCIIZ, SkipASCIIZ, SkipCompUnicode, SkipCompUnicode, SkipIntValueSet, SkipIntValueSet, SkipLengthEncodedLong64Array, SkipLengthEncodedLong64Array, SkipLengthEncodedLONGArray, SkipLengthEncodedLONGArray, SkipLengthEncodedULONGArray, SkipLengthEncodedULONGArray, SkipLongValueSet, SkipLongValueSet, SkipStringValueSet, SkipStringValueSet, SkipUTF8, SkipUTF8, StepOffset, StepStart, WriteASCIIZ, WriteASCIIZ, WriteASCIIZ, WriteCHAR, WriteCHAR, WriteCHAR, WriteCHARArray, WriteCHARArray, WriteCHARArray, WriteCHARArray, WriteCHARArray, WriteCompUnicode, WriteCompUnicode, WriteCompUnicode, WriteDouble, WriteDouble, WriteDouble, WriteDoubleArray, WriteDoubleArray, WriteDoubleArray, WriteDoubleArray, WriteFloat, WriteFloat, WriteFloat, WriteFloatArray, WriteFloatArray, WriteFloatArray, WriteFloatArray, WriteIntValueSet, WriteIntValueSet, WriteIntValueSet, WriteLONG, WriteLONG, WriteLONG, WriteLong64, WriteLong64, WriteLong64, WriteLong64Array, WriteLong64Array, WriteLong64Array, WriteLong64Array, WriteLong64ArrayLengthEncoded, WriteLong64ArrayLengthEncoded, WriteLong64ArrayLengthEncoded, WriteLong64ArrayLengthEncoded, WriteLONGArray, WriteLONGArray, WriteLONGArray, WriteLONGArray, WriteLONGArrayLengthEncoded, WriteLONGArrayLengthEncoded, WriteLONGArrayLengthEncoded, WriteLONGArrayLengthEncoded, WriteLongValueSet, WriteLongValueSet, WriteLongValueSet, WriteSHORT, WriteSHORT, WriteSHORT, WriteSHORTArray, WriteSHORTArray, WriteSHORTArray, WriteSHORTArray, WriteStringValueSet, WriteStringValueSet, WriteStringValueSet, WriteUCHAR, WriteUCHAR, WriteUCHAR, WriteUCHARArray, WriteUCHARArray, WriteUCHARArray, WriteUCHARArray, WriteULONG, WriteULONG, WriteULONG, WriteULONGArray, WriteULONGArray, WriteULONGArray, WriteULONGArray, WriteULONGArrayLengthEncoded, WriteULONGArrayLengthEncoded, WriteULONGArrayLengthEncoded, WriteULONGArrayLengthEncoded, WriteUnicode, WriteUnicode, WriteUnicode, WriteUnicodeArray, WriteUnicodeArray, WriteUnicodeArray, WriteUnicodeArray, WriteUSHORT, WriteUSHORT, WriteUSHORT, WriteUSHORTArray, WriteUSHORTArray, WriteUSHORTArray, WriteUSHORTArray, WriteUTF8, WriteUTF8
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADER_LEN

public static final int HEADER_LEN
See Also:
Constant Field Values

CMD_INPUT_PACKET

public static final byte CMD_INPUT_PACKET
See Also:
Constant Field Values

CMD_OUTPUT_PACKET

public static final byte CMD_OUTPUT_PACKET
See Also:
Constant Field Values

AUTH_INPUT_PACKET

public static final byte AUTH_INPUT_PACKET
See Also:
Constant Field Values

AUTH_OUTPUT_PACKET

public static final byte AUTH_OUTPUT_PACKET
See Also:
Constant Field Values

SVC_INPUT_PACKET

public static final byte SVC_INPUT_PACKET
See Also:
Constant Field Values

SVC_OUTPUT_PACKET

public static final byte SVC_OUTPUT_PACKET
See Also:
Constant Field Values

PACKET_SESSION_NONE

public static final byte PACKET_SESSION_NONE
See Also:
Constant Field Values

PACKET_SESSION_REQUIRED

public static final byte PACKET_SESSION_REQUIRED
See Also:
Constant Field Values

PACKET_SESSION_PREFERRED

public static final byte PACKET_SESSION_PREFERRED
See Also:
Constant Field Values

PACKET_SESSION_WAIT

public static final byte PACKET_SESSION_WAIT
See Also:
Constant Field Values

PACKET_SESSION_IMMED

public static final byte PACKET_SESSION_IMMED
See Also:
Constant Field Values

PACKET_SESSION_HOLD

public static final byte PACKET_SESSION_HOLD
See Also:
Constant Field Values

PACKET_SESSION_REL

public static final byte PACKET_SESSION_REL
See Also:
Constant Field Values

CMDPKT_LENGTH_OFF

public static final int CMDPKT_LENGTH_OFF
Offsets of key field in header

See Also:
Constant Field Values

CMDPKT_HDR_LEN_OFF

public static final int CMDPKT_HDR_LEN_OFF
See Also:
Constant Field Values

CMDPKT_TYPE_OFF

public static final int CMDPKT_TYPE_OFF
See Also:
Constant Field Values

CMDPKT_MODE_OFF

public static final int CMDPKT_MODE_OFF
See Also:
Constant Field Values

CMDPKT_RET_ADDR_LEN_OFF

public static final int CMDPKT_RET_ADDR_LEN_OFF
See Also:
Constant Field Values

CMDPKT_RET_ADDR_OFF_OFF

public static final int CMDPKT_RET_ADDR_OFF_OFF
See Also:
Constant Field Values

CMDPKT_DST_ADDR_LEN_OFF

public static final int CMDPKT_DST_ADDR_LEN_OFF
See Also:
Constant Field Values

CMDPKT_DST_ADDR_OFF_OFF

public static final int CMDPKT_DST_ADDR_OFF_OFF
See Also:
Constant Field Values

CMDPKT_STEP_OFF

public static final int CMDPKT_STEP_OFF
See Also:
Constant Field Values

CMDPKT_CMD_RET_CODE_OFF

public static final int CMDPKT_CMD_RET_CODE_OFF
See Also:
Constant Field Values

CMDPKT_PARM_CNT_OFF

public static final int CMDPKT_PARM_CNT_OFF
See Also:
Constant Field Values

CMDPKT_PARM_LEN_OFF_OFF

public static final int CMDPKT_PARM_LEN_OFF_OFF
See Also:
Constant Field Values

CMDPKT_PARM_OFF_OFF

public static final int CMDPKT_PARM_OFF_OFF
See Also:
Constant Field Values

CMDPKT_CMD_ID_OFF

public static final int CMDPKT_CMD_ID_OFF
See Also:
Constant Field Values
Constructor Detail

CmdPacket

public CmdPacket(byte[] buf,
                 int off)
Construct CmdPacket to interpret provided byte array.

Parameters:
buf - - byte array containing packet
off - - offset of start of command packet

CmdPacket

public CmdPacket(int len,
                 int off)
Construct CmdPacket to create a packet.

Parameters:
len - - overall length of command packet
off - - offset of start of command packet
Method Detail

Length

public final long Length()
Read length field.

Returns:
overall length of packet

SetLength

public final void SetLength(long val)
Write length field.

Parameters:
val - - set overall length

HeaderLen

public final int HeaderLen()
Read header length field.

Returns:
length of packet of header

SetHeaderLen

public final void SetHeaderLen(int val)
Write header length field.

Parameters:
val - - set header length

PacketType

public final byte PacketType()
Read packet type field.

Returns:
packet type

SetPacketType

public final void SetPacketType(byte val)
Write packet type.

Parameters:
val - - packet type

SessionMode

public final byte SessionMode()
Read session mode.

Returns:
session mode

SetSessionMode

public final void SetSessionMode(byte val)
Write session mode

Parameters:
val - - session mode

ReturnAddrLen

public final int ReturnAddrLen()
Read return address length.

Returns:
length of return address

SetReturnAddrLen

public final void SetReturnAddrLen(int val)
Write return address length.

Parameters:
val - - set length of return address

ReturnAddrOff

public final int ReturnAddrOff()
Read return address offset.

Returns:
offset of return address

SetReturnAddrOff

public final void SetReturnAddrOff(int val)
Write return address offset.

Parameters:
val - - set offset of return address

DestAddrLen

public final int DestAddrLen()
Read destination address length.

Returns:
length of destination address

SetDestAddrLen

public final void SetDestAddrLen(int val)
Write destination address length.

Parameters:
val - - set length of destination address

DestAddrOff

public final int DestAddrOff()
Read destination address offset.

Returns:
offset of destination address

SetDestAddrOff

public final void SetDestAddrOff(int val)
Write destination address offset.

Parameters:
val - - set offset of destination address

StepNum

public final int StepNum()
Read step number on destination address.

Returns:
step number

SetStepNum

public final void SetStepNum(int val)
Write step number on destination address.

Parameters:
val - - set step number

CmdRetCode

public final long CmdRetCode()
Read command/return code

Returns:
command/return code

SetCmdRetCode

public final void SetCmdRetCode(long val)
Write command/return code.

Parameters:
val - - set command/return code

ParmCount

public final int ParmCount()
Read parameter count

Returns:
parameter count

SetParmCount

public final void SetParmCount(int val)
Write parameter count.

Parameters:
val - - set parameter count

ParmLenTableOff

public final int ParmLenTableOff()
Read parameter length table offset

Returns:
parameter length table offset

SetParmLenTableOff

public final void SetParmLenTableOff(int val)
Write parameter length table offset.

Parameters:
val - - set parameter length table offset

ParmOff

public final int ParmOff()
Read parameter list offset

Returns:
parameter list offset

SetParmOff

public final void SetParmOff(int val)
Write parameter list offset.

Parameters:
val - - set parameter list offset

CmdID

public final long CmdID()
Read command ID

Returns:
command ID

SetCmdID

public final void SetCmdID(long val)
Write command ID

Parameters:
val - - set command ID