com.sleepycat.je.rep.utilint

Class BinaryProtocol.Message

java.lang.Object

com.sleepycat.je.rep.utilint.BinaryProtocol.Message

All Implemented Interfaces:

BinaryProtocol.WireFormatable

Direct Known Subclasses:

BinaryProtocol.SimpleMessage, Protocol.Ack, Protocol.AlternateMatchpoint, Protocol.Entry, Protocol.EntryNotFound, Protocol.Heartbeat, Protocol.HeartbeatResponse, Protocol.ShutdownResponse, Protocol.VLSNMessage

Enclosing class:

BinaryProtocol

public abstract class BinaryProtocol.Message
extends java.lang.Object
implements BinaryProtocol.WireFormatable

Base message class for all messages exchanged in the protocol. Serialized layout of a message: - opType (short) - size of the body of the message (int) - body of the message - message specific fields

All non-abstract subclasses must implement a constructor with a ByteBuffer argument. This constructor is used during serialization to recreate the Message instance. It's considered good practice to declare all attributes of a message as final. It's a simple way to ensure that the above constructor has initialized all the attributes of the message.

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	allocateInitializedBuffer(int size) Allocate a buffer for the message with the header initialized.
abstract BinaryProtocol.MessageOp	getOp()
boolean	match(BinaryProtocol.Message other)
java.lang.String	toString()
java.nio.ByteBuffer	wireFormat() The default message consists of the operation enum and just a 0 length size.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Method Detail

getOp

public abstract BinaryProtocol.MessageOp getOp()

wireFormat

public java.nio.ByteBuffer wireFormat()

The default message consists of the operation enum and just a 0 length size.

Specified by:

wireFormat in interface BinaryProtocol.WireFormatable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

match

public boolean match(BinaryProtocol.Message other)

allocateInitializedBuffer

public java.nio.ByteBuffer allocateInitializedBuffer(int size)

Allocate a buffer for the message with the header initialized.

Parameters:

size - size of the message contents following the buffer

Returns:

the initialized buffer