jist.swans.misc
Class MessageBytes

java.lang.Object
  extended by jist.swans.misc.MessageBytes
All Implemented Interfaces:
JistAPI.Timeless, Message

public class MessageBytes
extends java.lang.Object
implements Message

Implementation of Message interface that carries around byte arrays.

Since:
SWANS1.0
Version:
$Id: MessageBytes.java,v 1.6 2004/04/06 16:07:48 barr Exp $
Author:
Rimon Barr <barr+jist@cs.cornell.edu>

Field Summary
protected  byte[] data
          Message (byte-array) payload.
static byte[] EMPTY
          empty byte array.
protected  int length
          Data length within byte-array.
protected  int offset
          Data offset within byte-array.
 
Fields inherited from interface jist.swans.misc.Message
NULL
 
Constructor Summary
MessageBytes(byte[] data)
          Create new message object.
MessageBytes(byte[] data, int offset, int length)
          Create new message object.
MessageBytes(java.lang.String data)
          Create a new message object.
 
Method Summary
 byte[] getBytes()
          Return message payload.
 void getBytes(byte[] msg, int offset)
          Store packet into byte array.
 int getLength()
          Return length of data within array.
 int getOffset()
          Return offset of data within array.
 int getSize()
          Return packet size or Constants.ZERO_WIRE_SIZE.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY

public static final byte[] EMPTY
empty byte array.


data

protected byte[] data
Message (byte-array) payload.


offset

protected int offset
Data offset within byte-array.


length

protected int length
Data length within byte-array.

Constructor Detail

MessageBytes

public MessageBytes(byte[] data,
                    int offset,
                    int length)
Create new message object.

Parameters:
data - message payload
offset - offset index within data array
length - length of data within array

MessageBytes

public MessageBytes(byte[] data)
Create new message object.

Parameters:
data - message payload

MessageBytes

public MessageBytes(java.lang.String data)
Create a new message object.

Parameters:
data - message pyaload
Method Detail

getBytes

public byte[] getBytes()
Return message payload.

Returns:
message payload

getOffset

public int getOffset()
Return offset of data within array.

Returns:
data offset

getLength

public int getLength()
Return length of data within array.

Returns:
data length

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

getSize

public int getSize()
Return packet size or Constants.ZERO_WIRE_SIZE.

Specified by:
getSize in interface Message
Returns:
packet size

getBytes

public void getBytes(byte[] msg,
                     int offset)
Store packet into byte array.

Specified by:
getBytes in interface Message
Parameters:
msg - destination byte array
offset - byte array starting offset