Package dev.getelements.elements.rt.remote

Interface RemoteInvokerRegistry

All Known Implementing Classes:

SimpleRemoteInvokerRegistry

public interface RemoteInvokerRegistry

Manages connections to the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RemoteInvokerRegistry.RemoteInvokerStatus	Represents the remote invoker status.

Method Summary

Modifier and Type	Method	Description
default List<RemoteInvoker>	getAllRemoteInvokers(ApplicationId applicationId)	Returns a RemoteInvoker for all known NodeIds.
List<RemoteInvokerRegistry.RemoteInvokerStatus>	getAllRemoteInvokerStatuses()	Gets all RemoteInvoker instances across all applications.
List<RemoteInvokerRegistry.RemoteInvokerStatus>	getAllRemoteInvokerStatuses(ApplicationId applicationId)	Returns a RemoteInvoker for all known NodeIds.
default RemoteInvoker	getBestRemoteInvoker(ApplicationId applicationId)	Returns a RemoteInvoker by arbitrary selection.
RemoteInvokerRegistry.RemoteInvokerStatus	getBestRemoteInvokerStatus(ApplicationId applicationId)	Returns a RemoteInvoker by arbitrary selection.
RemoteInvoker	getRemoteInvoker(NodeId nodeId)	Returns the RemoteInvoker registered under the given NodeId.
void	refresh()	Forces or initiates a refresh of all NodeIds available.
void	start()	Starts this RemoteInvokerRegistry.
void	stop()	STops this RemoteInvokerRegistry.

Method Details

start

void start()

Starts this RemoteInvokerRegistry.

stop

void stop()

STops this RemoteInvokerRegistry.

refresh

void refresh()

Forces or initiates a refresh of all NodeIds available. Opening new connections if necessary. This will block until the refresh operation has been completed and all new connections established (if necessary).

getAllRemoteInvokerStatuses

List<RemoteInvokerRegistry.RemoteInvokerStatus> getAllRemoteInvokerStatuses()

Gets all RemoteInvoker instances across all applications.

Returns:

the List<RemoteInvoker>

getAllRemoteInvokerStatuses

List<RemoteInvokerRegistry.RemoteInvokerStatus> getAllRemoteInvokerStatuses(ApplicationId applicationId)

Returns a RemoteInvoker for all known NodeIds. This will be a perfect snapshot of the state of the registry.

Parameters:

applicationId -

Returns:

a List<RemoteInvoker>

getAllRemoteInvokers

default List<RemoteInvoker> getAllRemoteInvokers(ApplicationId applicationId)

Returns a RemoteInvoker for all known NodeIds. This will be a perfect snapshot of the state of the registry.

Parameters:

applicationId -

Returns:

a List<RemoteInvoker>

getBestRemoteInvoker

default RemoteInvoker getBestRemoteInvoker(ApplicationId applicationId)

Returns a RemoteInvoker by arbitrary selection. The underlying RemoteInvokerRegistry may employ heuristics to determine the most suitable RemoteInvoker to return. However, this defers entirely to the underlying implementation to make that determination.

Parameters:

applicationId -

getBestRemoteInvokerStatus

RemoteInvokerRegistry.RemoteInvokerStatus getBestRemoteInvokerStatus(ApplicationId applicationId)

Returns a RemoteInvoker by arbitrary selection. The underlying RemoteInvokerRegistry may employ heuristics to determine the most suitable RemoteInvoker to return. However, this defers entirely to the underlying implementation to make that determination.

Parameters:

applicationId -

getRemoteInvoker

RemoteInvoker getRemoteInvoker(NodeId nodeId)

Returns the RemoteInvoker registered under the given NodeId.

Parameters:

nodeId - the node identifier (may be a NodeId for either an instance or application).

Returns:

a RemoteInvoker for the given nodeId, or null if not found.