stella.net.gregor

Class CommandMessage

java.lang.Object

stella.net.gregor.Message

stella.net.gregor.CommandMessage

public class CommandMessage
extends Message

Extends a normal GREGOR message to be of the command type. In the heart of the message, this only guarantees that the REPLY flag is not set and that the data section can be read as an ascii string. For communication purposes, this object additionally comprises knowledge about timeout of acknowledge and done reception plus the ability to inidicate a second reply ('done') carrying binary data (unused in our case).

Nested Class Summary

Nested classes/interfaces inherited from class stella.net.gregor.Message

Message.GregorDesignation

Field Summary

Fields

Modifier and Type	Field and Description
private long	acktimeout The anticipated acknowledge timeout.
private boolean	binarydone If true, the second reply carries binary data.
static long	DEFACKTIME The default acknowldeg time-out.
static long	DEFDONETIME The default done time-out.
private long	donetimeout The anticipated done timeout.

Fields inherited from class stella.net.gregor.Message

GREC, PACE, RPLY, URG

Constructor Summary

Constructors

Modifier	Constructor and Description
	CommandMessage(Object src, Object dest, String ascii) Creates amessage with source, destination and data section.
	CommandMessage(Object src, Object dest, String ascii, long doneout) Creates amessage with source, destination, data section and flags.
	CommandMessage(Object src, Object dest, String ascii, long ackout, long doneout) Creates amessage with source, destination, data section and flags.
protected	CommandMessage(Object src, Object dest, String ascii, short fl, long ackout, long doneout) Full constructor, hidden from the outside.

Method Summary

Modifier and Type	Method and Description
long	getAcknowledgeTimeout() Returns the expected acknowledge timeout.
long	getDoneTimeout() Returns the expected done (=2nd reply) timeout.
boolean	getExpectBinary() Returns true, if this command expectes a binary second reply.
void	setExpectBinary(boolean bit) Sets the expected data flag to either binary (=true) or ascii (=false, default).
protected void	setTimeouts(long a, long d) Sets the acknowledge and done timeout.

Methods inherited from class stella.net.gregor.Message

addFlag, getData, getDataLength, getDestination, getFlags, getID, getNextId, getPayload, getSource, getString16, hashCode, isGrec, isPace, isReply, isUrgent, setData, setFlags, setID, testFlags, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFACKTIME

public static final long DEFACKTIME

The default acknowldeg time-out.

See Also:

Constant Field Values

DEFDONETIME

public static final long DEFDONETIME

The default done time-out.

See Also:

Constant Field Values

acktimeout

private long acktimeout

The anticipated acknowledge timeout.

donetimeout

private long donetimeout

The anticipated done timeout.

binarydone

private boolean binarydone

If true, the second reply carries binary data.

Constructor Detail

CommandMessage

public CommandMessage(Object src,
                      Object dest,
                      String ascii)

Creates amessage with source, destination and data section. Flags are defaulted to zero, the serial id is auto-generated.

CommandMessage

public CommandMessage(Object src,
                      Object dest,
                      String ascii,
                      long doneout)

Creates amessage with source, destination, data section and flags. The serial id is auto-generated.

CommandMessage

public CommandMessage(Object src,
                      Object dest,
                      String ascii,
                      long ackout,
                      long doneout)

Creates amessage with source, destination, data section and flags. The serial id is auto-generated.

CommandMessage

protected CommandMessage(Object src,
                         Object dest,
                         String ascii,
                         short fl,
                         long ackout,
                         long doneout)

Full constructor, hidden from the outside.

Method Detail

setTimeouts

protected void setTimeouts(long a,
                           long d)

Sets the acknowledge and done timeout.

setExpectBinary

public void setExpectBinary(boolean bit)

Sets the expected data flag to either binary (=true) or ascii (=false, default).

getExpectBinary

public boolean getExpectBinary()

Returns true, if this command expectes a binary second reply.

getAcknowledgeTimeout

public long getAcknowledgeTimeout()

Returns the expected acknowledge timeout.

getDoneTimeout

public long getDoneTimeout()

Returns the expected done (=2nd reply) timeout.