org.apache.omid.tso.client

Interface TSOProtocol

All Known Implementing Classes:

MockTSOClient, TSOClient

public interface TSOProtocol

Defines the protocol used on the client side to abstract communication to the TSO server

Method Summary

Modifier and Type	Method and Description
TSOFuture<Void>	close() Closes the communication with the TSO server
TSOFuture<Long>	commit(long transactionId, Set<? extends CellId> writeSet) Returns the result of the conflict detection made on the server-side for the specified transaction
TSOFuture<Long>	commit(long transactionId, Set<? extends CellId> writeSet, Set<? extends CellId> conflictFreeWriteSet) Returns the result of the conflict detection made on the server-side for the specified transaction
OmidClientConfiguration.ConflictDetectionLevel	getConflictDetectionLevel()
long	getEpoch() Returns the epoch of the current TSO server.
TSOFuture<Long>	getFence(long tableId) Returns a new fence timestamp assigned by on the server-side
TSOFuture<Long>	getNewStartTimestamp() Returns a new timestamp assigned by on the server-side
boolean	isLowLatency() checks if tso is low latency protocol
void	setConflictDetectionLevel(OmidClientConfiguration.ConflictDetectionLevel conflictDetectionLevel)

Method Detail

getEpoch

long getEpoch()

Returns the epoch of the current TSO server. Used in HA mode.

Returns:

the epoch.

getNewStartTimestamp

TSOFuture<Long> getNewStartTimestamp()

Returns a new timestamp assigned by on the server-side

Returns:

the newly assigned timestamp as a future. If an error was detected, the future will contain a corresponding protocol exception see org.apache.omid.tso.TimestampOracle see org.apache.omid.tso.TSOServer

commit

TSOFuture<Long> commit(long transactionId,
                       Set<? extends CellId> writeSet)

Returns the result of the conflict detection made on the server-side for the specified transaction

Parameters:

transactionId - the transaction to check for conflicts

writeSet - the writeSet of the transaction, which includes all the modified cells

Returns:

the commit timestamp as a future if the transaction was committed. If the transaction was aborted due to conflicts with a concurrent transaction, the future will include an AbortException. If an error was detected, the future will contain a corresponding protocol exception see org.apache.omid.tso.TimestampOracle see org.apache.omid.tso.TSOServer

commit

TSOFuture<Long> commit(long transactionId,
                       Set<? extends CellId> writeSet,
                       Set<? extends CellId> conflictFreeWriteSet)

Returns the result of the conflict detection made on the server-side for the specified transaction

Parameters:

transactionId - the transaction to check for conflicts

writeSet - the writeSet of the transaction, which includes all the modified cells

conflictFreeWriteSet - the conflict free writeSet of the transaction, needed only for table access information.

Returns:

the commit timestamp as a future if the transaction was committed. If the transaction was aborted due to conflicts with a concurrent transaction, the future will include an AbortException. If an error was detected, the future will contain a corresponding protocol exception see org.apache.omid.tso.TimestampOracle see org.apache.omid.tso.TSOServer

getFence

TSOFuture<Long> getFence(long tableId)

Returns a new fence timestamp assigned by on the server-side

Parameters:

tableId - the table to create fence for.

Returns:

the newly assigned timestamp as a future. If an error was detected, the future will contain a corresponding protocol exception see org.apache.omid.tso.TimestampOracle see org.apache.omid.tso.TSOServer

close

TSOFuture<Void> close()

Closes the communication with the TSO server

Returns:

nothing. If an error was detected, the future will contain a corresponding protocol exception

isLowLatency

boolean isLowLatency()

checks if tso is low latency protocol

Returns:

setConflictDetectionLevel

void setConflictDetectionLevel(OmidClientConfiguration.ConflictDetectionLevel conflictDetectionLevel)

getConflictDetectionLevel

OmidClientConfiguration.ConflictDetectionLevel getConflictDetectionLevel()