com.sleepycat.je.rep.stream

Class BaseProtocol

java.lang.Object

com.sleepycat.je.rep.utilint.BinaryProtocol

com.sleepycat.je.rep.stream.BaseProtocol

Direct Known Subclasses:

Protocol

public abstract class BaseProtocol
extends BinaryProtocol

Defines the base protocol of messages used to set up a stream between source and target. Note BaseProtocol represents a set of basic protocol operations intended to be used by subclasses. For a complete description of message operations used in JE HA protocol, please see the Protocol class in the same package.

See Also:

Protocol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseProtocol.Ack Message of an ack op
class	BaseProtocol.AlternateMatchpoint
class	BaseProtocol.Commit Message of a commit op
class	BaseProtocol.Entry A message containing a log entry in the replication stream.
class	BaseProtocol.EntryNotFound Response when the EntryRequest asks for a VLSN that is below the VLSN range covered by the Feeder.
class	BaseProtocol.EntryRequest A replica node asks a feeder for the log entry at this VLSN.
static class	BaseProtocol.EntryRequestType Type of entry request sent to feeder RV: VLSN requested by client LOW: low end of available VLSN range in vlsn index HIGH: high end of available VLSN range in vlsn index The DEFAULT mode is used by existing replication stream consumer e.g.
class	BaseProtocol.GroupAck
protected class	BaseProtocol.HandshakeMessage Base class for all protocol handshake messages.
class	BaseProtocol.Heartbeat
class	BaseProtocol.HeartbeatResponse
protected class	BaseProtocol.ProtocolVersion Version broadcasts the sending node's protocol version.
class	BaseProtocol.RestoreRequest Request from the replica to the feeder for sufficient information to start a network restore.
class	BaseProtocol.RestoreResponse Response when the replica needs information to instigate a network restore.
class	BaseProtocol.ShutdownRequest Message used to shutdown a node
class	BaseProtocol.ShutdownResponse Message in response to a shutdown request.
class	BaseProtocol.StartStream StartStream indicates that the replica would like the feeder to start the replication stream at the proposed vlsn.
protected class	BaseProtocol.VLSNMessage Base class for messages which contain only a VLSN

Nested classes/interfaces inherited from class com.sleepycat.je.rep.utilint.BinaryProtocol

BinaryProtocol.ClientVersion, BinaryProtocol.IncompatibleVersion, BinaryProtocol.Message, BinaryProtocol.MessageOp, BinaryProtocol.ProtocolError, BinaryProtocol.ProtocolException, BinaryProtocol.RejectMessage, BinaryProtocol.ServerVersion, BinaryProtocol.SimpleMessage

Field Summary

Fields

Modifier and Type	Field and Description
static BinaryProtocol.MessageOp	ACK
static BinaryProtocol.MessageOp	ALT_MATCHPOINT
static BinaryProtocol.MessageOp	COMMIT
static BinaryProtocol.MessageOp	ENTRY
static BinaryProtocol.MessageOp	ENTRY_NOTFOUND
static BinaryProtocol.MessageOp	ENTRY_REQUEST
static BinaryProtocol.MessageOp	GROUP_ACK
static BinaryProtocol.MessageOp	HEARTBEAT
static BinaryProtocol.MessageOp	HEARTBEAT_RESPONSE
protected static short	MAX_MESSAGE_OP_CODE_IN_SUBCLASS
static int	MAX_VERSION
protected static short	MIN_MESSAGE_OP_CODE_IN_SUBCLASS
protected LongStat	nAckMessages
protected LongStat	nGroupAckMessages
protected LongStat	nGroupedAcks
protected LongMaxStat	nMaxGroupedAcks
protected RepImpl	repImpl
static BinaryProtocol.MessageOp	RESTORE_REQUEST
static BinaryProtocol.MessageOp	RESTORE_RESPONSE
static BinaryProtocol.MessageOp	SHUTDOWN_REQUEST
static BinaryProtocol.MessageOp	SHUTDOWN_RESPONSE
static BinaryProtocol.MessageOp	START_STREAM
protected int	streamLogVersion The log version of the format used to write log entries to the stream.
static JEVersion	VERSION_3_JE_VERSION
static JEVersion	VERSION_4_JE_VERSION
static int	VERSION_5
static JEVersion	VERSION_5_JE_VERSION
static int	VERSION_6
static JEVersion	VERSION_6_JE_VERSION
static int	VERSION_7
static JEVersion	VERSION_7_JE_VERSION
static int	VERSION_8
static JEVersion	VERSION_8_JE_VERSION
static int	VERSION_9
static JEVersion	VERSION_9_JE_VERSION

