net.openhft.chronicle.map

Interface Replica.ModificationIterator

Enclosing interface:

Replica

public static interface Replica.ModificationIterator

Holds a record of which entries have modification. Each remote map supported will require a corresponding ModificationIterator instance

Method Summary

Methods

Modifier and Type	Method and Description
long	bootStrapTimeStamp()
void	dirtyEntries(long fromTimeStamp) Dirties all entries with a modification time equal to fromTimeStamp or newer.
boolean	hasNext()
boolean	nextEntry(Replica.EntryCallback callback, int chronicleId) A non-blocking call that provides the entry that has changed to callback.onEntry().
void	setModificationNotifier(Replica.ModificationNotifier modificationNotifier) the modificationNotifier is called when ever there is a change applied to the modification iterator

Method Detail

hasNext

boolean hasNext()

Returns:

true if the is another entry to be received via nextEntry(Replica.EntryCallback, int chronicleId)

nextEntry

boolean nextEntry(@NotNull
                Replica.EntryCallback callback,
                int chronicleId)
                  throws InterruptedException

A non-blocking call that provides the entry that has changed to callback.onEntry().

Parameters:

callback - a callback which will be called when a new entry becomes available.

chronicleId - only assigned when using chronicle channels

Returns:

true if the entry was accepted by the callback.onEntry() method, false if the entry was not accepted or was not available

Throws:

InterruptedException

dirtyEntries

void dirtyEntries(long fromTimeStamp)

Dirties all entries with a modification time equal to fromTimeStamp or newer. It means all these entries will be considered as "new" by this ModificationIterator and iterated once again no matter if they have already been.

This functionality is used to publish recently modified entries to a new remote node as it connects.

Parameters:

fromTimeStamp - the timestamp from which all entries should be dirty

setModificationNotifier

void setModificationNotifier(@NotNull
                           Replica.ModificationNotifier modificationNotifier)

the modificationNotifier is called when ever there is a change applied to the modification iterator

Parameters:

modificationNotifier - gets notified when a change occurs

bootStrapTimeStamp

long bootStrapTimeStamp()

Returns:

the timestamp that the remote client should bootstrap from when there has been a disconnection, this time maybe later than the message time as event are not send in chronological order from the bit set.