uk.ac.rdg.resc.jstyx.messages
Class TreadMessage

java.lang.Object
  uk.ac.rdg.resc.jstyx.messages.StyxMessage
      uk.ac.rdg.resc.jstyx.messages.TreadMessage

public class TreadMessage
extends StyxMessage

Message sent to read data from a file

Author:

Jon Blower $Revision: 176 $ $Date: 2005-03-24 09:48:32 +0000 (Thu, 24 Mar 2005) $ $Log$ Revision 1.5 2005/03/24 09:48:31 jonblower Changed 'count' from long to int throughout for reading and writing Revision 1.4 2005/03/15 09:01:48 jonblower Message type now stored as short, not int Revision 1.3 2005/03/11 14:02:16 jonblower Merged MINA-Test_20059309 into main line of development Revision 1.2.2.1 2005/03/10 11:50:59 jonblower Changed to fit with MINA framework Revision 1.2 2005/02/24 07:44:44 jonblower Added getFriendlyString() Revision 1.1.1.1 2005/02/16 18:58:29 jonblower Initial import

Field Summary

Fields inherited from class uk.ac.rdg.resc.jstyx.messages.StyxMessage

buf, length, lock, name, tag, type

Constructor Summary

TreadMessage(int length, short type, int tag)
Creates a new TreadMessage.

TreadMessage(long fid, ULong offset, int count)

Method Summary

protected void	decodeBody(StyxBuffer buf) Called when a complete message has arrived; signals that we are ready to interpret the raw bytes in the buffer and turn them into meaningful information.
protected void	encodeBody(StyxBuffer buf) Encode the body of the message into bytes in the underlying buffer
int	getCount()
protected java.lang.String	getElements()
long	getFid()
ULong	getOffset()
void	setCount(int count)
void	setFid(long fid)
void	setOffset(ULong offset)
java.lang.String	toFriendlyString()

Methods inherited from class uk.ac.rdg.resc.jstyx.messages.StyxMessage

createStyxMessage, dispose, encode, getBuffer, getLength, getName, getTag, getType, readBytesFrom, setTag, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TreadMessage

public TreadMessage(int length,
                    short type,
                    int tag)

Creates a new TreadMessage. This constructor will be called by the MessageRecognizer.

Parameters:

length - The total length of the message (including all header info)

type - The type of the message (a number between 100 and 127)

tag - The tag that identifies this message

TreadMessage

public TreadMessage(long fid,
                    ULong offset,
                    int count)

Method Detail

decodeBody

protected final void decodeBody(StyxBuffer buf)
                         throws org.apache.mina.protocol.ProtocolViolationException

Description copied from class: StyxMessage

Called when a complete message has arrived; signals that we are ready to interpret the raw bytes in the buffer and turn them into meaningful information. Subclasses should make sure that the buffer is no longer needed once this method has finished, as the underlying buffer will be reused.

Specified by:

decodeBody in class StyxMessage

Throws:

org.apache.mina.protocol.ProtocolViolationException - if the buffer doesn't contain a valid StyxMessage body

encodeBody

protected final void encodeBody(StyxBuffer buf)

Description copied from class: StyxMessage

Encode the body of the message into bytes in the underlying buffer

Specified by:

encodeBody in class StyxMessage

getFid

public long getFid()

Overrides:

getFid in class StyxMessage

Returns:

the fid associated with this message. This default implementation returns StyxUtils.NOFID; subclasses should override this. This method only exists in this superclass as a convenience for the StyxMon application.

setFid

public void setFid(long fid)

getOffset

public ULong getOffset()

setOffset

public void setOffset(ULong offset)

getCount

public int getCount()

setCount

public void setCount(int count)

getElements

protected java.lang.String getElements()

Specified by:

getElements in class StyxMessage

Returns:

the body elements of this message as a string

toFriendlyString

public java.lang.String toFriendlyString()

Overrides:

toFriendlyString in class StyxMessage

Returns:

a human-readable string that displays the contents of the message, without the header info. This default implementation simply calls this.getElements(): subclasses should override this behaviour