org.arl.fjage.remote

Enum TunnelParam

java.lang.Object

java.lang.Enum<TunnelParam>

org.arl.fjage.remote.TunnelParam

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TunnelParam>, Parameter

public enum TunnelParam
extends java.lang.Enum<TunnelParam>
implements Parameter

Enum Constant Summary

Enum Constants

Enum Constant and Description
agents List of remote agents/topics visible through the tunnel.
connIDs Map of connection IDs to connector names.
ip IP address for the tunnel.
port TCP port number for the tunnel.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.arl.fjage.param.Parameter

name, ordinal

Enum Constant Detail

ip

public static final TunnelParam ip

IP address for the tunnel. In case of a client tunnel, this is the IP address of the server to connect to. In case of a server tunnel, this is set to null.

port

public static final TunnelParam port

TCP port number for the tunnel. In case of a client tunnel, this is the TCP port number of the server to connect to. In case of a server tunnel, this is the TCP port number to listen on for incoming client connections.

agents

public static final TunnelParam agents

List of remote agents/topics visible through the tunnel.

connIDs

public static final TunnelParam connIDs

Map of connection IDs to connector names. In case of a client tunnel, this is a map of connection IDs to connector names for the server tunnel. In case of a server tunnel, this is a map of connection IDs to connector names for the client tunnels.

Method Detail

values

public static TunnelParam[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TunnelParam c : TunnelParam.values())
    System.out.println(c);

Returns:

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

valueOf

public static TunnelParam valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null