net.openhft.chronicle.hash.replication

Class ReplicationHub

java.lang.Object

net.openhft.chronicle.hash.replication.AbstractReplication

net.openhft.chronicle.hash.replication.ReplicationHub

public final class ReplicationHub
extends AbstractReplication

This class holds all configurations of multicontainer replication, which is usable, when you want to replicate several ChronicleHashes (maps, sets, etc.) between same servers. ReplicationHub allows to share TCP/UDP connection, sockets, buffers, worker threads for that, considerably reducing resources usage and increasing cumulative (for all replicated containers) replication throughput. See the corresponding section in ChronicleMap manual for more information.

Create instances of this class using this pattern:

ReplicationHub hub = ReplicationHub.builder()
     .tcpTransportAndNetwork(tcpConfig)
     // more configurations...
     .createWithId(identifierOfThisServerWithinTheChronicleReplicationNetwork);

Then, given you prepared a builder to create a ChronicleHash, configure it's replication via channel of this hub like this:

ChronicleMap myMap = builder.instance()
     .replicatedViaChannel(hub.createChannel(myMapChannelId))
     .persistedTo(myMapFile) // optional, for this example
     .create();

See Also:

ChronicleHashInstanceConfig.replicatedViaChannel(ReplicationChannel), ReplicationChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplicationHub.Builder Builder of ReplicationHubs.

Method Summary

Methods

Modifier and Type	Method and Description
static ReplicationHub.Builder	builder() Creates and returns a new ReplicationHub.Builder.
ReplicationChannel	createChannel(short channelId) Creates a new ReplicationChannel in this ReplicationHub with the given identifier.
int	maxEntrySize() Returns the maximum entry size of ChronicleHashes, replicated by this ReplicationHub, could have.
int	maxNumberOfChannels() Returns the maximum number of channels could be created for this ReplicationHub.

Methods inherited from class net.openhft.chronicle.hash.replication.AbstractReplication

identifier, remoteNodeValidator, tcpTransportAndNetwork, udpTransport

Methods inherited from class java.lang.Object

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

Method Detail

builder

@NotNull
public static ReplicationHub.Builder builder()

Creates and returns a new ReplicationHub.Builder.

Returns:

a new ReplicationHub.Builder

maxEntrySize

public int maxEntrySize()

Returns the maximum entry size of ChronicleHashes, replicated by this ReplicationHub, could have. RuntimeException is thrown on attempt to replicate with this ReplicationHub a ChronicleHash with larger entry size.

Returns:

the maximum entry size

See Also:

ReplicationHub.Builder.maxEntrySize(int)

maxNumberOfChannels

public int maxNumberOfChannels()

Returns the maximum number of channels could be created for this ReplicationHub.

Returns:

the maximum number of channels

See Also:

maxNumberOfChannels(), createChannel(short)

createChannel

public ReplicationChannel createChannel(short channelId)

Creates a new ReplicationChannel in this ReplicationHub with the given identifier. Identifier shouldn't be lesser than zero and greater or equal to maxNumberOfChannels() - 1. On a ReplicationHub instance, ReplicationChannel could be created only once for each possible channelId value.

Parameters:

channelId - the identifier of the channel. Should be equal for replicated containers on different nodes (servers)

Returns:

a new ReplicationChannel instance, in fact just incapsulating the given channelId for this ReplicationHub

Throws:

IllegalArgumentException - if the specified channelId is out of
[0, maxNumberOfChannels()) range

IllegalStateException - if ReplicationChannel with the specified channelId has already been acquired on this ReplicationHub

See Also:

ReplicationChannel