com.sleepycat.je.rep.impl.networkRestore

Class Protocol

java.lang.Object

com.sleepycat.je.rep.utilint.BinaryProtocol

com.sleepycat.je.rep.impl.networkRestore.Protocol

public class Protocol
extends BinaryProtocol

The protocol used to obtain backup files from a LF Feeder. The message exchange is always initiated by the client. The following describes the request/response messages exchanged between the two nodes: FeederInfoReq -> FeederInfoResp FileListReq -> FileListResp FileInfoReq -> FileInfoResp FileReq -> FileStart <byte stream> FileEnd Done So a complete sequence of successful request messages looks like: FeederInfoReq FileListReq [[FileInfoReq] [FileReq] ]+ Done A response sequence would look like: FeederInfoResp FileListResp [[FileInfoResp] [FileStart byte stream FileEnd] ]+ The client may abandon its interaction with the server if it decides the server is overloaded. The client tries to minimize the number of files it actually requests based upon its current state. When a FileReq is received by the server, other files previously requested (using FileReq) may be deleted by the server. These previously requested files must not be requested again using FileReq or FileReqInfo.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Protocol.Done Message from client indicating it's done with all the files it needs and that the connection can be terminated.
class	Protocol.FeederInfoReq
class	Protocol.FeederInfoResp
class	Protocol.FileEnd The message ending the response triple: FileStart byte stream FileEnd
class	Protocol.FileInfoReq Requests information about a specific log file.
class	Protocol.FileInfoResp
class	Protocol.FileListReq
class	Protocol.FileListResp
class	Protocol.FileReq Requests that a specific file be sent to the client.
class	Protocol.FileStart The message starting the response triple: FileStart byte stream FileEnd

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
BinaryProtocol.MessageOp	DONE
BinaryProtocol.MessageOp	FEEDER_INFO_REQ
BinaryProtocol.MessageOp	FEEDER_INFO_RESP
BinaryProtocol.MessageOp	FILE_END
BinaryProtocol.MessageOp	FILE_INFO_REQ
BinaryProtocol.MessageOp	FILE_INFO_RESP
BinaryProtocol.MessageOp	FILE_LIST_REQ
BinaryProtocol.MessageOp	FILE_LIST_RESP
BinaryProtocol.MessageOp	FILE_REQ
BinaryProtocol.MessageOp	FILE_START
static int	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

Constructor and Description
Protocol(NameIdPair nameIdPair, int configuredVersion, EnvironmentImpl envImpl)

Method Summary

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

VERSION

public static final int VERSION

See Also:

Constant Field Values

FEEDER_INFO_REQ

public final BinaryProtocol.MessageOp FEEDER_INFO_REQ

FEEDER_INFO_RESP

public final BinaryProtocol.MessageOp FEEDER_INFO_RESP

FILE_LIST_REQ

public final BinaryProtocol.MessageOp FILE_LIST_REQ

FILE_LIST_RESP

public final BinaryProtocol.MessageOp FILE_LIST_RESP

FILE_REQ

public final BinaryProtocol.MessageOp FILE_REQ

FILE_START

public final BinaryProtocol.MessageOp FILE_START

FILE_END

public final BinaryProtocol.MessageOp FILE_END

FILE_INFO_REQ

public final BinaryProtocol.MessageOp FILE_INFO_REQ

FILE_INFO_RESP

public final BinaryProtocol.MessageOp FILE_INFO_RESP

DONE

public final BinaryProtocol.MessageOp DONE

Constructor Detail

Protocol

public Protocol(NameIdPair nameIdPair,
                int configuredVersion,
                EnvironmentImpl envImpl)