opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLogEntry.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;
  10
  11 import org.opendaylight.controller.cluster.raft.messages.Payload;
  12
  13 /**
  14  * Represents one entry in the replicated log.
  15  */
  16 public interface ReplicatedLogEntry {
  17     /**
  18      * Returns the payload/data to be replicated.
  19      *
  20      * @return the payload/data
  21      */
  22     Payload getData();
  23
  24     /**
  25      * Returns the term of the entry.
  26      *
  27      * @return the term
  28      */
  29     long getTerm();
  30
  31     /**
  32      * Returns the index of the entry.
  33      *
  34      * @return the index
  35      */
  36     long getIndex();
  37
  38     /**
  39      * Returns the size of the entry in bytes. An approximate number may be good enough.
  40      *
  41      * @return the size of the entry in bytes.
  42      */
  43     int size();
  44
  45     /**
  46      * Return the estimate of serialized size of this entry when passed through serialization. The estimate needs to
  47      * be reasonably accurate and should err on the side of caution and report a slightly-higher size in face of
  48      * uncertainty.
  49      *
  50      * @return An estimate of serialized size.
  51      */
  52     int serializedSize();
  53
  54     /**
  55      * Checks if persistence is pending for this entry.
  56      *
  57      * @return true if persistence is pending, false otherwise.
  58      */
  59     boolean isPersistencePending();
  60
  61     /**
  62      * Sets whether or not persistence is pending for this entry.
  63      *
  64      * @param pending the new setting.
  65      */
  66     void setPersistencePending(boolean pending);
  67 }