opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java

   1 /*
   2  * Copyright (c) 2014 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.behaviors;
  10
  11 import akka.actor.ActorRef;
  12 import org.opendaylight.controller.cluster.raft.RaftActorContext;
  13 import org.opendaylight.controller.cluster.raft.RaftState;
  14 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
  15 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
  16 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
  17 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
  18
  19 import java.util.List;
  20
  21 /**
  22  * The behavior of a RaftActor when it is in the CandidateState
  23  * <p>
  24  * Candidates (§5.2):
  25  * <ul>
  26  * <li> On conversion to candidate, start election:
  27  * <ul>
  28  * <li> Increment currentTerm
  29  * <li> Vote for self
  30  * <li> Reset election timer
  31  * <li> Send RequestVote RPCs to all other servers
  32  * </ul>
  33  * <li> If votes received from majority of servers: become leader
  34  * <li> If AppendEntries RPC received from new leader: convert to
  35  * follower
  36  * <li> If election timeout elapses: start new election
  37  * </ul>
  38  */
  39 public class Candidate extends AbstractRaftActorBehavior {
  40     private final List<String> peers;
  41
  42     public Candidate(RaftActorContext context, List<String> peers) {
  43         super(context);
  44         this.peers = peers;
  45     }
  46
  47     @Override protected RaftState handleAppendEntries(ActorRef sender,
  48         AppendEntries appendEntries, RaftState suggestedState) {
  49         return suggestedState;
  50     }
  51
  52     @Override protected RaftState handleAppendEntriesReply(ActorRef sender,
  53         AppendEntriesReply appendEntriesReply, RaftState suggestedState) {
  54         return suggestedState;
  55     }
  56
  57     @Override protected RaftState handleRequestVote(ActorRef sender,
  58         RequestVote requestVote, RaftState suggestedState) {
  59         return suggestedState;
  60     }
  61
  62     @Override protected RaftState handleRequestVoteReply(ActorRef sender,
  63         RequestVoteReply requestVoteReply, RaftState suggestedState) {
  64         return suggestedState;
  65     }
  66
  67     @Override protected RaftState state() {
  68         return RaftState.Candidate;
  69     }
  70
  71     @Override
  72     public RaftState handleMessage(ActorRef sender, Object message) {
  73         return super.handleMessage(sender, message);
  74     }
  75 }