2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.databroker.actors.dds;
10 import static com.google.common.base.Preconditions.checkState;
11 import static com.google.common.base.Verify.verify;
12 import static com.google.common.base.Verify.verifyNotNull;
13 import static java.util.Objects.requireNonNull;
15 import akka.actor.ActorRef;
16 import com.google.common.base.MoreObjects;
17 import com.google.common.collect.Iterables;
18 import com.google.common.util.concurrent.FluentFuture;
19 import com.google.common.util.concurrent.ListenableFuture;
20 import com.google.common.util.concurrent.SettableFuture;
21 import java.util.ArrayDeque;
22 import java.util.Deque;
23 import java.util.Iterator;
24 import java.util.Optional;
25 import java.util.concurrent.CountDownLatch;
26 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
27 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
28 import java.util.function.Consumer;
29 import org.checkerframework.checker.lock.qual.GuardedBy;
30 import org.eclipse.jdt.annotation.NonNull;
31 import org.eclipse.jdt.annotation.Nullable;
32 import org.opendaylight.controller.cluster.access.client.ConnectionEntry;
33 import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
34 import org.opendaylight.controller.cluster.access.commands.ClosedTransactionException;
35 import org.opendaylight.controller.cluster.access.commands.IncrementTransactionSequenceRequest;
36 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
37 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
38 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
39 import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
40 import org.opendaylight.controller.cluster.access.commands.TransactionCommitSuccess;
41 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
42 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
43 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
44 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeRequest;
45 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
46 import org.opendaylight.controller.cluster.access.concepts.Request;
47 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
48 import org.opendaylight.controller.cluster.access.concepts.Response;
49 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
50 import org.opendaylight.yangtools.concepts.Identifiable;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
53 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory;
57 * Class translating transaction operations towards a particular backend shard.
60 * This class is not safe to access from multiple application threads, as is usual for transactions. Internal state
61 * transitions coming from interactions with backend are expected to be thread-safe.
64 * This class interacts with the queueing mechanism in ClientActorBehavior, hence once we arrive at a decision
65 * to use either a local or remote implementation, we are stuck with it. We can re-evaluate on the next transaction.
67 * @author Robert Varga
69 abstract class AbstractProxyTransaction implements Identifiable<TransactionIdentifier> {
71 * Marker object used instead of read-type of requests, which are satisfied only once. This has a lower footprint
72 * and allows compressing multiple requests into a single entry. This class is not thread-safe.
74 private static final class IncrementSequence {
75 private final long sequence;
76 private long delta = 0;
78 IncrementSequence(final long sequence) {
79 this.sequence = sequence;
90 void incrementDelta() {
96 * Base class for representing logical state of this proxy. See individual instantiations and {@link SuccessorState}
99 private static class State {
100 private final String string;
102 State(final String string) {
103 this.string = requireNonNull(string);
107 public final String toString() {
113 * State class used when a successor has interfered. Contains coordinator latch, the successor and previous state.
114 * This is a temporary state introduced during reconnection process and is necessary for correct state hand-off
115 * between the old connection (potentially being accessed by the user) and the new connection (being cleaned up
119 * When a user operation encounters this state, it synchronizes on the it and wait until reconnection completes,
120 * at which point the request is routed to the successor transaction. This is a relatively heavy-weight solution
121 * to the problem of state transfer, but the user will observe it only if the race condition is hit.
123 private static class SuccessorState extends State {
124 private final CountDownLatch latch = new CountDownLatch(1);
125 private AbstractProxyTransaction successor;
126 private State prevState;
129 private boolean done;
135 // Synchronize with succession process and return the successor
136 AbstractProxyTransaction await() {
139 } catch (InterruptedException e) {
140 LOG.warn("Interrupted while waiting for latch of {}", successor);
141 throw new RuntimeException(e);
150 State getPrevState() {
151 return verifyNotNull(prevState, "Attempted to access previous state, which was not set");
154 void setPrevState(final State prevState) {
155 verify(this.prevState == null, "Attempted to set previous state to %s when we already have %s", prevState,
157 this.prevState = requireNonNull(prevState);
158 // We cannot have duplicate successor states, so this check is sufficient
159 this.done = DONE.equals(prevState);
162 // To be called from safe contexts, where successor is known to be completed
163 AbstractProxyTransaction getSuccessor() {
164 return verifyNotNull(successor);
167 void setSuccessor(final AbstractProxyTransaction successor) {
168 verify(this.successor == null, "Attempted to set successor to %s when we already have %s", successor,
170 this.successor = requireNonNull(successor);
182 private static final Logger LOG = LoggerFactory.getLogger(AbstractProxyTransaction.class);
183 private static final AtomicIntegerFieldUpdater<AbstractProxyTransaction> SEALED_UPDATER =
184 AtomicIntegerFieldUpdater.newUpdater(AbstractProxyTransaction.class, "sealed");
185 private static final AtomicReferenceFieldUpdater<AbstractProxyTransaction, State> STATE_UPDATER =
186 AtomicReferenceFieldUpdater.newUpdater(AbstractProxyTransaction.class, State.class, "state");
189 * Transaction has been open and is being actively worked on.
191 private static final State OPEN = new State("OPEN");
194 * Transaction has been sealed by the user, but it has not completed flushing to the backed, yet. This is
195 * a transition state, as we are waiting for the user to initiate commit procedures.
198 * Since the reconnect mechanics relies on state replay for transactions, this state needs to be flushed into the
199 * queue to re-create state in successor transaction (which may be based on different messages as locality may have
200 * changed). Hence the transition to {@link #FLUSHED} state needs to be handled in a thread-safe manner.
202 private static final State SEALED = new State("SEALED");
205 * Transaction state has been flushed into the queue, i.e. it is visible by the successor and potentially
206 * the backend. At this point the transaction does not hold any state besides successful requests, all other state
207 * is held either in the connection's queue or the successor object.
210 * Transition to this state indicates we have all input from the user we need to initiate the correct commit
213 private static final State FLUSHED = new State("FLUSHED");
216 * Transaction state has been completely resolved, we have received confirmation of the transaction fate from
217 * the backend. The only remaining task left to do is finishing up the state cleanup, which is done via purge
218 * request. We need to hang on to the transaction until that is done, as we have to make sure backend completes
219 * purging its state -- otherwise we could have a leak on the backend.
221 private static final State DONE = new State("DONE");
223 // Touched from client actor thread only
224 private final Deque<Object> successfulRequests = new ArrayDeque<>();
225 private final ProxyHistory parent;
227 // Accessed from user thread only, which may not access this object concurrently
228 private long sequence;
231 * Atomic state-keeping is required to synchronize the process of propagating completed transaction state towards
232 * the backend -- which may include a successor.
234 * Successor, unlike {@link AbstractProxyTransaction#seal()} is triggered from the client actor thread, which means
235 * the successor placement needs to be atomic with regard to the application thread.
237 * In the common case, the application thread performs performs the seal operations and then "immediately" sends
238 * the corresponding message. The uncommon case is when the seal and send operations race with a connect completion
239 * or timeout, when a successor is injected.
241 * This leaves the problem of needing to completely transferring state just after all queued messages are replayed
242 * after a successor was injected, so that it can be properly sealed if we are racing. Further complication comes
243 * from lock ordering, where the successor injection works with a locked queue and locks proxy objects -- leading
244 * to a potential AB-BA deadlock in case of a naive implementation.
246 * For tracking user-visible state we use a single volatile int, which is flipped atomically from 0 to 1 exactly
247 * once in {@link AbstractProxyTransaction#seal()}. That keeps common operations fast, as they need to perform
248 * only a single volatile read to assert state correctness.
250 * For synchronizing client actor (successor-injecting) and user (commit-driving) thread, we keep a separate state
251 * variable. It uses pre-allocated objects for fast paths (i.e. no successor present) and a per-transition object
252 * for slow paths (when successor is injected/present).
254 private volatile int sealed;
255 private volatile State state;
257 AbstractProxyTransaction(final ProxyHistory parent, final boolean isDone) {
258 this.parent = requireNonNull(parent);
261 // DONE implies previous seal operation completed
268 final void executeInActor(final Runnable command) {
269 parent.context().executeInActor(behavior -> {
275 final ActorRef localActor() {
276 return parent.localActor();
279 final void incrementSequence(final long delta) {
281 LOG.debug("Transaction {} incremented sequence to {}", this, sequence);
284 final long nextSequence() {
285 final long ret = sequence++;
286 LOG.debug("Transaction {} allocated sequence {}", this, ret);
290 final void delete(final YangInstanceIdentifier path) {
296 final void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
302 final void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
308 final FluentFuture<Boolean> exists(final YangInstanceIdentifier path) {
310 return doExists(path);
313 final FluentFuture<Optional<NormalizedNode<?, ?>>> read(final YangInstanceIdentifier path) {
318 final void enqueueRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
319 final long enqueuedTicks) {
320 LOG.debug("Transaction proxy {} enqueing request {} callback {}", this, request, callback);
321 parent.enqueueRequest(request, callback, enqueuedTicks);
324 final void sendRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
325 LOG.debug("Transaction proxy {} sending request {} callback {}", this, request, callback);
326 parent.sendRequest(request, callback);
330 * Seal this transaction before it is either committed or aborted. This method should only be invoked from
331 * application thread.
334 // Transition user-visible state first
335 final boolean success = markSealed();
336 checkState(success, "Proxy %s was already sealed", getIdentifier());
338 if (!sealAndSend(Optional.empty())) {
344 * Internal seal propagation method, invoked when we have raced with reconnection thread. Note that there may have
345 * been multiple reconnects, so we have to make sure the action is propagate through all intermediate instances.
347 private void sealSuccessor() {
348 // Slow path: wait for the successor to complete
349 final AbstractProxyTransaction successor = awaitSuccessor();
351 // At this point the successor has completed transition and is possibly visible by the user thread, which is
352 // still stuck here. The successor has not seen final part of our state, nor the fact it is sealed.
353 // Propagate state and seal the successor.
354 final Optional<ModifyTransactionRequest> optState = flushState();
355 if (optState.isPresent()) {
356 forwardToSuccessor(successor, optState.get(), null);
358 successor.predecessorSealed();
361 private void predecessorSealed() {
362 if (markSealed() && !sealAndSend(Optional.empty())) {
368 * Seal this transaction. If this method reports false, the caller needs to deal with propagating the seal operation
369 * towards the successor.
371 * @return True if seal operation was successful, false if this proxy has a successor.
378 * Seal this transaction and potentially send it out towards the backend. If this method reports false, the caller
379 * needs to deal with propagating the seal operation towards the successor.
381 * @param enqueuedTicks Enqueue ticks when this is invoked from replay path.
382 * @return True if seal operation was successful, false if this proxy has a successor.
384 boolean sealAndSend(final Optional<Long> enqueuedTicks) {
388 private boolean sealState() {
389 parent.onTransactionSealed(this);
390 // Transition internal state to sealed and detect presence of a successor
391 return STATE_UPDATER.compareAndSet(this, OPEN, SEALED);
395 * Mark this proxy as having been sealed.
397 * @return True if this call has transitioned to sealed state.
399 final boolean markSealed() {
400 return SEALED_UPDATER.compareAndSet(this, 0, 1);
403 private void checkNotSealed() {
404 checkState(sealed == 0, "Transaction %s has already been sealed", getIdentifier());
407 private void checkSealed() {
408 checkState(sealed != 0, "Transaction %s has not been sealed yet", getIdentifier());
411 private SuccessorState getSuccessorState() {
412 final State local = state;
413 verify(local instanceof SuccessorState, "State %s has unexpected class", local);
414 return (SuccessorState) local;
417 private void checkReadWrite() {
418 if (isSnapshotOnly()) {
419 throw new UnsupportedOperationException("Transaction " + getIdentifier() + " is a read-only snapshot");
423 final void recordSuccessfulRequest(final @NonNull TransactionRequest<?> req) {
424 successfulRequests.add(verifyNotNull(req));
427 final void recordFinishedRequest(final Response<?, ?> response) {
428 final Object last = successfulRequests.peekLast();
429 if (last instanceof IncrementSequence) {
430 ((IncrementSequence) last).incrementDelta();
432 successfulRequests.addLast(new IncrementSequence(response.getSequence()));
437 * Abort this transaction. This is invoked only for read-only transactions and will result in an explicit message
438 * being sent to the backend.
442 parent.abortTransaction(this);
444 sendRequest(abortRequest(), resp -> {
445 LOG.debug("Transaction {} abort completed with {}", getIdentifier(), resp);
450 final void abort(final VotingFuture<Void> ret) {
454 if (t instanceof TransactionAbortSuccess) {
456 } else if (t instanceof RequestFailure) {
457 ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
459 ret.voteNo(unhandledResponseException(t));
462 // This is a terminal request, hence we do not need to record it
463 LOG.debug("Transaction {} abort completed", this);
468 final void enqueueAbort(final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
470 parent.abortTransaction(this);
472 enqueueRequest(abortRequest(), resp -> {
473 LOG.debug("Transaction {} abort completed with {}", getIdentifier(), resp);
474 // Purge will be sent by the predecessor's callback
475 if (callback != null) {
476 callback.accept(resp);
481 final void enqueueDoAbort(final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
482 enqueueRequest(new TransactionAbortRequest(getIdentifier(), nextSequence(), localActor()), callback,
486 final void sendDoAbort(final Consumer<Response<?, ?>> callback) {
487 sendRequest(new TransactionAbortRequest(getIdentifier(), nextSequence(), localActor()), callback);
491 * Commit this transaction, possibly in a coordinated fashion.
493 * @param coordinated True if this transaction should be coordinated across multiple participants.
494 * @return Future completion
496 final ListenableFuture<Boolean> directCommit() {
500 // Precludes startReconnect() from interfering with the fast path
501 synchronized (this) {
502 if (STATE_UPDATER.compareAndSet(this, SEALED, FLUSHED)) {
503 final SettableFuture<Boolean> ret = SettableFuture.create();
504 sendRequest(verifyNotNull(commitRequest(false)), t -> {
505 if (t instanceof TransactionCommitSuccess) {
506 ret.set(Boolean.TRUE);
507 } else if (t instanceof RequestFailure) {
508 final Throwable cause = ((RequestFailure<?, ?>) t).getCause().unwrap();
509 if (cause instanceof ClosedTransactionException) {
510 // This is okay, as it indicates the transaction has been completed. It can happen
511 // when we lose connectivity with the backend after it has received the request.
512 ret.set(Boolean.TRUE);
514 ret.setException(cause);
517 ret.setException(unhandledResponseException(t));
520 // This is a terminal request, hence we do not need to record it
521 LOG.debug("Transaction {} directCommit completed", this);
529 // We have had some interference with successor injection, wait for it to complete and defer to the successor.
530 return awaitSuccessor().directCommit();
533 final void canCommit(final VotingFuture<?> ret) {
537 // Precludes startReconnect() from interfering with the fast path
538 synchronized (this) {
539 if (STATE_UPDATER.compareAndSet(this, SEALED, FLUSHED)) {
540 final TransactionRequest<?> req = verifyNotNull(commitRequest(true));
542 sendRequest(req, t -> {
543 if (t instanceof TransactionCanCommitSuccess) {
545 } else if (t instanceof RequestFailure) {
546 ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
548 ret.voteNo(unhandledResponseException(t));
551 recordSuccessfulRequest(req);
552 LOG.debug("Transaction {} canCommit completed", this);
559 // We have had some interference with successor injection, wait for it to complete and defer to the successor.
560 awaitSuccessor().canCommit(ret);
563 private AbstractProxyTransaction awaitSuccessor() {
564 return getSuccessorState().await();
567 final void preCommit(final VotingFuture<?> ret) {
571 final TransactionRequest<?> req = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
573 sendRequest(req, t -> {
574 if (t instanceof TransactionPreCommitSuccess) {
576 } else if (t instanceof RequestFailure) {
577 ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
579 ret.voteNo(unhandledResponseException(t));
582 onPreCommitComplete(req);
586 private void onPreCommitComplete(final TransactionRequest<?> req) {
588 * The backend has agreed that the transaction has entered PRE_COMMIT phase, meaning it will be committed
589 * to storage after the timeout completes.
591 * All state has been replicated to the backend, hence we do not need to keep it around. Retain only
592 * the precommit request, so we know which request to use for resync.
594 LOG.debug("Transaction {} preCommit completed, clearing successfulRequests", this);
595 successfulRequests.clear();
597 // TODO: this works, but can contain some useless state (like batched operations). Create an empty
598 // equivalent of this request and store that.
599 recordSuccessfulRequest(req);
602 final void doCommit(final VotingFuture<?> ret) {
606 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), t -> {
607 if (t instanceof TransactionCommitSuccess) {
609 } else if (t instanceof RequestFailure) {
610 ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
612 ret.voteNo(unhandledResponseException(t));
615 LOG.debug("Transaction {} doCommit completed", this);
617 // Needed for ProxyHistory$Local data tree rebase points.
618 parent.completeTransaction(this);
624 private void enqueuePurge() {
628 final void enqueuePurge(final Consumer<Response<?, ?>> callback) {
629 // Purge request are dispatched internally, hence should not wait
630 enqueuePurge(callback, parent.currentTime());
633 final void enqueuePurge(final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
634 LOG.debug("{}: initiating purge", this);
636 final State prev = state;
637 if (prev instanceof SuccessorState) {
638 ((SuccessorState) prev).setDone();
640 final boolean success = STATE_UPDATER.compareAndSet(this, prev, DONE);
642 LOG.warn("{}: moved from state {} while we were purging it", this, prev);
646 successfulRequests.clear();
648 enqueueRequest(new TransactionPurgeRequest(getIdentifier(), nextSequence(), localActor()), resp -> {
649 LOG.debug("{}: purge completed", this);
650 parent.purgeTransaction(this);
652 if (callback != null) {
653 callback.accept(resp);
658 // Called with the connection unlocked
659 final synchronized void startReconnect() {
660 // At this point canCommit/directCommit are blocked, we assert a new successor state, retrieving the previous
661 // state. This method is called with the queue still unlocked.
662 final SuccessorState nextState = new SuccessorState();
663 final State prevState = STATE_UPDATER.getAndSet(this, nextState);
665 LOG.debug("Start reconnect of proxy {} previous state {}", this, prevState);
666 verify(!(prevState instanceof SuccessorState), "Proxy %s duplicate reconnect attempt after %s", this,
669 // We have asserted a slow-path state, seal(), canCommit(), directCommit() are forced to slow paths, which will
670 // wait until we unblock nextState's latch before accessing state. Now we record prevState for later use and we
672 nextState.setPrevState(prevState);
675 // Called with the connection locked
676 final void replayMessages(final ProxyHistory successorHistory, final Iterable<ConnectionEntry> enqueuedEntries) {
677 final SuccessorState local = getSuccessorState();
678 final State prevState = local.getPrevState();
680 final AbstractProxyTransaction successor = successorHistory.createTransactionProxy(getIdentifier(),
681 isSnapshotOnly(), local.isDone());
682 LOG.debug("{} created successor {}", this, successor);
683 local.setSuccessor(successor);
685 // Replay successful requests first
686 if (!successfulRequests.isEmpty()) {
687 // We need to find a good timestamp to use for successful requests, as we do not want to time them out
688 // nor create timing inconsistencies in the queue -- requests are expected to be ordered by their enqueue
689 // time. We will pick the time of the first entry available. If there is none, we will just use current
690 // time, as all other requests will get enqueued afterwards.
691 final ConnectionEntry firstInQueue = Iterables.getFirst(enqueuedEntries, null);
692 final long now = firstInQueue != null ? firstInQueue.getEnqueuedTicks() : parent.currentTime();
694 for (Object obj : successfulRequests) {
695 if (obj instanceof TransactionRequest) {
696 LOG.debug("Forwarding successful request {} to successor {}", obj, successor);
697 successor.doReplayRequest((TransactionRequest<?>) obj, resp -> { /*NOOP*/ }, now);
699 verify(obj instanceof IncrementSequence);
700 final IncrementSequence increment = (IncrementSequence) obj;
701 successor.doReplayRequest(new IncrementTransactionSequenceRequest(getIdentifier(),
702 increment.getSequence(), localActor(), isSnapshotOnly(),
703 increment.getDelta()), resp -> { /*NOOP*/ }, now);
704 LOG.debug("Incrementing sequence {} to successor {}", obj, successor);
707 LOG.debug("{} replayed {} successful requests", getIdentifier(), successfulRequests.size());
708 successfulRequests.clear();
711 // Now replay whatever is in the connection
712 final Iterator<ConnectionEntry> it = enqueuedEntries.iterator();
713 while (it.hasNext()) {
714 final ConnectionEntry e = it.next();
715 final Request<?, ?> req = e.getRequest();
717 if (getIdentifier().equals(req.getTarget())) {
718 verify(req instanceof TransactionRequest, "Unhandled request %s", req);
719 LOG.debug("Replaying queued request {} to successor {}", req, successor);
720 successor.doReplayRequest((TransactionRequest<?>) req, e.getCallback(), e.getEnqueuedTicks());
726 * Check the state at which we have started the reconnect attempt. State transitions triggered while we were
727 * reconnecting have been forced to slow paths, which will be unlocked once we unblock the state latch
728 * at the end of this method.
730 if (SEALED.equals(prevState)) {
731 LOG.debug("Proxy {} reconnected while being sealed, propagating state to successor {}", this, successor);
732 final long enqueuedTicks = parent.currentTime();
733 final Optional<ModifyTransactionRequest> optState = flushState();
734 if (optState.isPresent()) {
735 successor.handleReplayedRemoteRequest(optState.get(), null, enqueuedTicks);
737 if (successor.markSealed()) {
738 successor.sealAndSend(Optional.of(enqueuedTicks));
744 * Invoked from {@link #replayMessages(AbstractProxyTransaction, Iterable)} to have successor adopt an in-flight
748 * Note: this method is invoked by the predecessor on the successor.
750 * @param request Request which needs to be forwarded
751 * @param callback Callback to be invoked once the request completes
752 * @param enqueuedTicks ticker-based time stamp when the request was enqueued
754 private void doReplayRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
755 final long enqueuedTicks) {
756 if (request instanceof AbstractLocalTransactionRequest) {
757 handleReplayedLocalRequest((AbstractLocalTransactionRequest<?>) request, callback, enqueuedTicks);
759 handleReplayedRemoteRequest(request, callback, enqueuedTicks);
763 // Called with the connection locked
764 final void finishReconnect() {
765 final SuccessorState local = getSuccessorState();
766 LOG.debug("Finishing reconnect of proxy {}", this);
768 // All done, release the latch, unblocking seal() and canCommit() slow paths
773 * Invoked from a retired connection for requests which have been in-flight and need to be re-adjusted
774 * and forwarded to the successor connection.
776 * @param request Request to be forwarded
777 * @param callback Original callback
779 final void forwardRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
780 forwardToSuccessor(getSuccessorState().getSuccessor(), request, callback);
783 final void forwardToSuccessor(final AbstractProxyTransaction successor, final TransactionRequest<?> request,
784 final Consumer<Response<?, ?>> callback) {
785 if (successor instanceof LocalProxyTransaction) {
786 forwardToLocal((LocalProxyTransaction)successor, request, callback);
787 } else if (successor instanceof RemoteProxyTransaction) {
788 forwardToRemote((RemoteProxyTransaction)successor, request, callback);
790 throw new IllegalStateException("Unhandled successor " + successor);
794 final void replayRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
795 final long enqueuedTicks) {
796 getSuccessorState().getSuccessor().doReplayRequest(request, callback, enqueuedTicks);
799 abstract boolean isSnapshotOnly();
801 abstract void doDelete(YangInstanceIdentifier path);
803 abstract void doMerge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
805 abstract void doWrite(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
807 abstract FluentFuture<Boolean> doExists(YangInstanceIdentifier path);
809 abstract FluentFuture<Optional<NormalizedNode<?, ?>>> doRead(YangInstanceIdentifier path);
812 abstract Optional<ModifyTransactionRequest> flushState();
814 abstract TransactionRequest<?> abortRequest();
816 abstract TransactionRequest<?> commitRequest(boolean coordinated);
819 * Replay a request originating in this proxy to a successor remote proxy.
821 abstract void forwardToRemote(RemoteProxyTransaction successor, TransactionRequest<?> request,
822 Consumer<Response<?, ?>> callback);
825 * Replay a request originating in this proxy to a successor local proxy.
827 abstract void forwardToLocal(LocalProxyTransaction successor, TransactionRequest<?> request,
828 Consumer<Response<?, ?>> callback);
831 * Invoked from {@link LocalProxyTransaction} when it replays its successful requests to its successor.
834 * Note: this method is invoked by the predecessor on the successor.
836 * @param request Request which needs to be forwarded
837 * @param callback Callback to be invoked once the request completes
838 * @param enqueuedTicks Time stamp to use for enqueue time
840 abstract void handleReplayedLocalRequest(AbstractLocalTransactionRequest<?> request,
841 @Nullable Consumer<Response<?, ?>> callback, long enqueuedTicks);
844 * Invoked from {@link RemoteProxyTransaction} when it replays its successful requests to its successor.
847 * Note: this method is invoked by the predecessor on the successor.
849 * @param request Request which needs to be forwarded
850 * @param callback Callback to be invoked once the request completes
851 * @param enqueuedTicks Time stamp to use for enqueue time
853 abstract void handleReplayedRemoteRequest(TransactionRequest<?> request,
854 @Nullable Consumer<Response<?, ?>> callback, long enqueuedTicks);
856 private static IllegalStateException unhandledResponseException(Response<?, ?> resp) {
857 return new IllegalStateException("Unhandled response " + resp.getClass());
861 public final String toString() {
862 return MoreObjects.toStringHelper(this).add("identifier", getIdentifier()).add("state", state).toString();