com.martiansoftware.nailgun

Class NGConstants

java.lang.Object

com.martiansoftware.nailgun.NGConstants

public class NGConstants
extends java.lang.Object

Just a simple holder for various NailGun-related contants.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CHUNKTYPE_ARGUMENT Chunk type marker for command line arguments
static byte	CHUNKTYPE_COMMAND Chunk type marker for the command (alias or class)
static byte	CHUNKTYPE_ENVIRONMENT Chunk type marker for client environment variables
static byte	CHUNKTYPE_EXIT Chunk type marker for client exit chunks
static byte	CHUNKTYPE_HEARTBEAT Chunk type marker for heartbeats sent to let the server know the client is still alive.
static byte	CHUNKTYPE_SENDINPUT Chunk type marker for a "startinput" chunk.
static byte	CHUNKTYPE_STDERR Chunk type marker for stderr
static byte	CHUNKTYPE_STDIN Chunk type marker for stdin
static byte	CHUNKTYPE_STDIN_EOF Chunk type marker for the end of stdin
static byte	CHUNKTYPE_STDOUT Chunk type marker for stdout
static byte	CHUNKTYPE_WORKINGDIRECTORY Chunk type marker for client working directory
static int	DEFAULT_PORT The default NailGun port (2113)
static int	EXIT_EXCEPTION The exit code sent to clients if an exception occurred on the server
static int	EXIT_NOSUCHCOMMAND The exit code sent to clients if an invalid command is sent
static short	HEARTBEAT_INTERVAL_MILLIS Expected interval between heartbeats in milliseconds.
static short	HEARTBEAT_TIMEOUT_MILLIS Maximum interval to wait between heartbeats before considering client to have disconnected.
static short	MAXIMUM_CHUNK_LENGTH Maximum chunk len sent from client.
static java.lang.String	VERSION Server version number

Constructor Summary

Constructors

Constructor and Description
NGConstants()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getVersion() Returns the Nailgun version number

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

The default NailGun port (2113)

See Also:

Constant Field Values

EXIT_EXCEPTION

public static final int EXIT_EXCEPTION

The exit code sent to clients if an exception occurred on the server

See Also:

Constant Field Values

EXIT_NOSUCHCOMMAND

public static final int EXIT_NOSUCHCOMMAND

The exit code sent to clients if an invalid command is sent

See Also:

Constant Field Values

CHUNKTYPE_ARGUMENT

public static final byte CHUNKTYPE_ARGUMENT

Chunk type marker for command line arguments

See Also:

Constant Field Values

CHUNKTYPE_ENVIRONMENT

public static final byte CHUNKTYPE_ENVIRONMENT

Chunk type marker for client environment variables

See Also:

Constant Field Values

CHUNKTYPE_COMMAND

public static final byte CHUNKTYPE_COMMAND

Chunk type marker for the command (alias or class)

See Also:

Constant Field Values

CHUNKTYPE_WORKINGDIRECTORY

public static final byte CHUNKTYPE_WORKINGDIRECTORY

Chunk type marker for client working directory

See Also:

Constant Field Values

CHUNKTYPE_STDIN

public static final byte CHUNKTYPE_STDIN

Chunk type marker for stdin

See Also:

Constant Field Values

CHUNKTYPE_STDIN_EOF

public static final byte CHUNKTYPE_STDIN_EOF

Chunk type marker for the end of stdin

See Also:

Constant Field Values

CHUNKTYPE_STDOUT

public static final byte CHUNKTYPE_STDOUT

Chunk type marker for stdout

See Also:

Constant Field Values

CHUNKTYPE_STDERR

public static final byte CHUNKTYPE_STDERR

Chunk type marker for stderr

See Also:

Constant Field Values

CHUNKTYPE_EXIT

public static final byte CHUNKTYPE_EXIT

Chunk type marker for client exit chunks

See Also:

Constant Field Values

CHUNKTYPE_SENDINPUT

public static final byte CHUNKTYPE_SENDINPUT

Chunk type marker for a "startinput" chunk. This chunk type is sent from the server to the client and indicates that the client should begin sending stdin to the server. It is automatically sent the first time the client's inputstream is read.

See Also:

Constant Field Values

CHUNKTYPE_HEARTBEAT

public static final byte CHUNKTYPE_HEARTBEAT

Chunk type marker for heartbeats sent to let the server know the client is still alive.

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Server version number

HEARTBEAT_INTERVAL_MILLIS

public static final short HEARTBEAT_INTERVAL_MILLIS

Expected interval between heartbeats in milliseconds.

See Also:

Constant Field Values

HEARTBEAT_TIMEOUT_MILLIS

public static final short HEARTBEAT_TIMEOUT_MILLIS

Maximum interval to wait between heartbeats before considering client to have disconnected.

See Also:

Constant Field Values

MAXIMUM_CHUNK_LENGTH

public static final short MAXIMUM_CHUNK_LENGTH

Maximum chunk len sent from client.

See Also:

Constant Field Values

Constructor Detail

NGConstants

public NGConstants()

Method Detail

getVersion

public static java.lang.String getVersion()

Returns the Nailgun version number

Returns:

the Nailgun version number