org.opendaylight.controller.cluster.databroker.actors.dds

Class ClientTransaction

java.lang.Object

org.opendaylight.controller.cluster.databroker.actors.dds.AbstractClientHandle<org.opendaylight.controller.cluster.databroker.actors.dds.AbstractProxyTransaction>

org.opendaylight.controller.cluster.databroker.actors.dds.ClientTransaction

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Identifiable<TransactionIdentifier>

@Beta
public class ClientTransaction
extends AbstractClientHandle<org.opendaylight.controller.cluster.databroker.actors.dds.AbstractProxyTransaction>

Client-side view of a transaction.

This interface is used by the world outside of the actor system and in the actor system it is manifested via its client actor. That requires some state transfer with DistributedDataStoreClientBehavior. In order to reduce request latency, all messages are carbon-copied (and enqueued first) to the client actor.

It is internally composed of multiple RemoteProxyTransactions, each responsible for a component shard.

Implementation is quite a bit complex, and involves cooperation with AbstractClientHistory for tracking gaps in transaction identifiers seen by backends.

These gaps need to be accounted for in the transaction setup message sent to a particular backend, so it can verify that the requested transaction is in-sequence. This is critical in ensuring that transactions (which are independent entities from message queueing perspective) do not get reodered -- thus allowing multiple in-flight transactions.

Alternative would be to force visibility by sending an abort request to all potential backends, but that would mean that even empty transactions increase load on all shards -- which would be a scalability issue.

Yet another alternative would be to introduce inter-transaction dependencies to the queueing layer in client actor, but that would require additional indirection and complexity.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
void	delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
com.google.common.util.concurrent.FluentFuture<Boolean>	exists(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
void	merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)
org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor	openCursor()
com.google.common.util.concurrent.FluentFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>>	read(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort	ready()
void	write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Methods inherited from class org.opendaylight.controller.cluster.databroker.actors.dds.AbstractClientHandle

abort, getIdentifier, toString

Methods inherited from class java.lang.Object

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

Method Detail

openCursor

public org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor openCursor()

exists

public com.google.common.util.concurrent.FluentFuture<Boolean> exists(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

read

public com.google.common.util.concurrent.FluentFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>> read(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

delete

public void delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

merge

public void merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                  org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

write

public void write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                  org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

ready

public org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort ready()