Package uk.ac.manchester.spinnaker.alloc.proxy

Enum Class ProxyOp

java.lang.Object

java.lang.Enum<ProxyOp>

uk.ac.manchester.spinnaker.alloc.proxy.ProxyOp

All Implemented Interfaces:

Serializable, Comparable<ProxyOp>, Constable

public enum ProxyOp
extends Enum<ProxyOp>

Message codes used in proxy operations.

Author:

Donal Fellows

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE	Ask for a channel (created with OPEN or OPEN_UNCONNECTED) to be closed.
ERROR	A message, only ever sent in response to OPEN, CLOSE, or OPEN_UNCONNECTED, that says that an operation failed.
MESSAGE	A message going to or from a board.
MESSAGE_TO	A message going to a board on a channel which does not have a SpiNNaker board target address set up already (OPEN_UNCONNECTED).
OPEN	Ask for a bidirectional channel to a board to be opened.
OPEN_UNCONNECTED	Ask for a bidirectional channel from all boards to be opened.

Method Summary

Modifier and Type	Method	Description
static ProxyOp	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProxyOp[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPEN

public static final ProxyOp OPEN

Ask for a bidirectional channel to a board to be opened. Also the response to such a request when successful.

CLOSE

public static final ProxyOp CLOSE

Ask for a channel (created with OPEN or OPEN_UNCONNECTED) to be closed. Also the response to such a request when successful.

MESSAGE

public static final ProxyOp MESSAGE

A message going to or from a board. Channel must be open already. When going to a board, the channel must have been opened with OPEN, and thus be already bound.

OPEN_UNCONNECTED

public static final ProxyOp OPEN_UNCONNECTED

Ask for a bidirectional channel from all boards to be opened. Also the response to such a request when successful. The difference is that this reports the real listening IP address and port in the response message. (This is closed with a CLOSE message.) Sending is only possible on this channel with MESSAGE_TO (because no target address is set by default).

MESSAGE_TO

public static final ProxyOp MESSAGE_TO

A message going to a board on a channel which does not have a SpiNNaker board target address set up already (OPEN_UNCONNECTED).

ERROR

public static final ProxyOp ERROR

A message, only ever sent in response to OPEN, CLOSE, or OPEN_UNCONNECTED, that says that an operation failed.

Method Details

values

public static ProxyOp[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ProxyOp valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null