Fields inherited from class com.sleepycat.je.rep.utilint.BinaryProtocol

CLIENT_VERSION, codeVersion, configuredVersion, envImpl, formatter, header, INCOMPATIBLE_VERSION, logger, MESSAGE_HEADER_SIZE, nameIdPair, nBytesRead, nBytesWritten, nEntriesWrittenOldVersion, nMessageBatches, nMessagesBatched, nMessagesRead, nMessagesWritten, nReadNanos, nWriteNanos, PROTOCOL_ERROR, SERVER_VERSION, stats

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseProtocol(RepImpl repImpl, NameIdPair nameIdPair, int protocolVersion, int maxProtocolVersion, int streamLogVersion, BinaryProtocol.MessageOp[] protocolOps) Returns a BaseProtocol object configured that implements the specified (supported) protocol version, with enforced message operation code validity check.

Method Summary

Modifier and Type	Method and Description
boolean	getFixLogVersion12Entries() Returns whether log entries need their log versions fixed to work around [#25222].
int	getStreamLogVersion()
void	setFixLogVersion12Entries(boolean value) Sets whether log entries need their log versions fixed to work around [#25222].
void	setStreamLogVersion(int streamLogVersion) Invoked in cases where the stream log version is not known at the time the protocol object is created and stream log version negotiations are required to determine the version that will be used for log records sent over the HA stream.
protected void	writeOutputWireRecord(OutputWireRecord record, ByteBuffer messageBuffer) Write an entry output wire record to the message buffer using the write log version format and increment nEntriesWrittenOldVersion if the entry format was changed.

Methods inherited from class com.sleepycat.je.rep.utilint.BinaryProtocol

bufferWrite, flushBufferedWrites, getPredefinedMessageCount, getStats, getString, getVersion, initializeMessageOps, messageCount, putString, read, read, resetStats, stringSize, write, write

Methods inherited from class java.lang.Object

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

Field Detail

MAX_VERSION

public static final int MAX_VERSION

See Also:

Constant Field Values

VERSION_9

public static final int VERSION_9

See Also:

Constant Field Values

VERSION_9_JE_VERSION

public static final JEVersion VERSION_9_JE_VERSION

VERSION_8

public static final int VERSION_8

See Also:

Constant Field Values

VERSION_8_JE_VERSION

public static final JEVersion VERSION_8_JE_VERSION

VERSION_7

public static final int VERSION_7

See Also:

Constant Field Values

VERSION_7_JE_VERSION

public static final JEVersion VERSION_7_JE_VERSION

VERSION_6

public static final int VERSION_6

See Also:

Constant Field Values

VERSION_6_JE_VERSION

public static final JEVersion VERSION_6_JE_VERSION

VERSION_5

public static final int VERSION_5

See Also:

Constant Field Values

VERSION_5_JE_VERSION

public static final JEVersion VERSION_5_JE_VERSION

VERSION_4_JE_VERSION

public static final JEVersion VERSION_4_JE_VERSION

VERSION_3_JE_VERSION

public static final JEVersion VERSION_3_JE_VERSION

MIN_MESSAGE_OP_CODE_IN_SUBCLASS

protected static final short MIN_MESSAGE_OP_CODE_IN_SUBCLASS

See Also:

Constant Field Values

MAX_MESSAGE_OP_CODE_IN_SUBCLASS

protected static final short MAX_MESSAGE_OP_CODE_IN_SUBCLASS

See Also:

Constant Field Values

ENTRY

public static final BinaryProtocol.MessageOp ENTRY

START_STREAM

public static final BinaryProtocol.MessageOp START_STREAM

HEARTBEAT

public static final BinaryProtocol.MessageOp HEARTBEAT

HEARTBEAT_RESPONSE

public static final BinaryProtocol.MessageOp HEARTBEAT_RESPONSE

COMMIT

public static final BinaryProtocol.MessageOp COMMIT

ACK

public static final BinaryProtocol.MessageOp ACK

ENTRY_REQUEST

public static final BinaryProtocol.MessageOp ENTRY_REQUEST

ENTRY_NOTFOUND

public static final BinaryProtocol.MessageOp ENTRY_NOTFOUND

ALT_MATCHPOINT

public static final BinaryProtocol.MessageOp ALT_MATCHPOINT

RESTORE_REQUEST

public static final BinaryProtocol.MessageOp RESTORE_REQUEST

RESTORE_RESPONSE

public static final BinaryProtocol.MessageOp RESTORE_RESPONSE

SHUTDOWN_REQUEST

public static final BinaryProtocol.MessageOp SHUTDOWN_REQUEST

SHUTDOWN_RESPONSE

public static final BinaryProtocol.MessageOp SHUTDOWN_RESPONSE

GROUP_ACK

public static final BinaryProtocol.MessageOp GROUP_ACK

streamLogVersion

protected int streamLogVersion

The log version of the format used to write log entries to the stream.

nAckMessages

protected final LongStat nAckMessages

nGroupAckMessages

protected final LongStat nGroupAckMessages

nGroupedAcks

protected final LongStat nGroupedAcks

nMaxGroupedAcks

protected final LongMaxStat nMaxGroupedAcks

repImpl

protected final RepImpl repImpl

Constructor Detail

BaseProtocol

protected BaseProtocol(RepImpl repImpl,
                       NameIdPair nameIdPair,
                       int protocolVersion,
                       int maxProtocolVersion,
                       int streamLogVersion,
                       BinaryProtocol.MessageOp[] protocolOps)

Returns a BaseProtocol object configured that implements the specified (supported) protocol version, with enforced message operation code validity check. This constructor enforces checking validity of message operation code. It should be used in any subclass except the legacy HA protocol in je.stream.Protocol.

Parameters:

repImpl - the node using the protocol

nameIdPair - name-id pair of the node using the protocol

protocolVersion - the version of the protocol that must be implemented by this object

maxProtocolVersion - the highest supported protocol version, which may be lower than the code version, for testing purposes

streamLogVersion - the log version of the format used to write log entries

protocolOps - the message operations that make up this protocol

Method Detail

getStreamLogVersion

public int getStreamLogVersion()

setStreamLogVersion

public void setStreamLogVersion(int streamLogVersion)

Invoked in cases where the stream log version is not known at the time the protocol object is created and stream log version negotiations are required to determine the version that will be used for log records sent over the HA stream.

Parameters:

streamLogVersion - the maximum log version associated with stream records

getFixLogVersion12Entries

public boolean getFixLogVersion12Entries()

Returns whether log entries need their log versions fixed to work around [#25222].

setFixLogVersion12Entries

public void setFixLogVersion12Entries(boolean value)

Sets whether log entries need their log versions fixed to work around [#25222].

writeOutputWireRecord

protected void writeOutputWireRecord(OutputWireRecord record,
                                     ByteBuffer messageBuffer)

Write an entry output wire record to the message buffer using the write log version format and increment nEntriesWrittenOldVersion if the entry format was changed.