opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/Payload.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.protobuff.client.messages;
  10
  11
  12
  13 /**
  14  * An instance of a Payload class is meant to be used as the Payload for
  15  * AppendEntries.
  16  * <p>
  17  *
  18  * When an actor which is derived from RaftActor attempts to persistData it
  19  * must pass an instance of the Payload class. Similarly when state needs to
  20  * be applied to the derived RaftActor it will be passed an instance of the
  21  * Payload class.
  22  */
  23 public abstract class Payload {
  24     public abstract int size();
  25 }