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 com.google.common.base.Preconditions;
12 import java.io.Externalizable;
13 import java.io.IOException;
14 import java.io.ObjectInput;
15 import java.io.ObjectOutput;
16 import java.util.ArrayList;
17 import java.util.List;
18 import javax.annotation.Nonnull;
19 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
20 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
21 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
24 * Invoked by leader to replicate log entries (§5.3); also used as
27 public class AppendEntries extends AbstractRaftRPC {
28 private static final long serialVersionUID = 1L;
30 // So that follower can redirect clients
31 private final String leaderId;
33 // Index of log entry immediately preceding new ones
34 private final long prevLogIndex;
36 // term of prevLogIndex entry
37 private final long prevLogTerm;
39 // log entries to store (empty for heart beat - may send more than one for efficiency)
40 private final List<ReplicatedLogEntry> entries;
42 // leader's commitIndex
43 private final long leaderCommit;
45 // index which has been replicated successfully to all followers, -1 if none
46 private final long replicatedToAllIndex;
48 private final short payloadVersion;
50 public AppendEntries(long term, @Nonnull String leaderId, long prevLogIndex, long prevLogTerm,
51 @Nonnull List<ReplicatedLogEntry> entries, long leaderCommit, long replicatedToAllIndex,
52 short payloadVersion) {
54 this.leaderId = Preconditions.checkNotNull(leaderId);
55 this.prevLogIndex = prevLogIndex;
56 this.prevLogTerm = prevLogTerm;
57 this.entries = Preconditions.checkNotNull(entries);
58 this.leaderCommit = leaderCommit;
59 this.replicatedToAllIndex = replicatedToAllIndex;
60 this.payloadVersion = payloadVersion;
64 public String getLeaderId() {
68 public long getPrevLogIndex() {
72 public long getPrevLogTerm() {
77 public List<ReplicatedLogEntry> getEntries() {
81 public long getLeaderCommit() {
85 public long getReplicatedToAllIndex() {
86 return replicatedToAllIndex;
89 public short getPayloadVersion() {
90 return payloadVersion;
94 public String toString() {
95 return "AppendEntries [leaderId=" + leaderId
96 + ", prevLogIndex=" + prevLogIndex
97 + ", prevLogTerm=" + prevLogTerm
98 + ", leaderCommit=" + leaderCommit
99 + ", replicatedToAllIndex=" + replicatedToAllIndex
100 + ", payloadVersion=" + payloadVersion
101 + ", entries=" + entries + "]";
104 private Object writeReplace() {
105 return new Proxy(this);
108 private static class Proxy implements Externalizable {
109 private static final long serialVersionUID = 1L;
111 private AppendEntries appendEntries;
113 // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
114 // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
115 @SuppressWarnings("checkstyle:RedundantModifier")
119 Proxy(AppendEntries appendEntries) {
120 this.appendEntries = appendEntries;
124 public void writeExternal(ObjectOutput out) throws IOException {
125 out.writeLong(appendEntries.getTerm());
126 out.writeObject(appendEntries.leaderId);
127 out.writeLong(appendEntries.prevLogTerm);
128 out.writeLong(appendEntries.prevLogIndex);
129 out.writeLong(appendEntries.leaderCommit);
130 out.writeLong(appendEntries.replicatedToAllIndex);
131 out.writeShort(appendEntries.payloadVersion);
133 out.writeInt(appendEntries.entries.size());
134 for (ReplicatedLogEntry e: appendEntries.entries) {
135 out.writeLong(e.getIndex());
136 out.writeLong(e.getTerm());
137 out.writeObject(e.getData());
142 public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
143 long term = in.readLong();
144 String leaderId = (String) in.readObject();
145 long prevLogTerm = in.readLong();
146 long prevLogIndex = in.readLong();
147 long leaderCommit = in.readLong();
148 long replicatedToAllIndex = in.readLong();
149 short payloadVersion = in.readShort();
151 int size = in.readInt();
152 List<ReplicatedLogEntry> entries = new ArrayList<>(size);
153 for (int i = 0; i < size; i++) {
154 entries.add(new SimpleReplicatedLogEntry(in.readLong(), in.readLong(), (Payload) in.readObject()));
157 appendEntries = new AppendEntries(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit,
158 replicatedToAllIndex, payloadVersion);
161 private Object readResolve() {
162 return appendEntries;