2 * Copyright (c) 2015 Brocade Communications 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.raft;
10 import akka.actor.ActorRef;
11 import akka.actor.PoisonPill;
12 import akka.actor.Props;
13 import akka.actor.ReceiveTimeout;
14 import akka.actor.UntypedActor;
15 import com.google.common.base.Preconditions;
16 import java.util.concurrent.TimeoutException;
17 import org.apache.commons.lang3.SerializationUtils;
18 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
19 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
20 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
21 import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
22 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
23 import org.slf4j.Logger;
24 import org.slf4j.LoggerFactory;
25 import scala.concurrent.duration.Duration;
28 * Temporary actor used to receive a CaptureSnapshotReply message and return a GetSnapshotReply instance.
30 * @author Thomas Pantelis
32 class GetSnapshotReplyActor extends UntypedActor {
33 private static final Logger LOG = LoggerFactory.getLogger(GetSnapshotReplyActor.class);
35 private final Params params;
37 private GetSnapshotReplyActor(Params params) {
40 getContext().setReceiveTimeout(params.receiveTimeout);
44 public void onReceive(Object message) {
45 if (message instanceof CaptureSnapshotReply) {
46 Snapshot snapshot = Snapshot.create(
47 ((CaptureSnapshotReply)message).getSnapshotState(),
48 params.captureSnapshot.getUnAppliedEntries(),
49 params.captureSnapshot.getLastIndex(), params.captureSnapshot.getLastTerm(),
50 params.captureSnapshot.getLastAppliedIndex(), params.captureSnapshot.getLastAppliedTerm(),
51 params.electionTerm.getCurrentTerm(), params.electionTerm.getVotedFor(),
52 params.peerInformation);
54 LOG.debug("{}: Received CaptureSnapshotReply, sending {}", params.id, snapshot);
56 params.replyToActor.tell(new GetSnapshotReply(params.id, SerializationUtils.serialize(snapshot)),
58 getSelf().tell(PoisonPill.getInstance(), getSelf());
59 } else if (message instanceof ReceiveTimeout) {
60 LOG.warn("{}: Got ReceiveTimeout for inactivity - did not receive CaptureSnapshotReply within {} ms",
61 params.id, params.receiveTimeout.toMillis());
63 params.replyToActor.tell(new akka.actor.Status.Failure(new TimeoutException(String.format(
64 "Timed out after %d ms while waiting for CaptureSnapshotReply",
65 params.receiveTimeout.toMillis()))), getSelf());
66 getSelf().tell(PoisonPill.getInstance(), getSelf());
70 public static Props props(CaptureSnapshot captureSnapshot, ElectionTerm electionTerm, ActorRef replyToActor,
71 Duration receiveTimeout, String id, ServerConfigurationPayload updatedPeerInfo) {
72 return Props.create(GetSnapshotReplyActor.class, new Params(captureSnapshot, electionTerm, replyToActor,
73 receiveTimeout, id, updatedPeerInfo));
76 private static final class Params {
77 final CaptureSnapshot captureSnapshot;
78 final ActorRef replyToActor;
79 final ElectionTerm electionTerm;
80 final Duration receiveTimeout;
82 final ServerConfigurationPayload peerInformation;
84 Params(CaptureSnapshot captureSnapshot, ElectionTerm electionTerm, ActorRef replyToActor,
85 Duration receiveTimeout, String id, ServerConfigurationPayload peerInfo) {
86 this.captureSnapshot = Preconditions.checkNotNull(captureSnapshot);
87 this.electionTerm = Preconditions.checkNotNull(electionTerm);
88 this.replyToActor = Preconditions.checkNotNull(replyToActor);
89 this.receiveTimeout = Preconditions.checkNotNull(receiveTimeout);
90 this.id = Preconditions.checkNotNull(id);
91 this.peerInformation = peerInfo;