rsb.transport.socket

Enum ServerMode

java.lang.Object

java.lang.Enum<ServerMode>

rsb.transport.socket.ServerMode

All Implemented Interfaces:

Serializable, Comparable<ServerMode>

public enum ServerMode
extends Enum<ServerMode>

An enum indicating which kind of server mode is requested by the user for the socket transport.

Author:

jwienke

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Try to decide automatically whether a socket server is required and start one if this is the case.
NO Never be a socket server.
YES Always create a socket server.

Method Summary

Methods

Modifier and Type	Method and Description
static ServerMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ServerMode[]	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

Enum Constant Detail

YES

public static final ServerMode YES

Always create a socket server. This may fail if a socket server with same settings already exists on the host / network.

NO

public static final ServerMode NO

Never be a socket server. Instead use an existing server or fail if none can be found.

AUTO

public static final ServerMode AUTO

Try to decide automatically whether a socket server is required and start one if this is the case. Otherwise, reuse an existing one.

Method Detail

values

public static ServerMode[] 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 (ServerMode c : ServerMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ServerMode valueOf(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:

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

NullPointerException - if the argument is null