org.corfudb.runtime.object

Interface ICorfuSMRProxy<T>

Type Parameters:

T - The type of the SMR object. Created by mwei on 11/10/16.

All Known Subinterfaces:

ICorfuSMRProxyInternal<T>

All Known Implementing Classes:

CorfuCompileProxy

public interface ICorfuSMRProxy<T>

An interface for accessing a proxy, which manages an SMR object.

Method Summary

Modifier and Type	Method and Description
<R> R	access(ICorfuSMRAccess<R,T> accessMethod, Object[] conflictObject) Access the state of the object.
IObjectBuilder<?>	getObjectBuilder() Get an object builder to build new objects.
Class<T>	getObjectType() Return the type of the object being replicated.
UUID	getStreamID() Get the ID of the stream this proxy is subscribed to.
<R> R	getUpcallResult(long timestamp, Object[] conflictObject) Return the result of an upcall at the given timestamp.
long	getVersion() Get the latest version read by the proxy.
long	logUpdate(String smrUpdateFunction, boolean keepUpcallResult, Object[] conflictObject, Object... args) Record an SMR function to the log before returning.
void	sync() Update the proxy to the latest committed version.
<R> R	TXExecute(Supplier<R> txFunction) Run in a transactional context.

Method Detail

access

<R> R access(ICorfuSMRAccess<R,T> accessMethod,
             Object[] conflictObject)

Access the state of the object.

Type Parameters:

R - The type to return.

Parameters:

accessMethod - The method to execute when accessing an object.

conflictObject - Fine-grained conflict information, if available.

Returns:

The result of the accessMethod

logUpdate

long logUpdate(String smrUpdateFunction,
               boolean keepUpcallResult,
               Object[] conflictObject,
               Object... args)

Record an SMR function to the log before returning.

Parameters:

smrUpdateFunction - The name of the function to record.

keepUpcallResult - Whether or not we need to keep the result to the upcall, for a subsequent call to getUpcallResult.

conflictObject - Fine-grained conflict information, if available.

args - The arguments to the function.

Returns:

The address in the log the SMR function was recorded at.

getUpcallResult

<R> R getUpcallResult(long timestamp,
                      Object[] conflictObject)

Return the result of an upcall at the given timestamp.

Type Parameters:

R - The type of the upcall to return.

Parameters:

timestamp - The timestamp to request the upcall for.

conflictObject - Fine-grained conflict information, if available.

Returns:

The result of the upcall.

sync

void sync()

Update the proxy to the latest committed version.

getStreamID

UUID getStreamID()

Get the ID of the stream this proxy is subscribed to.

Returns:

The UUID of the stream this proxy is subscribed to.

TXExecute

<R> R TXExecute(Supplier<R> txFunction)

Run in a transactional context.

Type Parameters:

R - The return type.

Parameters:

txFunction - The function to run in a transactional context.

Returns:

The value supplied by the function.

getObjectBuilder

IObjectBuilder<?> getObjectBuilder()

Get an object builder to build new objects.

Returns:

An object which permits the construction of new objects.

getObjectType

Class<T> getObjectType()

Return the type of the object being replicated.

Returns:

The type of the replicated object.

getVersion

long getVersion()

Get the latest version read by the proxy.

Returns:

The latest version read by the proxy.