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

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

public class TattachMessage
extends StyxMessage

Message sent to establish a connection

Author:

Jon Blower $Revision: 146 $ $Date: 2005-03-15 09:01:48 +0000 (Tue, 15 Mar 2005) $ $Log$ 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.1 2005/03/09 16:58:42 jonblower Changes to MINA-related classes 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

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

TattachMessage(long fid, long afid, java.lang.String uname, java.lang.String aname)

TattachMessage(long fid, java.lang.String uname)

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
long	getAfid()
java.lang.String	getAname()
protected java.lang.String	getElements()
long	getFid()
java.lang.String	getUname()
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

TattachMessage

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

Creates a new TattachMessage.

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

TattachMessage

public TattachMessage(long fid,
                      long afid,
                      java.lang.String uname,
                      java.lang.String aname)

TattachMessage

public TattachMessage(long fid,
                      java.lang.String uname)

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

getElements

protected java.lang.String getElements()

Specified by:

getElements in class StyxMessage

Returns:

the body elements of this message as a string

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.

getAfid

public long getAfid()

getUname

public java.lang.String getUname()

getAname

public java.lang.String getAname()

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