org.reveno.atp.clustering.api

Interface ClusterConfiguration

All Known Implementing Classes:

RevenoClusterConfiguration

public interface ClusterConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClusterConfiguration.CommandsXmitTransport
static interface	ClusterConfiguration.MulticastConfiguration
static interface	ClusterConfiguration.SyncConfiguration
static interface	ClusterConfiguration.TimeoutsConfiguration
static interface	ClusterConfiguration.UnicastConfiguration

Method Summary

Modifier and Type	Method and Description
void	authToken(java.lang.String authToken)
void	commandsXmitTransport(ClusterConfiguration.CommandsXmitTransport transport) Denotes the style of network communication which will be used between all nodes in cluster to transfer commands from Master to Slaves.
void	currentNodeAddress(Address nodeAddress) Abstract Address which identifies current node in cluster.
void	currentNodeAddress(java.lang.String host, java.lang.String port, java.lang.String nodeId) The network address of the current node and unique Node ID.
void	currentNodeAddress(java.lang.String host, java.lang.String port, java.lang.String nodeId, IOMode mode) The network address of the current node and unique Node ID.
ClusterConfiguration.SyncConfiguration	dataSync() Data Synchronization configurations.
ClusterConfiguration.TimeoutsConfiguration	electionTimeouts() Timeouts which are used during Leadership Election process, which is started usually by membership changes, or some unexpected critical situations.
ClusterConfiguration.MulticastConfiguration	multicast() Multicast configurations, which will be used in case of commandsXmitTransport(CommandsXmitTransport) was set to MULTICAST.
void	nodesAddresses(java.util.List<Address> nodeAddresses) List of other parties addresses.
void	nodesInetAddresses(java.util.List<InetAddress> addresses) List of other parties network addresses.
void	priorityInCluster(int priority) Priority in cluster, which allows to effectively foresee next elected Masters in case of failure of previous ones.
ClusterConfiguration.UnicastConfiguration	unicast() Unicast configrations, which will be used in cast of commandsXmitTransport(CommandsXmitTransport) was set to UNICAST.

Method Detail

currentNodeAddress

void currentNodeAddress(java.lang.String host,
                        java.lang.String port,
                        java.lang.String nodeId)

The network address of the current node and unique Node ID. Depending on the concrete Cluster and ClusterBuffer implementation, used in current Reveno instance, this host and port will be used for tcp binding, and Node ID for unique representation of the current node with multicast failover.

Parameters:

host - of the current node in cluster

port - of the current node in cluster

nodeId - unqiue node identificator in among cluster

currentNodeAddress

void currentNodeAddress(java.lang.String host,
                        java.lang.String port,
                        java.lang.String nodeId,
                        IOMode mode)

The network address of the current node and unique Node ID. Depending on the concrete ClusterProvider implementation, used in current Reveno instance, this host and port will be used for tcp binding, and Node ID for unique representation of the current node with multicast failover.

Parameters:

host - of the current node in cluster

port - of the current node in cluster

nodeId - unqiue node identificator in among cluster

mode - of IO between other nodes

currentNodeAddress

void currentNodeAddress(Address nodeAddress)

Abstract Address which identifies current node in cluster. It should be provided in the format, which currently used ClusterProvider can understand it.

Parameters:

nodeAddress - of current node in Reveno cluster

nodesInetAddresses

void nodesInetAddresses(java.util.List<InetAddress> addresses)

List of other parties network addresses.

Parameters:

addresses -

nodesAddresses

void nodesAddresses(java.util.List<Address> nodeAddresses)

List of other parties addresses.

Parameters:

nodeAddresses -

commandsXmitTransport

void commandsXmitTransport(ClusterConfiguration.CommandsXmitTransport transport)

Denotes the style of network communication which will be used between all nodes in cluster to transfer commands from Master to Slaves. Currently, it supports two possible values: UNICAST and MULTICAST. You should also note, that with any value used here, all communications between nodes are reliable, means the loss or corruption of data is always processed according to the situation, guaranteeing ordering, data integrity, and etc. UNICAST is a one-to one connection between all hosts in cluster. It uses TCP NIO2 under the hood. It is most reliable option since TCP by itself provide ordering and ack capabilities, but in some environments it might scale not so well. MULTICAST works like broadcast, with differences like subscription basis, etc. It uses UDP protocol, which means that no connections to other parties will be opened, and the packet will be sent only once, routed to many. With good network configuration, it scales much better than TCP. But be aware, that usually multicast connections are not possible in internet environment. Read more about all options on http://reveno.org

Parameters:

transport - type to be used for commands transfer.

multicast

ClusterConfiguration.MulticastConfiguration multicast()

Multicast configurations, which will be used in case of commandsXmitTransport(CommandsXmitTransport) was set to MULTICAST.

Returns:

multicast configuration

unicast

ClusterConfiguration.UnicastConfiguration unicast()

Unicast configrations, which will be used in cast of commandsXmitTransport(CommandsXmitTransport) was set to UNICAST.

Returns:

unicast configuration

electionTimeouts

ClusterConfiguration.TimeoutsConfiguration electionTimeouts()

Timeouts which are used during Leadership Election process, which is started usually by membership changes, or some unexpected critical situations.

Returns:

timeouts configuration

dataSync

ClusterConfiguration.SyncConfiguration dataSync()

Data Synchronization configurations. Data Synchronization is a process, which is issued at some stage of Leadership Election process. First, nodes sends to each other their last transaction IDs processed. After that, somes might discover that their internal state is not the last in cluster. In that case, they ask the node with the most actual state to share last transactions / snapshot, efficiently syncing with it. After all nodes share the same state, they can continue to operate.

Returns:

sync configuration

authToken

void authToken(java.lang.String authToken)

priorityInCluster

void priorityInCluster(int priority)

Priority in cluster, which allows to effectively foresee next elected Masters in case of failure of previous ones. The lower value, the more possibility that this node will be elected as Master in next election round.

Parameters:

priority - of the node