Package dev.getelements.elements.rt.remote

Interface InstanceConnectionService

All Known Implementing Classes:

JeroMQInstanceConnectionService

public interface InstanceConnectionService

The instance connection service handles the dirty details of connecting to a remote Node and keeping track of nodes connected in the system. It is essentially the communication nexus for the rest of the system and provides client code the ability to connect and get basic information on remote nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InstanceConnectionService.InstanceBinding	Represents a binding.
static interface	InstanceConnectionService.InstanceConnection	Represents a connection to a remote instance.

Method Summary

Modifier and Type	Method	Description
List<InstanceConnectionService.InstanceConnection>	getActiveConnections()	Gets a List<InstanceConnectionService.InstanceConnection> representing all active connections.
InstanceId	getInstanceId()	Gets the InstanceId for this InstanceConnectionService.
String	getLocalControlAddress()	Returns the local control address.
InstanceConnectionService.InstanceBinding	openBinding(NodeId nodeId)	Gets an InstanceConnectionService.InstanceBinding which a node can then use to receive incoming data.
void	refresh()	Forces a refresh from the latest source of data immediately.
void	start()	Starts the service.
void	stop()	Stops the service.
Subscription	subscribeToConnect(Consumer<InstanceConnectionService.InstanceConnection> onConnect)	Adds a Consumer<InstanceConnectionService.InstanceConnection> that will be called when a new instance has connected to this InstanceConnectionService.
Subscription	subscribeToDisconnect(Consumer<InstanceConnectionService.InstanceConnection> onDisconnect)	Adds a Consumer<InstanceConnectionService.InstanceConnection> that will be called when a an instance has disconnected from this InstanceConnectionService.

Method Details

start

void start()

Starts the service.

stop

void stop()

Stops the service.

refresh

void refresh()

Forces a refresh from the latest source of data immediately. This will ensure that new InstanceConnectionService.InstanceConnections are added and stale ones removed immediately. All necessary events will be driven as part of this call.

getInstanceId

InstanceId getInstanceId()

Gets the InstanceId for this InstanceConnectionService.

Returns:

the InstanceId

openBinding

InstanceConnectionService.InstanceBinding openBinding(NodeId nodeId)

Gets an InstanceConnectionService.InstanceBinding which a node can then use to receive incoming data. If a binding already exists for the supplied NodeId, then an exception will be thrown.

Parameters:

nodeId - the NodeId for which the binding will be used.

Returns:

the InstanceConnectionService.InstanceBinding

getActiveConnections

List<InstanceConnectionService.InstanceConnection> getActiveConnections()

Gets a List<InstanceConnectionService.InstanceConnection> representing all active connections.

Returns:

the list of all active InstanceConnectionService.InstanceConnections

subscribeToConnect

Subscription subscribeToConnect(Consumer<InstanceConnectionService.InstanceConnection> onConnect)

Adds a Consumer<InstanceConnectionService.InstanceConnection> that will be called when a new instance has connected to this InstanceConnectionService.

Parameters:

onConnect - the Consumer<InstanceConnectionService.InstanceConnection>

Returns:

a Subscription that can be cancled later.

subscribeToDisconnect

Subscription subscribeToDisconnect(Consumer<InstanceConnectionService.InstanceConnection> onDisconnect)

Adds a Consumer<InstanceConnectionService.InstanceConnection> that will be called when a an instance has disconnected from this InstanceConnectionService.

Parameters:

onDisconnect - the Consumer<InstanceConnectionService.InstanceConnection>

Returns:

a Subscription that can be cancled later.

getLocalControlAddress

String getLocalControlAddress()

Returns the local control address. This is an address through which the a control client may be used to control the instance from within the local process space.

Returns:

the local control address.