Module org.praxislive.hub.net

Package org.praxislive.hub.net

Class NetworkCoreFactory

java.lang.Object

org.praxislive.hub.net.NetworkCoreFactory

All Implemented Interfaces:

Hub.CoreRootFactory

public final class NetworkCoreFactory
extends Object
implements Hub.CoreRootFactory

A CoreRootFactory supporting a tree of networked roots. Use builder() to create.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NetworkCoreFactory.Builder	A builder for NetworkCoreFactory.
static final class	NetworkCoreFactory.Info	Information about the launched network hub.

Method Summary

Modifier and Type	Method	Description
NetworkCoreFactory.Info	awaitInfo(long timeout, TimeUnit unit)	Get NetworkCoreFactory.Info for the started core root.
static NetworkCoreFactory.Builder	builder()	Create a NetworkCoreFactory builder.
Root	createCoreRoot(Hub.Accessor accessor, List<Root> extensions)	Create a core root implementation with the provided RootHub accessor and extensions.
Lookup	extendLookup(Lookup lookup)	Provide the option for the factory to extend or alter the hub lookup.

Methods inherited from class java.lang.Object

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

Method Details

createCoreRoot

public Root createCoreRoot(Hub.Accessor accessor,
 List<Root> extensions)

Description copied from interface: Hub.CoreRootFactory

Create a core root implementation with the provided RootHub accessor and extensions. The return type of this method will usually be a subclass of BasicCoreRoot.

Specified by:

createCoreRoot in interface Hub.CoreRootFactory

Parameters:

accessor - private access to control the RootHub

extensions - extensions to install

Returns:

core root implementation

extendLookup

public Lookup extendLookup(Lookup lookup)

Description copied from interface: Hub.CoreRootFactory

Provide the option for the factory to extend or alter the hub lookup. This should usually be done by passing the provided lookup in as parent to Lookup.of(org.praxislive.core.Lookup, java.lang.Object...). The default implementation returns the provided lookup unchanged.

Specified by:

extendLookup in interface Hub.CoreRootFactory

Parameters:

lookup - existing lookup

Returns:

extended lookup

awaitInfo

public NetworkCoreFactory.Info awaitInfo(long timeout,
 TimeUnit unit)
                                  throws InterruptedException,
ExecutionException,
TimeoutException

Get NetworkCoreFactory.Info for the started core root. If the server is enabled, this will block until a network connection is established and the socket address and port is available.

Parameters:

timeout - the maximum time to wait

unit - the unit of timeout

Returns:

info

Throws:

InterruptedException

ExecutionException

TimeoutException

builder

public static NetworkCoreFactory.Builder builder()

Create a NetworkCoreFactory builder.

Returns:

builder