net.openhft.chronicle.map

Class Replicator

java.lang.Object

net.openhft.chronicle.map.Replicator

public abstract class Replicator
extends Object

See Also:

Replicators, ChronicleMapBuilder.addReplicator(Replicator)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Replicator() A constructor for use in subclasses.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Closeable	applyTo(ChronicleMapBuilder builder, Replica map, Replica.EntryExternalizable entryExternalizable) Applies the replicator to the map instance and returns a Closeable token to manage resources, associated with the replication.
abstract byte	identifier() Returns this node identifier within the replication topology.

Methods inherited from class java.lang.Object

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

Constructor Detail

Replicator

protected Replicator()

A constructor for use in subclasses.

Method Detail

identifier

public abstract byte identifier()

Returns this node identifier within the replication topology.

Returns:

the unique identifier among nodes

See Also:

Replica.identifier()

applyTo

protected abstract Closeable applyTo(ChronicleMapBuilder builder,
                Replica map,
                Replica.EntryExternalizable entryExternalizable)
                              throws IOException

Applies the replicator to the map instance and returns a Closeable token to manage resources, associated with the replication.

This method isn't intended to be called from the client code.

Parameters:

builder - the builder from which the map was constructed. The replicator may obtain some map configurations, not accessible via the map instance.

map - a replicated map instance. Provides basic tools for replication implementation.

entryExternalizable - the callback for ser/deser implementation in the replicator

Returns:

a Closeable token to control replication resources. It should be closed on closing the replicated map.

Throws:

IOException - if an io error occurred during the replicator setup

IllegalStateException - if this replicator doesn't support application to more than one map (or the specified number of maps), and this replicator has already been applied to a map (or the specified number of maps)