net.vattp.data
Class Msg

java.lang.Object
  |
  +--net.vattp.data.Msg

public class Msg
extends Object

Untamed: Define the allowable message types for the VatTP system. This class only contains static final values. It can not be instantiated.

This class only defines static final values.

Author:
Bill Frantz

Field Summary
static byte E_MSG
          Enabled: E level message to an object at the remote end
(package private) static byte HIGH_MSG_TYPE
          Highest message type allocated (used to allocate arrays)
(package private) static int MAX_INBOUND_MSG_LENGTH
          Maximum length message we will receive.
static int MAX_OUTBOUND_MSG_LENGTH
          Enabled: Maximum length message permitted on a connection.
(package private) static byte PING
          Ping other end to ensure connection still intact
(package private) static long PING_SENDTIME
          The timeout for no messages received.
(package private) static long PING_TIMEOUT
          The timeout for a ping.
(package private) static byte PONG
          Response to a PING message
(package private) static byte PROTOCOL_ACCEPTED
          STARTUP response showing which protocol version to use
(package private) static byte PROTOCOL_VERSION
          Supported versions of the E protocol.
(package private) static byte STARTUP
          Initial connection setup message
(package private) static byte SUSPEND
          Suspend or shutdown this connection.
(package private) static long TICK_RATE
          The tick rate for the connection keep alive clock.
private static long TIME_FUDGE
          A fudge factor with which to multiply the timeouts for purposes of debugging.
static byte TUNNEL_MSG
          Enabled: RMI Comm message to a stream at the other end
(package private) static String[] Version
          The protocol versions this implementations supports.
 
Constructor Summary
private Msg()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Version

static final String[] Version
The protocol versions this implementations supports.


PROTOCOL_VERSION

static final byte PROTOCOL_VERSION
Supported versions of the E protocol.


STARTUP

static final byte STARTUP
Initial connection setup message


PROTOCOL_ACCEPTED

static final byte PROTOCOL_ACCEPTED
STARTUP response showing which protocol version to use


SUSPEND

static final byte SUSPEND
Suspend or shutdown this connection. A shutdown message has only the message type. A suspend messages also has the suspendID as an encoded string parameter.


PING

static final byte PING
Ping other end to ensure connection still intact


PONG

static final byte PONG
Response to a PING message


E_MSG

public static final byte E_MSG
Enabled: E level message to an object at the remote end


TUNNEL_MSG

public static final byte TUNNEL_MSG
Enabled: RMI Comm message to a stream at the other end


HIGH_MSG_TYPE

static final byte HIGH_MSG_TYPE
Highest message type allocated (used to allocate arrays)


MAX_OUTBOUND_MSG_LENGTH

public static final int MAX_OUTBOUND_MSG_LENGTH
Enabled: Maximum length message permitted on a connection. This limit is enforced by the VatTPConnection object.


MAX_INBOUND_MSG_LENGTH

static final int MAX_INBOUND_MSG_LENGTH
Maximum length message we will receive. This length is set longer than MAX_OUTBOUND_MSG_LENGTH to allow for MAC overhead etc. This limit is enforced by the RecvThread.


TIME_FUDGE

private static final long TIME_FUDGE
A fudge factor with which to multiply the timeouts for purposes of debugging.


TICK_RATE

static final long TICK_RATE
The tick rate for the connection keep alive clock. Used in conjunction with PING_SENDTIME and PING_TIMEOUT to ensure that the connection is still in good working order. In milliseconds.


PING_SENDTIME

static final long PING_SENDTIME
The timeout for no messages received. When this timeout is exceeded, we send a ping message. In milliseconds.


PING_TIMEOUT

static final long PING_TIMEOUT
The timeout for a ping. If we don't receive a message within this time after we have sent a ping, we declare the connection down. In milliseconds.

Constructor Detail

Msg

private Msg()


comments?