net.spy.memcached.tapmessage

Class RequestMessage

java.lang.Object

net.spy.memcached.compat.SpyObject

net.spy.memcached.tapmessage.BaseMessage

net.spy.memcached.tapmessage.RequestMessage

public class RequestMessage
extends BaseMessage

A tap request message that is used to start tap streams, perform sasl authentication, and maintain the health of tap streams.

Field Summary

Fields inherited from class net.spy.memcached.tapmessage.BaseMessage

HEADER_LENGTH

Constructor Summary

Constructors

Constructor and Description
RequestMessage() Create a tap request message.

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.ByteBuffer	getBytes() Encodes the message into binary.
java.util.List<TapRequestFlag>	getFlags() Returns the flags for this message.
void	setBackfill(long date) Stream all keys inserted into the server after a given date.
void	setFlags(TapRequestFlag f) Sets the flags for the tap stream.
void	setName(java.lang.String n) Sets a name for this tap stream.
void	setvBucketCheckpoints(java.util.Map<java.lang.Short,java.lang.Long> vbchkpnts) Sets a map of vbucket checkpoints.
void	setVbucketlist(short[] vbs) Sets a list of vbuckets to stream keys from.

Methods inherited from class net.spy.memcached.tapmessage.BaseMessage

getCas, getDatatype, getExtralength, getKeylength, getMagic, getMessageLength, getOpaque, getOpcode, getTotalbody, getVbucket, setCas, setDatatype, setExtralength, setMagic, setOpaque, setOpcode, setTotalbody, setVbucket

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestMessage

public RequestMessage()

Create a tap request message. These messages are used to start tap streams.

Method Detail

setFlags

public void setFlags(TapRequestFlag f)

Sets the flags for the tap stream. These flags decide what kind of tap stream will be received.

Parameters:

f - The flags to use for this tap stream.

getFlags

public java.util.List<TapRequestFlag> getFlags()

Returns the flags for this message.

Returns:

An int value of flags set for this tap message.

setBackfill

public void setBackfill(long date)

Stream all keys inserted into the server after a given date.

Parameters:

date - - The date to stream keys from. Null to stream all keys.

setVbucketlist

public void setVbucketlist(short[] vbs)

Sets a list of vbuckets to stream keys from.

Parameters:

vbs - - A list of vbuckets.

setvBucketCheckpoints

public void setvBucketCheckpoints(java.util.Map<java.lang.Short,java.lang.Long> vbchkpnts)

Sets a map of vbucket checkpoints.

Parameters:

vbchkpnts - - A map of vbucket checkpoint identifiers

setName

public void setName(java.lang.String n)

Sets a name for this tap stream. If the tap stream fails this name can be used to try to restart the tap stream from where it last left off.

Parameters:

n - The name for the tap stream.

getBytes

public java.nio.ByteBuffer getBytes()

Encodes the message into binary.

Specified by:

getBytes in class BaseMessage

Returns:

The ByteBuffer representation of the message.