net.openhft.chronicle.network

Enum TCPRegistry

java.lang.Object

java.lang.Enum<TCPRegistry>

net.openhft.chronicle.network.TCPRegistry

All Implemented Interfaces:

Serializable, Comparable<TCPRegistry>

public enum TCPRegistry
extends Enum<TCPRegistry>

The TCPRegistry allows you to either provide a true host and port for example "localhost:8080" or if you would rather let the application allocate you a free port at random, you can just provide a text reference to the port, for example "host.port", you can provide any text you want, it will always be taken as a reference, that is unless its correctly formed like "<hostname>:<port>”, then it will use the exact host and port you provide. For listen addresses, if hostname is empty or * then all local addresses will be listened on.

The reason we offer this functionality is quite often in unit tests you wish to start a test via loopback, followed often by another test via loopback, if the first test does not shut down correctly it can impact on the second test. Giving each test a unique port is one solution, but then managing those ports can become a problem in its self. So we created the TCPRegistry which manages those ports for you, when you come to clean up at the end of each test, all you have to do it call TCPRegistry.reset() and it will ensure that any remaining ports that are open will be closed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TCP_REGISTRY_LOOKUP_TABLE_IMPLEMENTATION_PROPERTY

Method Summary

Modifier and Type	Method and Description
static ChronicleServerSocketChannel	acquireServerSocketChannel(@NotNull String description)
static Set<String>	aliases()
static void	assertAllServersStopped()
static void	assertAllServersStopped(long timeout, TimeUnit unit)
static @NotNull InetSocketAddress	createInetSocketAddress(@NotNull String hostname, int port)
static ChronicleServerSocketChannel	createServerSocketChannelFor(boolean isNative, String... descriptions)
static void	createServerSocketChannelFor(String... descriptions)
static ChronicleServerSocketChannel	createServerSocketChannelFor(@NotNull String descriptions) Creates and returns a new ChronicleServerSocketChannel.
static ChronicleSocketChannel	createSocketChannel(boolean isNative, @NotNull String description)
static ChronicleSocketChannel	createSocketChannel(@NotNull String description)
static void	dumpAllSocketChannels()
static InetSocketAddress	lookup(@NotNull String description)
static void	reset()
static void	setAlias(String name, @NotNull String hostname, int port)
static void	useCrossProcessRegistry() Configure the system property to use the cross-process lookup table, this won't come into effect until the next reset
static void	useInMemoryRegistry() Configure the system property to use the in-memory lookup table, this won't come into effect until the next reset
static TCPRegistry	valueOf(String name) Returns the enum constant of this type with the specified name.
static TCPRegistry[]	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

Field Detail

TCP_REGISTRY_LOOKUP_TABLE_IMPLEMENTATION_PROPERTY

public static final String TCP_REGISTRY_LOOKUP_TABLE_IMPLEMENTATION_PROPERTY

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static TCPRegistry 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

useCrossProcessRegistry

public static void useCrossProcessRegistry()

Configure the system property to use the cross-process lookup table, this won't come into effect until the next reset

useInMemoryRegistry

public static void useInMemoryRegistry()

Configure the system property to use the in-memory lookup table, this won't come into effect until the next reset

reset

public static void reset()

aliases

public static Set<String> aliases()

assertAllServersStopped

public static void assertAllServersStopped()

setAlias

public static void setAlias(String name,
                            @NotNull
                            @NotNull String hostname,
                            int port)

createServerSocketChannelFor

public static ChronicleServerSocketChannel createServerSocketChannelFor(@NotNull
                                                                        @NotNull String descriptions)
                                                                 throws IOException

Creates and returns a new ChronicleServerSocketChannel.

Parameters:

descriptions - each string is the name to a reference of a host and port, or if correctly formed this example host and port are used instead

Returns:

a new ChronicleServerSocketChannel

Throws:

IOException - if the socket cannot be created

createServerSocketChannelFor

public static void createServerSocketChannelFor(@NotNull
                                                String... descriptions)
                                         throws IOException

Throws:

IOException

createServerSocketChannelFor

public static ChronicleServerSocketChannel createServerSocketChannelFor(boolean isNative,
                                                                        @NotNull
                                                                        String... descriptions)
                                                                 throws IOException

Throws:

IOException

acquireServerSocketChannel

public static ChronicleServerSocketChannel acquireServerSocketChannel(@NotNull
                                                                      @NotNull String description)
                                                               throws IOException

Throws:

IOException

lookup

public static InetSocketAddress lookup(@NotNull
                                       @NotNull String description)

createInetSocketAddress

@NotNull
public static @NotNull InetSocketAddress createInetSocketAddress(@NotNull
                                                                          @NotNull String hostname,
                                                                          int port)

createSocketChannel

public static ChronicleSocketChannel createSocketChannel(@NotNull
                                                         @NotNull String description)
                                                  throws IOException

Throws:

IOException

createSocketChannel

public static ChronicleSocketChannel createSocketChannel(boolean isNative,
                                                         @NotNull
                                                         @NotNull String description)
                                                  throws IOException

Throws:

IOException

dumpAllSocketChannels

public static void dumpAllSocketChannels()

assertAllServersStopped

public static void assertAllServersStopped(long timeout,
                                           TimeUnit unit)