org.apache.omid.tso.client

Class TSOClient

java.lang.Object

org.apache.omid.tso.client.TSOClient

All Implemented Interfaces:

org.apache.curator.framework.recipes.cache.NodeCacheListener, TSOProtocol

public class TSOClient
extends Object
implements TSOProtocol, org.apache.curator.framework.recipes.cache.NodeCacheListener

Describes the abstract methods to communicate to the TSO server

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ZK_CLUSTER

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> cells) Returns the result of the conflict detection made on the server-side for the specified transaction
TSOFuture<Long>	commit(long transactionId, Set<? extends CellId> cells, Set<? extends CellId> conflictFreeWriteSet) Returns the result of the conflict detection made on the server-side for the specified transaction
OmidClientConfiguration.ConflictDetectionLevel	getConflictDetectionLevel() Used for family deletion
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
static TSOClient	newInstance(OmidClientConfiguration tsoClientConf)
void	nodeChanged()
void	setConflictDetectionLevel(OmidClientConfiguration.ConflictDetectionLevel conflictDetectionLevel) Used for family deletion testing

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ZK_CLUSTER

public static final String DEFAULT_ZK_CLUSTER

See Also:

Constant Field Values

Method Detail

newInstance

public static TSOClient newInstance(OmidClientConfiguration tsoClientConf)
                             throws IOException

Throws:

IOException

getNewStartTimestamp

public TSOFuture<Long> getNewStartTimestamp()

Description copied from interface: TSOProtocol

Returns a new timestamp assigned by on the server-side

Specified by:

getNewStartTimestamp in interface TSOProtocol

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

See Also:

TSOProtocol.getNewStartTimestamp()

commit

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

Description copied from interface: TSOProtocol

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

Specified by:

commit in interface TSOProtocol

Parameters:

transactionId - the transaction to check for conflicts

cells - 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

See Also:

TSOProtocol.commit(long, Set)

commit

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

Description copied from interface: TSOProtocol

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

Specified by:

commit in interface TSOProtocol

Parameters:

transactionId - the transaction to check for conflicts

cells - 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

See Also:

TSOProtocol.commit(long, Set, Set)

getFence

public TSOFuture<Long> getFence(long tableId)

Description copied from interface: TSOProtocol

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

Specified by:

getFence in interface TSOProtocol

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

See Also:

TSOProtocol.getFence(long)

close

public TSOFuture<Void> close()

Description copied from interface: TSOProtocol

Closes the communication with the TSO server

Specified by:

close in interface TSOProtocol

Returns:

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

See Also:

TSOProtocol.close()

getEpoch

public long getEpoch()

Description copied from interface: TSOProtocol

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

Specified by:

getEpoch in interface TSOProtocol

Returns:

the epoch.

See Also:

TSOProtocol.getEpoch()

getConflictDetectionLevel

public OmidClientConfiguration.ConflictDetectionLevel getConflictDetectionLevel()

Used for family deletion

Specified by:

getConflictDetectionLevel in interface TSOProtocol

Returns:

the conflict detection level.

setConflictDetectionLevel

public void setConflictDetectionLevel(OmidClientConfiguration.ConflictDetectionLevel conflictDetectionLevel)

Used for family deletion testing

Specified by:

setConflictDetectionLevel in interface TSOProtocol

nodeChanged

public void nodeChanged()
                 throws Exception

Specified by:

nodeChanged in interface org.apache.curator.framework.recipes.cache.NodeCacheListener

Throws:

Exception

isLowLatency

public boolean isLowLatency()

Description copied from interface: TSOProtocol

checks if tso is low latency protocol

Specified by:

isLowLatency in interface TSOProtocol

Returns: