X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fcds-access-client%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Faccess%2Fclient%2FAbstractClientConnection.java;h=d37893bd7c3a9862ad89fb9d88b94337d0355f13;hp=ac4ac785d6e28dcaf08de1a82a85bf2610020186;hb=e1c283de301355cb8fa3f7d4fa28a6dd0af501eb;hpb=a36d5af3e383cbddc31527a6d05bc23de3f3571d diff --git a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java index ac4ac785d6..d37893bd7c 100644 --- a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java +++ b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java @@ -9,6 +9,8 @@ package org.opendaylight.controller.cluster.access.client; import akka.actor.ActorRef; import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.MoreObjects; +import com.google.common.base.MoreObjects.ToStringHelper; import com.google.common.base.Preconditions; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.Optional; @@ -44,12 +46,18 @@ public abstract class AbstractClientConnection { @VisibleForTesting static final long REQUEST_TIMEOUT_NANOS = TimeUnit.SECONDS.toNanos(30); + private static final FiniteDuration REQUEST_TIMEOUT_DURATION = FiniteDuration.apply(REQUEST_TIMEOUT_NANOS, + TimeUnit.NANOSECONDS); + private final Lock lock = new ReentrantLock(); private final ClientActorContext context; @GuardedBy("lock") private final TransmitQueue queue; private final Long cookie; + @GuardedBy("lock") + private boolean haveTimer; + private volatile RequestException poisoned; // Do not allow subclassing outside of this package @@ -79,6 +87,10 @@ public abstract class AbstractClientConnection { return context.self(); } + public final long currentTime() { + return context.ticker().read(); + } + /** * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke * from any thread. @@ -90,13 +102,31 @@ public abstract class AbstractClientConnection { * @param callback Callback to invoke */ public final void sendRequest(final Request request, final Consumer> callback) { - final RequestException maybePoison = poisoned; - if (maybePoison != null) { - throw new IllegalStateException("Connection " + this + " has been poisoned", maybePoison); + final long now = currentTime(); + final long delay = enqueueEntry(new ConnectionEntry(request, callback, now), now); + try { + TimeUnit.NANOSECONDS.sleep(delay); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + LOG.debug("Interrupted after sleeping {}ns", e, currentTime() - now); } + } - final ConnectionEntry entry = new ConnectionEntry(request, callback, readTime()); - enqueueAndWait(entry, entry.getEnqueuedTicks()); + /** + * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke + * from any thread. + * + *

+ * Note that unlike {@link #sendRequest(Request, Consumer)}, this method does not exert backpressure, hence it + * should never be called from an application thread. + * + * @param request Request to send + * @param callback Callback to invoke + * @param enqueuedTicks Time (according to {@link #currentTime()} of request enqueue + */ + public final void enqueueRequest(final Request request, final Consumer> callback, + final long enqueuedTicks) { + enqueueEntry(new ConnectionEntry(request, callback, enqueuedTicks), currentTime()); } public abstract Optional getBackendInfo(); @@ -108,37 +138,42 @@ public abstract class AbstractClientConnection { @GuardedBy("lock") final void finishReplay(final ReconnectForwarder forwarder) { - queue.setForwarder(forwarder, readTime()); + setForwarder(forwarder); lock.unlock(); } @GuardedBy("lock") final void setForwarder(final ReconnectForwarder forwarder) { - queue.setForwarder(forwarder, readTime()); + queue.setForwarder(forwarder, currentTime()); } @GuardedBy("lock") - abstract ClientActorBehavior reconnectConnection(ClientActorBehavior current); - - private long readTime() { - return context.ticker().read(); - } + abstract ClientActorBehavior lockedReconnect(ClientActorBehavior current); final long enqueueEntry(final ConnectionEntry entry, final long now) { lock.lock(); try { + final RequestException maybePoison = poisoned; + if (maybePoison != null) { + throw new IllegalStateException("Connection " + this + " has been poisoned", maybePoison); + } + + if (queue.isEmpty()) { + // The queue is becoming non-empty, schedule a timer + scheduleTimer(REQUEST_TIMEOUT_DURATION); + } return queue.enqueue(entry, now); } finally { lock.unlock(); } } - final void enqueueAndWait(final ConnectionEntry entry, final long now) { - final long delay = enqueueEntry(entry, now); + final ClientActorBehavior reconnect(final ClientActorBehavior current) { + lock.lock(); try { - TimeUnit.NANOSECONDS.sleep(delay); - } catch (InterruptedException e) { - LOG.debug("Interrupted while sleeping"); + return lockedReconnect(current); + } finally { + lock.unlock(); } } @@ -147,9 +182,19 @@ public abstract class AbstractClientConnection { * * @param delay Delay, in nanoseconds */ + @GuardedBy("lock") private void scheduleTimer(final FiniteDuration delay) { + if (haveTimer) { + LOG.debug("{}: timer already scheduled", context.persistenceId()); + return; + } + if (queue.hasSuccessor()) { + LOG.debug("{}: connection has successor, not scheduling timer", context.persistenceId()); + return; + } LOG.debug("{}: scheduling timeout in {}", context.persistenceId(), delay); context.executeInActor(this::runTimer, delay); + haveTimer = true; } /** @@ -165,7 +210,8 @@ public abstract class AbstractClientConnection { lock.lock(); try { - final long now = readTime(); + haveTimer = false; + final long now = currentTime(); // The following line is only reliable when queue is not forwarding, but such state should not last long. final long ticksSinceProgress = queue.ticksStalling(now); if (ticksSinceProgress >= NO_PROGRESS_TIMEOUT_NANOS) { @@ -183,17 +229,17 @@ public abstract class AbstractClientConnection { delay = lockedCheckTimeout(now); if (delay == null) { // We have timed out. There is no point in scheduling a timer - return reconnectConnection(current); + return lockedReconnect(current); + } + + if (delay.isPresent()) { + // If there is new delay, schedule a timer + scheduleTimer(delay.get()); } } finally { lock.unlock(); } - if (delay.isPresent()) { - // If there is new delay, schedule a timer - scheduleTimer(delay.get()); - } - return current; } @@ -252,7 +298,7 @@ public abstract class AbstractClientConnection { } final void receiveResponse(final ResponseEnvelope envelope) { - final long now = readTime(); + final long now = currentTime(); final Optional maybeEntry; lock.lock(); @@ -268,4 +314,13 @@ public abstract class AbstractClientConnection { entry.complete(envelope.getMessage()); } } + + @Override + public final String toString() { + return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString(); + } + + ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { + return toStringHelper.add("client", context.getIdentifier()).add("cookie", cookie).add("poisoned", poisoned); + } }