Class RemoteAgentProtocol

java.lang.Object

io.gem.agent.RemoteAgentProtocol

public final class RemoteAgentProtocol
extends Object

Binary, length-delimited protocol used between SBK-GEM and its remote agent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RemoteAgentProtocol.Request	Decoded immutable request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVATE	Runtime activation operation.
static final String	ARCHIVE_DIGEST_MISMATCH	Stable diagnostic emitted when a transferred runtime archive fails integrity verification.
static final String	CLEANUP	Retired-runtime cleanup operation.
static final String	MAGIC	Protocol magic.
static final int	MAX_REQUEST_BYTES	Maximum aggregate encoded request size.
static final int	MAX_STRING_BYTES	Maximum encoded string size.
static final int	MAX_VALUES	Maximum request values.
static final String	PROBE	Probe operation.
static final String	RUN	Remote benchmark execution operation.
static final String	RUNTIME_ACQUIRE	Runtime lease acquisition operation.
static final String	RUNTIME_HEARTBEAT	Runtime lease heartbeat operation.
static final String	RUNTIME_RELEASE	Runtime lease release operation.
static final String	RUNTIME_RESERVE	Runtime reservation operation.
static final String	VERIFY	Runtime verification operation.

Method Summary

Modifier and Type	Method	Description
static byte[]	encode(String operation, List<String> values)	Encode an operation and values.
static RemoteAgentProtocol.Request	read(DataInputStream input)	Read a request.

Methods inherited from class Object

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

Field Details

MAGIC

public static final String MAGIC

Protocol magic.

See Also:

• Constant Field Values

MAX_VALUES

public static final int MAX_VALUES

Maximum request values.

See Also:

• Constant Field Values

MAX_STRING_BYTES

public static final int MAX_STRING_BYTES

Maximum encoded string size.

See Also:

• Constant Field Values

MAX_REQUEST_BYTES

public static final int MAX_REQUEST_BYTES

Maximum aggregate encoded request size.

See Also:

• Constant Field Values

ARCHIVE_DIGEST_MISMATCH

public static final String ARCHIVE_DIGEST_MISMATCH

Stable diagnostic emitted when a transferred runtime archive fails integrity verification.

See Also:

• Constant Field Values

PROBE

public static final String PROBE

Probe operation.

See Also:

• Constant Field Values

ACTIVATE

public static final String ACTIVATE

Runtime activation operation.

See Also:

• Constant Field Values

VERIFY

public static final String VERIFY

Runtime verification operation.

See Also:

• Constant Field Values

CLEANUP

public static final String CLEANUP

Retired-runtime cleanup operation.

See Also:

• Constant Field Values

RUNTIME_RESERVE

public static final String RUNTIME_RESERVE

Runtime reservation operation.

See Also:

• Constant Field Values

RUNTIME_ACQUIRE

public static final String RUNTIME_ACQUIRE

Runtime lease acquisition operation.

See Also:

• Constant Field Values

RUNTIME_HEARTBEAT

public static final String RUNTIME_HEARTBEAT

Runtime lease heartbeat operation.

See Also:

• Constant Field Values

RUNTIME_RELEASE

public static final String RUNTIME_RELEASE

Runtime lease release operation.

See Also:

• Constant Field Values

RUN

public static final String RUN

Remote benchmark execution operation.

See Also:

• Constant Field Values

Method Details

encode

public static byte[] encode(String operation,
 List<String> values)
                     throws IOException

Encode an operation and values.

Parameters:

operation - operation name

values - operation values

Returns:

encoded request

Throws:

IOException - when encoding fails

read

public static RemoteAgentProtocol.Request read(DataInputStream input)
                                        throws IOException

Read a request.

Parameters:

input - request input

Returns:

decoded request

Throws:

IOException - when invalid