com.sleepycat.je.utilint

Class Matchpoint

java.lang.Object

com.sleepycat.je.log.BasicVersionedWriteLoggable

com.sleepycat.je.utilint.Matchpoint

All Implemented Interfaces:

Loggable, VersionedWriteLoggable

public class Matchpoint
extends BasicVersionedWriteLoggable

This class writes out a log entry that can be used for replication syncup. It can be issued arbitrarily by the master at any point, in order to bound the syncup interval in much the way that a checkpoint bounds the recovery interval. The entry will a replicated one, which means that it will be tagged with a VLSN. Although this is a replication class, it resides in the utilint package because it is referenced in LogEntryType.java. TODO: This is currently not used. When it is used, it will be the first replicated log entry that does not have a real txn id. All replicated entries are expected to have negative ids, and the matchpoint should be exempt from Replay.updateSequences, or it should pass in a special reserved negative id, so as not to incur the assertion in Replay.updateSequences, that the txn id is < 0.

Constructor Summary

Constructors

Constructor and Description
Matchpoint() For constructing from the log.
Matchpoint(int repMasterNodeId)

Method Summary

Modifier and Type	Method and Description
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
Collection<VersionedWriteLoggable>	getEmbeddedLoggables()
int	getLastFormatChange() Returns the log version of the most recent format change for this loggable item.
int	getLogSize(int logVersion, boolean forReplication) Returns the number of bytes needed to store this object in the format for the specified log version.
int	getMasterNodeId()
long	getTransactionId()
boolean	logicalEquals(Loggable other)
void	readFromLog(ByteBuffer logBuffer, int entryVersion) Initialize this object from the data in itemBuf.
void	writeToLog(ByteBuffer logBuffer, int logVersion, boolean forReplication) Serializes this object into the specified buffer in the format for the specified log version.

Methods inherited from class com.sleepycat.je.log.BasicVersionedWriteLoggable

getLogSize, hasReplicationFormat, isReplicationFormatWorthwhile, writeToLog

Methods inherited from class java.lang.Object

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

Constructor Detail

Matchpoint

public Matchpoint(int repMasterNodeId)

Matchpoint

public Matchpoint()

For constructing from the log.

Method Detail

getMasterNodeId

public int getMasterNodeId()

getLastFormatChange

public int getLastFormatChange()

Description copied from interface: VersionedWriteLoggable

Returns the log version of the most recent format change for this loggable item.

Returns:

the log version of the most recent format change

See Also:

ReplicableLogEntry.getLastFormatChange()

getEmbeddedLoggables

public Collection<VersionedWriteLoggable> getEmbeddedLoggables()

See Also:

ReplicableLogEntry.getEmbeddedLoggables()

getLogSize

public int getLogSize(int logVersion,
                      boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Returns the number of bytes needed to store this object in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Parameters:

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

Returns:

the number of bytes to store this object for the log version

writeToLog

public void writeToLog(ByteBuffer logBuffer,
                       int logVersion,
                       boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Serializes this object into the specified buffer in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Parameters:

logBuffer - the destination buffer

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

readFromLog

public void readFromLog(ByteBuffer logBuffer,
                        int entryVersion)

Description copied from interface: Loggable

Initialize this object from the data in itemBuf.

Parameters:

logBuffer - the source buffer

entryVersion - the log version of the data

dumpLog

public void dumpLog(StringBuilder sb,
                    boolean verbose)

Description copied from interface: Loggable

Write the object into the string buffer for log dumping. Each object should be dumped without indentation or new lines and should be valid XML.

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

getTransactionId

public long getTransactionId()

Returns:

the transaction id embedded within this loggable object. Objects that have no transaction id should return 0.

logicalEquals

public boolean logicalEquals(Loggable other)

Returns:

true if these two loggable items are logically the same. Used for replication testing.