org.corfudb.runtime.object

Class CorfuCompileProxy<T>

java.lang.Object

org.corfudb.runtime.object.CorfuCompileProxy<T>

All Implemented Interfaces:

ICorfuSMRProxy<T>, ICorfuSMRProxyInternal<T>

public class CorfuCompileProxy<T>
extends Object
implements ICorfuSMRProxyInternal<T>

In the Corfu runtime, on top of a stream, an SMR object layer implements objects whose history of updates are backed by a stream.

This class implements the methods that an in-memory corfu-object proxy carries in order to by in sync with a stream.

We refer to the program's object as the -corfu object-, and to the internal object implementation as the -proxy-.

If a Corfu object's method is an Accessor, it invokes the proxy's access() method.

If a Corfu object's method is a Mutator or Accessor-Mutator, it invokes the proxy's logUpdate() method.

Finally, if a Corfu object's method is an Accessor-Mutator, it obtains a result by invoking getUpcallResult().

Created by mwei on 11/11/16.

Constructor Summary

Constructors

Constructor and Description
CorfuCompileProxy(CorfuRuntime rt, UUID streamID, Class<T> type, Object[] args, ISerializer serializer, Map<String,ICorfuSMRUpcallTarget<T>> upcallTargetMap, Map<String,IUndoFunction<T>> undoTargetMap, Map<String,IUndoRecordFunction<T>> undoRecordTargetMap, Set<String> resetSet) Deprecated.

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.
String	toString()
<R> R	TXExecute(Supplier<R> txFunction) Run in a transactional context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corfudb.runtime.object.ICorfuSMRProxyInternal

getSerializer, getUnderlyingObject

Constructor Detail

CorfuCompileProxy

@Deprecated
public CorfuCompileProxy(CorfuRuntime rt,
                                     UUID streamID,
                                     Class<T> type,
                                     Object[] args,
                                     ISerializer serializer,
                                     Map<String,ICorfuSMRUpcallTarget<T>> upcallTargetMap,
                                     Map<String,IUndoFunction<T>> undoTargetMap,
                                     Map<String,IUndoRecordFunction<T>> undoRecordTargetMap,
                                     Set<String> resetSet)

Deprecated.

Creates a CorfuCompileProxy object on a particular stream.

Parameters:

rt - Connected CorfuRuntime instance.

streamID - StreamID of the log.

type - Type of underlying object to instantiate a new instance.

args - Arguments to create this proxy.

serializer - Serializer used by the SMR entries to serialize the arguments.

upcallTargetMap - upCallTargetMap

undoTargetMap - undoTargetMap

undoRecordTargetMap - undoRecordTargetMap

resetSet - resetSet

Method Detail

access

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

Access the state of the object.

Specified by:

access in interface ICorfuSMRProxy<T>

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

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

Record an SMR function to the log before returning.

Specified by:

logUpdate in interface ICorfuSMRProxy<T>

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

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

Return the result of an upcall at the given timestamp.

Specified by:

getUpcallResult in interface ICorfuSMRProxy<T>

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

public void sync()

Update the proxy to the latest committed version.

Specified by:

sync in interface ICorfuSMRProxy<T>

getStreamID

public UUID getStreamID()

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

Specified by:

getStreamID in interface ICorfuSMRProxy<T>

Returns:

The UUID of the stream this proxy is subscribed to.

TXExecute

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

Run in a transactional context.

Specified by:

TXExecute in interface ICorfuSMRProxy<T>

Type Parameters:

R - The return type.

Parameters:

txFunction - The function to run in a transactional context.

Returns:

The value supplied by the function.

getObjectBuilder

public IObjectBuilder<?> getObjectBuilder()

Get an object builder to build new objects.

Specified by:

getObjectBuilder in interface ICorfuSMRProxy<T>

Returns:

An object which permits the construction of new objects.

getObjectType

public Class<T> getObjectType()

Return the type of the object being replicated.

Specified by:

getObjectType in interface ICorfuSMRProxy<T>

Returns:

The type of the replicated object.

getVersion

public long getVersion()

Get the latest version read by the proxy.

Specified by:

getVersion in interface ICorfuSMRProxy<T>

Returns:

The latest version read by the proxy.

toString

public String toString()

Overrides:

toString in class Object