com.sleepycat.je.rep.stream

Class Protocol

java.lang.Object

com.sleepycat.je.rep.utilint.BinaryProtocol

com.sleepycat.je.rep.stream.BaseProtocol

com.sleepycat.je.rep.stream.Protocol

public class Protocol
extends BaseProtocol

Defines the messages used to set up a feeder-replica replication stream. Note: this protocol is an extension of je.rep.stream.BaseProtocol, which defines a set of basic message operation codes that are to be used by its subclasses. From Feeder to Replica Heartbeat -> HeartbeatResponse Commit -> Ack Commit+ -> GroupAck Entry ShutdownRequest -> ShutdownResponse Note: in the future, we may want to support bulk entry messages From Replica to Feeder The following subset of messages represents the handshake protocol that precedes the transmission of replication log entries. ReplicaProtocolVersion -> FeederProtocolVersion | DuplicateNodeReject ReplicaJEVersions -> FeederJEVersions | JEVersionsReject NodeGroupInfo -> NodeGroupInfoOK | NodeGroupInfoReject SNTPRequest -> SNTPResponse -> HeartbeatResponse A HeartbeatResponse is not strictly a response message and may also be sent spontaneously if there is no output activity in a heartbeat interval. This spontaneous generation of a HeartbeatReponse ensures that a socket is not timed out if the feeder or the replica replay are otherwise busy. Note that there may be multiple SNTPRequest/SNTPResponse message pairs that are exchanged as part of a single handshake. So a successful handshake requested sequence generated by the Replica looks like: ReplicaProtocolVersion ReplicaJEVersions MembershipInfo [SNTPRequest]+ For a Subscriber, there is an optional additional message exchange used to discover the database ID for the partition generation database if the name of the database was supplied and the message is supported by the protocol version: DBIDRequest -> DBIDResponse The following messages constitute the syncup and the transmission of log entries. EntryRequest -> Entry | EntryNotFound | AlternateMatchpoint RestoreRequest -> RestoreResponse StartStream The Protocol instance has local state in terms of buffers that are reused across multiple messages. A Protocol instance is expected to be used in strictly serial fashion. Consequently, there is an instance for each Replica to Feeder connection, and two instances per Feeder to Replica connection: one for the InputThread and one for the OutputThread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Protocol.DBIdRequest Request for the partition gen db id
class	Protocol.DBIdResponse Response when the PartMDRequest asks for partition md db id
class	Protocol.DuplicateNodeReject
class	Protocol.FeederJEVersions
class	Protocol.FeederProtocolVersion The feeder sends the replica its proposed version.
class	Protocol.JEVersionsReject
class	Protocol.NodeGroupInfo
class	Protocol.NodeGroupInfoOK Response to a NodeGroupInfo request that was successful.
class	Protocol.NodeGroupInfoReject
class	Protocol.ReAuthenticate
class	Protocol.ReplicaJEVersions
class	Protocol.ReplicaProtocolVersion The replica sends the feeder its protocol version.
class	Protocol.SecurityFailureResponse Security check failure response message
class	Protocol.SNTPRequest
class	Protocol.SNTPResponse

Nested classes/interfaces inherited from class com.sleepycat.je.rep.stream.BaseProtocol

BaseProtocol.Ack, BaseProtocol.AlternateMatchpoint, BaseProtocol.Commit, BaseProtocol.Entry, BaseProtocol.EntryNotFound, BaseProtocol.EntryRequest, BaseProtocol.EntryRequestType, BaseProtocol.GroupAck, BaseProtocol.HandshakeMessage, BaseProtocol.Heartbeat, BaseProtocol.HeartbeatResponse, BaseProtocol.ProtocolVersion, BaseProtocol.RestoreRequest, BaseProtocol.RestoreResponse, BaseProtocol.ShutdownRequest, BaseProtocol.ShutdownResponse, BaseProtocol.StartStream, BaseProtocol.VLSNMessage

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	DBID_REQUEST
static BinaryProtocol.MessageOp	DBID_RESPONSE
static BinaryProtocol.MessageOp	DUP_NODE_REJECT
static BinaryProtocol.MessageOp	FEEDER_JE_VERSIONS
static BinaryProtocol.MessageOp	FEEDER_PROTOCOL_VERSION
static BinaryProtocol.MessageOp	JE_VERSIONS_REJECT
static BinaryProtocol.MessageOp	MEMBERSHIP_INFO
static BinaryProtocol.MessageOp	MEMBERSHIP_INFO_OK
static BinaryProtocol.MessageOp	MEMBERSHIP_INFO_REJECT
static BinaryProtocol.MessageOp	REAUTHENTICATE
static BinaryProtocol.MessageOp	REPLICA_JE_VERSIONS
static BinaryProtocol.MessageOp	REPLICA_PROTOCOL_VERSION Normally the op code should fall in the range defined in BaseProtocol, however following op code inherit from original implementation of stream protocol thus we just copy them here for backward compatibility.
static BinaryProtocol.MessageOp	SECURITY_FAILURE_RESPONSE
static BinaryProtocol.MessageOp	SNTP_REQUEST
static BinaryProtocol.MessageOp	SNTP_RESPONSE

