org.corfudb.protocols.wireprotocol

Class TokenRequest

java.lang.Object

org.corfudb.protocols.wireprotocol.TokenRequest

All Implemented Interfaces:

ICorfuPayload<TokenRequest>

public class TokenRequest
extends Object
implements ICorfuPayload<TokenRequest>

A token request is at the heart of the Corfu log protocol.

There are four token request scenarios, designated by the relevant constants : 0. TokenRequest::TK_QUERY : Query of the current log tail and of specific stream-tails. 1. TokenRequest::TK_RAW : Ask for raw (global) log token(s). This extends the global log tail by the requested # of tokens. 2. TokenRequest::TK_MULTI_STREAM : Ask for token(s) on multiple streams. This extends both the global log tail, and each of the specified stream tails, by the requested # of tokens. 3. TokenRequest::TK_TX : First, check transaction resolution. If transaction can commit, then behave like TokenRequest::TK_MULTI_STREAM.

Nested Class Summary

Nested classes/interfaces inherited from interface org.corfudb.protocols.wireprotocol.ICorfuPayload

ICorfuPayload.PayloadConstructor<T>

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TK_MULTI_STREAM
static byte	TK_QUERY
static byte	TK_RAW
static byte	TK_TX

Fields inherited from interface org.corfudb.protocols.wireprotocol.ICorfuPayload

constructorMap, lookup

Constructor Summary

Constructors

Constructor and Description
TokenRequest(io.netty.buffer.ByteBuf buf) Deserialization Constructor from Bytebuf to TokenRequest.
TokenRequest(Long numTokens, List<UUID> streams) Constructor for generating TokenRequest.
TokenRequest(Long numTokens, List<UUID> streams, TxResolutionInfo conflictInfo) Constructor for generating TokenRequest.

Method Summary

Modifier and Type	Method and Description
void	doSerialize(io.netty.buffer.ByteBuf buf)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corfudb.protocols.wireprotocol.ICorfuPayload

enumMapFromBuffer, fromBuffer, fromBuffer, listFromBuffer, mapFromBuffer, rangeFromBuffer, rangeSetFromBuffer, serialize, setFromBuffer

Field Detail

TK_QUERY

public static final byte TK_QUERY

See Also:

Constant Field Values

TK_RAW

public static final byte TK_RAW

See Also:

Constant Field Values

TK_MULTI_STREAM

public static final byte TK_MULTI_STREAM

See Also:

Constant Field Values

TK_TX

public static final byte TK_TX

See Also:

Constant Field Values

Constructor Detail

TokenRequest

public TokenRequest(Long numTokens,
                    List<UUID> streams,
                    TxResolutionInfo conflictInfo)

Constructor for generating TokenRequest.

Parameters:

numTokens - number of tokens to request

streams - streams UUIDs required in the token request

conflictInfo - transaction resolution information

TokenRequest

public TokenRequest(Long numTokens,
                    List<UUID> streams)

Constructor for generating TokenRequest.

Parameters:

numTokens - number of tokens to request

streams - streams UUIDs required in the token request

TokenRequest

public TokenRequest(io.netty.buffer.ByteBuf buf)

Deserialization Constructor from Bytebuf to TokenRequest.

Parameters:

buf - The buffer to deserialize

Method Detail

doSerialize

public void doSerialize(io.netty.buffer.ByteBuf buf)

Specified by:

doSerialize in interface ICorfuPayload<TokenRequest>