org.corfudb.runtime.view.replication

Class AbstractReplicationProtocol

java.lang.Object

org.corfudb.runtime.view.replication.AbstractReplicationProtocol

All Implemented Interfaces:

IReplicationProtocol

Direct Known Subclasses:

ChainReplicationProtocol, QuorumReplicationProtocol

public abstract class AbstractReplicationProtocol
extends Object
implements IReplicationProtocol

Created by mwei on 4/6/17.

Field Summary

Fields

Modifier and Type	Field and Description
protected IHoleFillPolicy	holeFillPolicy The hole fill policy to apply.

Constructor Summary

Constructors

Constructor and Description
AbstractReplicationProtocol(IHoleFillPolicy holeFillPolicy) Build the replication protocol using the given hole filling policy.

Method Summary

Modifier and Type	Method and Description
protected abstract void	holeFill(RuntimeLayout runtimeLayout, long globalAddress) Write a special hole filling entry using the given address.
ILogData	read(RuntimeLayout runtimeLayout, long globalAddress) Read data from a given address.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corfudb.runtime.view.replication.IReplicationProtocol

peek, readAll, write

Field Detail

holeFillPolicy

protected final IHoleFillPolicy holeFillPolicy

The hole fill policy to apply.

Constructor Detail

AbstractReplicationProtocol

public AbstractReplicationProtocol(IHoleFillPolicy holeFillPolicy)

Build the replication protocol using the given hole filling policy.

Parameters:

holeFillPolicy - The hole filling policy to be applied when a read returns uncommitted data.

Method Detail

read

@Nonnull
public ILogData read(RuntimeLayout runtimeLayout,
                              long globalAddress)

Read data from a given address.

This function only returns committed data. If the address given has not committed, the implementation may either block until it is committed, or commit a hole filling entry to that address.

In the base implementation, we attempt to read data using the peek method. If data is returned by peek, we use it. Otherwise, we invoke the hole filling protocol.

Specified by:

read in interface IReplicationProtocol

Parameters:

runtimeLayout - the RuntimeLayout stamped with layout to use for the read.

globalAddress - the global address to read the data from.

Returns:

the data committed at the given global address, hole filling if necessary.

holeFill

protected abstract void holeFill(RuntimeLayout runtimeLayout,
                                 long globalAddress)

Write a special hole filling entry using the given address. When this call returns, either the hole filling write has been committed or the result of another client's write has committed (you WILL need to -read- the address to find out which write was adopted).

Parameters:

globalAddress - The address to hole fill.