org.corfudb.protocols.wireprotocol

Interface ILogData

All Superinterfaces:

Comparable<ILogData>, IMetadata

All Known Implementing Classes:

LogData

public interface ILogData
extends IMetadata, Comparable<ILogData>

An interface to log data entries. Log data entries represent data stored in the actual log, with convenience methods for software to retrieve the stored information. Created by mwei on 8/17/16.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILogData.SerializationHandle This class provides a serialization handle, which manages the lifetime of the serialized copy of this entry.

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

IMetadata.DataRank, IMetadata.LogUnitMetadataType

Field Summary

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

metadataTypeMap

Method Summary

Modifier and Type	Method and Description
void	acquireBuffer()
default int	compareTo(ILogData o)
default Long	getBackpointer(UUID streamId) Return the backpointer for a particular stream.
default LogEntry	getLogEntry(CorfuRuntime runtime) Return the payload as a log entry.
Object	getPayload(CorfuRuntime t)
default ILogData.SerializationHandle	getSerializedForm()
static int	getSerializedSize(Object obj) Return the serialized size of an object
default int	getSizeEstimate() Get an estimate of how large this entry is in memory.
DataType	getType()
default boolean	hasBackpointer(UUID streamId) Return if there is backpointer for a particular stream.
default boolean	isEmpty() Return whether the entry represents an empty entry or not.
default boolean	isFirstEntry(UUID streamId) Return if this is the first entry in a particular stream.
default boolean	isHole() Return whether the entry represents a hole or not.
default boolean	isLogEntry(CorfuRuntime runtime) Return whether or not this entry is a log entry.
default boolean	isTrimmed() Return true if and only if the entry represents a trimmed address.
void	releaseBuffer()
default void	setId(UUID clientId)
default void	useToken(IToken token) Assign a given token to this log data.

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

clearCommit, containsStream, getBackpointerMap, getCheckpointedStreamId, getCheckpointedStreamStartLogAddress, getCheckpointId, getCheckpointType, getClientId, getEpoch, getGlobalAddress, getMetadataMap, getRank, getStreams, getThreadId, getToken, hasCheckpointMetadata, setBackpointerMap, setCheckpointedStreamId, setCheckpointedStreamStartLogAddress, setCheckpointId, setCheckpointType, setClientId, setCommit, setEpoch, setGlobalAddress, setRank, setThreadId

Method Detail

getPayload

Object getPayload(CorfuRuntime t)

getType

DataType getType()

compareTo

default int compareTo(ILogData o)

Specified by:

compareTo in interface Comparable<ILogData>

releaseBuffer

void releaseBuffer()

acquireBuffer

void acquireBuffer()

getSerializedForm

default ILogData.SerializationHandle getSerializedForm()

isLogEntry

default boolean isLogEntry(CorfuRuntime runtime)

Return whether or not this entry is a log entry.

getLogEntry

default LogEntry getLogEntry(CorfuRuntime runtime)

Return the payload as a log entry.

hasBackpointer

default boolean hasBackpointer(UUID streamId)

Return if there is backpointer for a particular stream.

getBackpointer

default Long getBackpointer(UUID streamId)

Return the backpointer for a particular stream.

isFirstEntry

default boolean isFirstEntry(UUID streamId)

Return if this is the first entry in a particular stream.

getSizeEstimate

default int getSizeEstimate()

Get an estimate of how large this entry is in memory.

Returns:

An estimate on the size of this object, in bytes.

isHole

default boolean isHole()

Return whether the entry represents a hole or not.

isEmpty

default boolean isEmpty()

Return whether the entry represents an empty entry or not.

isTrimmed

default boolean isTrimmed()

Return true if and only if the entry represents a trimmed address.

getSerializedSize

static int getSerializedSize(Object obj)

Return the serialized size of an object

Parameters:

obj - the entry's payload object

Returns:

size of serialized buffer

useToken

default void useToken(IToken token)

Assign a given token to this log data.

Parameters:

token - The token to use.

setId

default void setId(UUID clientId)