opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/DefaultConfigParamsImpl.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 package org.opendaylight.controller.cluster.raft;
   9
  10 import java.util.concurrent.TimeUnit;
  11 import scala.concurrent.duration.FiniteDuration;
  12
  13 /**
  14  * Default implementation of the ConfigParams
  15  *
  16  * If no implementation is provided for ConfigParams, then this will be used.
  17  */
  18 public class DefaultConfigParamsImpl implements ConfigParams {
  19
  20     private static final int SNAPSHOT_BATCH_COUNT = 20000;
  21
  22     private static final int JOURNAL_RECOVERY_LOG_BATCH_SIZE = 1000;
  23
  24     /**
  25      * The maximum election time variance
  26      */
  27     private static final int ELECTION_TIME_MAX_VARIANCE = 100;
  28
  29     private static final int SNAPSHOT_CHUNK_SIZE = 2048 * 1000; //2MB
  30
  31
  32     /**
  33      * The interval at which a heart beat message will be sent to the remote
  34      * RaftActor
  35      * <p/>
  36      * Since this is set to 100 milliseconds the Election timeout should be
  37      * at least 200 milliseconds
  38      */
  39     public static final FiniteDuration HEART_BEAT_INTERVAL =
  40         new FiniteDuration(100, TimeUnit.MILLISECONDS);
  41
  42
  43     private FiniteDuration heartBeatInterval = HEART_BEAT_INTERVAL;
  44     private long snapshotBatchCount = SNAPSHOT_BATCH_COUNT;
  45     private int journalRecoveryLogBatchSize = JOURNAL_RECOVERY_LOG_BATCH_SIZE;
  46     private FiniteDuration isolatedLeaderCheckInterval =
  47         new FiniteDuration(HEART_BEAT_INTERVAL.length() * 1000, HEART_BEAT_INTERVAL.unit());
  48
  49     // 12 is just an arbitrary percentage. This is the amount of the total memory that a raft actor's
  50     // in-memory journal can use before it needs to snapshot
  51     private int snapshotDataThresholdPercentage = 12;
  52
  53     public void setHeartBeatInterval(FiniteDuration heartBeatInterval) {
  54         this.heartBeatInterval = heartBeatInterval;
  55     }
  56
  57     public void setSnapshotBatchCount(long snapshotBatchCount) {
  58         this.snapshotBatchCount = snapshotBatchCount;
  59     }
  60
  61     public void setSnapshotDataThresholdPercentage(int snapshotDataThresholdPercentage){
  62         this.snapshotDataThresholdPercentage = snapshotDataThresholdPercentage;
  63     }
  64
  65     public void setJournalRecoveryLogBatchSize(int journalRecoveryLogBatchSize) {
  66         this.journalRecoveryLogBatchSize = journalRecoveryLogBatchSize;
  67     }
  68
  69     public void setIsolatedLeaderCheckInterval(FiniteDuration isolatedLeaderCheckInterval) {
  70         this.isolatedLeaderCheckInterval = isolatedLeaderCheckInterval;
  71     }
  72
  73     @Override
  74     public long getSnapshotBatchCount() {
  75         return snapshotBatchCount;
  76     }
  77
  78     @Override
  79     public int getSnapshotDataThresholdPercentage() {
  80         return snapshotDataThresholdPercentage;
  81     }
  82
  83
  84     @Override
  85     public FiniteDuration getHeartBeatInterval() {
  86         return heartBeatInterval;
  87     }
  88
  89     @Override
  90     public FiniteDuration getElectionTimeOutInterval() {
  91         // returns 2 times the heart beat interval
  92         return getHeartBeatInterval().$times(2);
  93     }
  94
  95     @Override
  96     public int getElectionTimeVariance() {
  97         return ELECTION_TIME_MAX_VARIANCE;
  98     }
  99
 100     @Override
 101     public int getSnapshotChunkSize() {
 102         return SNAPSHOT_CHUNK_SIZE;
 103     }
 104
 105     @Override
 106     public int getJournalRecoveryLogBatchSize() {
 107         return journalRecoveryLogBatchSize;
 108     }
 109
 110     @Override
 111     public FiniteDuration getIsolatedCheckInterval() {
 112         return isolatedLeaderCheckInterval;
 113     }
 114 }