Introduce a mechanism for a Follower to signal it's sync up status
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / base / messages / FollowerInitialSyncUpStatus.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8
9 package org.opendaylight.controller.cluster.raft.base.messages;
10
11 /**
12  * The FollowerInitialSyncUpStatus is sent by a Follower to inform any RaftActor subclass whether the Follower
13  * is at least at the same commitIndex as the Leader was when it sent the follower the very first heartbeat.
14  *
15  * This status can be used to determine if a Follower has caught up with the current Leader in an upgrade scenario
16  * for example.
17  *
18  */
19 public class FollowerInitialSyncUpStatus {
20     private final boolean initialSyncDone;
21
22     public FollowerInitialSyncUpStatus(boolean initialSyncDone){
23         this.initialSyncDone = initialSyncDone;
24     }
25
26     public boolean isInitialSyncDone() {
27         return initialSyncDone;
28     }
29 }