Fields inherited from class com.sleepycat.je.rep.stream.BaseProtocol

ACK, ALT_MATCHPOINT, COMMIT, ENTRY, ENTRY_NOTFOUND, ENTRY_REQUEST, GROUP_ACK, HEARTBEAT, HEARTBEAT_RESPONSE, MAX_MESSAGE_OP_CODE_IN_SUBCLASS, MAX_VERSION, MIN_MESSAGE_OP_CODE_IN_SUBCLASS, nAckMessages, nGroupAckMessages, nGroupedAcks, nMaxGroupedAcks, repImpl, RESTORE_REQUEST, RESTORE_RESPONSE, SHUTDOWN_REQUEST, SHUTDOWN_RESPONSE, START_STREAM, streamLogVersion, VERSION_3_JE_VERSION, VERSION_4_JE_VERSION, VERSION_5, VERSION_5_JE_VERSION, VERSION_6, VERSION_6_JE_VERSION, VERSION_7, VERSION_7_JE_VERSION, VERSION_8, VERSION_8_JE_VERSION, VERSION_9, 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

Method Summary

Modifier and Type	Method and Description
static Protocol	get(RepImpl repImpl, NameIdPair nameIdPair, RepUtils.Clock clock, int protocolVersion, int maxProtocolVersion, int groupFormatVersion)
static Protocol	get(RepImpl repImpl, NameIdPair nameIdPair, RepUtils.Clock clock, int protocolVersion, int maxProtocolVersion, int streamLogVersion, int groupFormatVersion)
static Protocol	get(RepNode repNode, int protocolVersion, int maxProtocolVersion) Returns a protocol object that supports the specific requested protocol version, which must not be higher than the specified maximum version, or null if no such version is supported.
static Protocol	get(RepNode repNode, int protocolVersion, int maxProtocolVersion, int streamLogVersion) Returns a protocol object that supports the specified protocol, which must be less than the specified maximum version, and writes log entries in the specified log version format.

Methods inherited from class com.sleepycat.je.rep.stream.BaseProtocol

getFixLogVersion12Entries, getStreamLogVersion, setFixLogVersion12Entries, setStreamLogVersion, writeOutputWireRecord

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

REPLICA_PROTOCOL_VERSION

public static final BinaryProtocol.MessageOp REPLICA_PROTOCOL_VERSION

Normally the op code should fall in the range defined in BaseProtocol, however following op code inherit from original implementation of stream protocol thus we just copy them here for backward compatibility.

FEEDER_PROTOCOL_VERSION

public static final BinaryProtocol.MessageOp FEEDER_PROTOCOL_VERSION

DUP_NODE_REJECT

public static final BinaryProtocol.MessageOp DUP_NODE_REJECT

REPLICA_JE_VERSIONS

public static final BinaryProtocol.MessageOp REPLICA_JE_VERSIONS

FEEDER_JE_VERSIONS

public static final BinaryProtocol.MessageOp FEEDER_JE_VERSIONS

JE_VERSIONS_REJECT

public static final BinaryProtocol.MessageOp JE_VERSIONS_REJECT

MEMBERSHIP_INFO

public static final BinaryProtocol.MessageOp MEMBERSHIP_INFO

MEMBERSHIP_INFO_OK

public static final BinaryProtocol.MessageOp MEMBERSHIP_INFO_OK

MEMBERSHIP_INFO_REJECT

public static final BinaryProtocol.MessageOp MEMBERSHIP_INFO_REJECT

SNTP_REQUEST

public static final BinaryProtocol.MessageOp SNTP_REQUEST

SNTP_RESPONSE

public static final BinaryProtocol.MessageOp SNTP_RESPONSE

REAUTHENTICATE

public static final BinaryProtocol.MessageOp REAUTHENTICATE

DBID_REQUEST

public static final BinaryProtocol.MessageOp DBID_REQUEST

DBID_RESPONSE

public static final BinaryProtocol.MessageOp DBID_RESPONSE

SECURITY_FAILURE_RESPONSE

public static final BinaryProtocol.MessageOp SECURITY_FAILURE_RESPONSE

Method Detail

get

public static Protocol get(RepNode repNode,
                           int protocolVersion,
                           int maxProtocolVersion)

Returns a protocol object that supports the specific requested protocol version, which must not be higher than the specified maximum version, or null if no such version is supported.

get

public static Protocol get(RepImpl repImpl,
                           NameIdPair nameIdPair,
                           RepUtils.Clock clock,
                           int protocolVersion,
                           int maxProtocolVersion,
                           int groupFormatVersion)

get

public static Protocol get(RepNode repNode,
                           int protocolVersion,
                           int maxProtocolVersion,
                           int streamLogVersion)

Returns a protocol object that supports the specified protocol, which must be less than the specified maximum version, and writes log entries in the specified log version format. Returns null if no such version is supported.

get

public static Protocol get(RepImpl repImpl,
                           NameIdPair nameIdPair,
                           RepUtils.Clock clock,
                           int protocolVersion,
                           int maxProtocolVersion,
                           int streamLogVersion,
                           int groupFormatVersion)