2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.cluster.raft.messages;
11 import java.io.Externalizable;
12 import java.io.IOException;
13 import java.io.ObjectInput;
14 import java.io.ObjectOutput;
15 import java.util.ArrayList;
16 import java.util.List;
17 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
18 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
19 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
22 * Invoked by leader to replicate log entries (§5.3); also used as
25 public class AppendEntries extends AbstractRaftRPC {
26 private static final long serialVersionUID = 1L;
28 // So that follower can redirect clients
29 private final String leaderId;
31 // Index of log entry immediately preceding new ones
32 private final long prevLogIndex;
34 // term of prevLogIndex entry
35 private final long prevLogTerm;
37 // log entries to store (empty for heart beat - may send more than one for efficiency)
38 private final List<ReplicatedLogEntry> entries;
40 // leader's commitIndex
41 private final long leaderCommit;
43 // index which has been replicated successfully to all followers, -1 if none
44 private final long replicatedToAllIndex;
46 private final short payloadVersion;
48 public AppendEntries(long term, String leaderId, long prevLogIndex, long prevLogTerm,
49 List<ReplicatedLogEntry> entries, long leaderCommit, long replicatedToAllIndex, short payloadVersion) {
51 this.leaderId = leaderId;
52 this.prevLogIndex = prevLogIndex;
53 this.prevLogTerm = prevLogTerm;
54 this.entries = entries;
55 this.leaderCommit = leaderCommit;
56 this.replicatedToAllIndex = replicatedToAllIndex;
57 this.payloadVersion = payloadVersion;
60 public String getLeaderId() {
64 public long getPrevLogIndex() {
68 public long getPrevLogTerm() {
72 public List<ReplicatedLogEntry> getEntries() {
76 public long getLeaderCommit() {
80 public long getReplicatedToAllIndex() {
81 return replicatedToAllIndex;
84 public short getPayloadVersion() {
85 return payloadVersion;
89 public String toString() {
90 StringBuilder builder = new StringBuilder();
91 builder.append("AppendEntries [leaderId=").append(leaderId).append(", prevLogIndex=").append(prevLogIndex)
92 .append(", prevLogTerm=").append(prevLogTerm).append(", leaderCommit=").append(leaderCommit)
93 .append(", replicatedToAllIndex=").append(replicatedToAllIndex).append(", payloadVersion=")
94 .append(payloadVersion).append(", entries=").append(entries).append("]");
95 return builder.toString();
98 private Object writeReplace() {
99 return new Proxy(this);
102 private static class Proxy implements Externalizable {
103 private static final long serialVersionUID = 1L;
105 private AppendEntries appendEntries;
107 // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
108 // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
109 @SuppressWarnings("checkstyle:RedundantModifier")
113 Proxy(AppendEntries appendEntries) {
114 this.appendEntries = appendEntries;
118 public void writeExternal(ObjectOutput out) throws IOException {
119 out.writeLong(appendEntries.getTerm());
120 out.writeObject(appendEntries.leaderId);
121 out.writeLong(appendEntries.prevLogTerm);
122 out.writeLong(appendEntries.prevLogIndex);
123 out.writeLong(appendEntries.leaderCommit);
124 out.writeLong(appendEntries.replicatedToAllIndex);
125 out.writeShort(appendEntries.payloadVersion);
127 out.writeInt(appendEntries.entries.size());
128 for (ReplicatedLogEntry e: appendEntries.entries) {
129 out.writeLong(e.getIndex());
130 out.writeLong(e.getTerm());
131 out.writeObject(e.getData());
136 public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
137 long term = in.readLong();
138 String leaderId = (String) in.readObject();
139 long prevLogTerm = in.readLong();
140 long prevLogIndex = in.readLong();
141 long leaderCommit = in.readLong();
142 long replicatedToAllIndex = in.readLong();
143 short payloadVersion = in.readShort();
145 int size = in.readInt();
146 List<ReplicatedLogEntry> entries = new ArrayList<>(size);
147 for (int i = 0; i < size; i++) {
148 entries.add(new SimpleReplicatedLogEntry(in.readLong(), in.readLong(), (Payload) in.readObject()));
151 appendEntries = new AppendEntries(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit,
152 replicatedToAllIndex, payloadVersion);
155 private Object readResolve() {
156 return appendEntries;