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

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

public class RwalkMessage
extends StyxMessage

Message returned by the server in response to a TwalkMessage

Author:

Jon Blower $Revision: 263 $ $Date: 2005-05-25 16:39:02 +0100 (Wed, 25 May 2005) $ $Log$ Revision 1.5 2005/05/25 15:39:02 jonblower Bug fixes 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:15 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:43 jonblower Added getFriendlyString() Revision 1.1.1.1 2005/02/16 18:58:28 jonblower Initial import

Field Summary

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

buf, length, lock, name, tag, type

Constructor Summary

RwalkMessage(int length, short type, int tag)
Creates a new RwalkMessage

RwalkMessage(Qid[] qids)

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
protected java.lang.String	getElements()
int	getNumSuccessfulWalks()
Qid	getQid(int index)
void	putQid(Qid qid)
java.lang.String	toFriendlyString()

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

createStyxMessage, dispose, encode, getBuffer, getFid, 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

RwalkMessage

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

Creates a new RwalkMessage

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

RwalkMessage

public RwalkMessage(Qid[] qids)

Method Detail

decodeBody

protected final void decodeBody(StyxBuffer buf)

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

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

putQid

public void putQid(Qid qid)

getQid

public Qid getQid(int index)

getNumSuccessfulWalks

public int getNumSuccessfulWalks()

Returns:

The number of successful walks made in the file traversal

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