Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abortTransfer() - Method in class org.opendaylight.controller.cluster.raft.RaftActorLeadershipTransferCohort
-
This method is invoked to abort leadership transfer on failure.
- AbstractBuilder() - Constructor for class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- AbstractLeader - Class in org.opendaylight.controller.cluster.raft.behaviors
-
The behavior of a RaftActor when it is in the Leader state.
- AbstractLeader(RaftActorContext, RaftState) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- AbstractLeader(RaftActorContext, RaftState, AbstractLeader) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- AbstractRaftActorBehavior - Class in org.opendaylight.controller.cluster.raft.behaviors
-
Abstract class that provides common code for a RaftActor behavior.
- AbstractRaftRPC - Class in org.opendaylight.controller.cluster.raft.messages
- AbstractReplicatedLogImpl - Class in org.opendaylight.controller.cluster.raft
-
Abstract class handling the mapping of logical LogEntry Index and the physical list index.
- AbstractReplicatedLogImpl() - Constructor for class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- AbstractReplicatedLogImpl(long, long, List<ReplicatedLogEntry>, String) - Constructor for class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- AbstractServerChangeReply - Class in org.opendaylight.controller.cluster.raft.messages
-
Abstract base class for a server configuration change reply.
- actor() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the actor associated with this behavior.
- actorOf(Props) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Creates a new local actor.
- actorOf(Props) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- actorSelection(String) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Creates an actor selection.
- actorSelection(String) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- addFollower(String) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- AddServer - Class in org.opendaylight.controller.cluster.raft.messages
-
Message sent to add a new server/replica (§4.1).
- AddServer(String, String, boolean) - Constructor for class org.opendaylight.controller.cluster.raft.messages.AddServer
- AddServerReply - Class in org.opendaylight.controller.cluster.raft.messages
-
Reply to an AddServer message (§4.1).
- AddServerReply(ServerChangeStatus, String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.AddServerReply
- addToPeers(String, String, VotingState) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Adds a new peer.
- addToPeers(String, String, VotingState) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- adjustedIndex(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- ALREADY_EXISTS - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
For an AddServer request, the server to add already exists.
- anyVotingPeers() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Determines if there are any voting peers.
- anyVotingPeers() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- append(ReplicatedLogEntry) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- append(ReplicatedLogEntry) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Appends an entry to the log.
- appendAndPersist(ReplicatedLogEntry, Consumer<ReplicatedLogEntry>, boolean) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Appends an entry to the in-memory log and persists it as well.
- appendEntries(ActorRef, AppendEntries) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Handles the common logic for the AppendEntries message and delegates handling to the derived class.
- AppendEntries - Class in org.opendaylight.controller.cluster.raft.messages
-
Invoked by leader to replicate log entries (§5.3); also used as heartbeat (§5.2).
- AppendEntries(long, String, long, long, List<ReplicatedLogEntry>, long, long, short) - Constructor for class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- AppendEntries(long, String, long, long, List<ReplicatedLogEntry>, long, long, short, short, String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- AppendEntriesReply - Class in org.opendaylight.controller.cluster.raft.messages
-
Reply for the AppendEntries message.
- AppendEntriesReply(String, long, boolean, long, long, short) - Constructor for class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- AppendEntriesReply(String, long, boolean, long, long, short, boolean, boolean, short) - Constructor for class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- appendRecoveredLogEntry(Payload) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort
-
This method is called during recovery to append state data to the current batch.
- apply(Object) - Method in class org.opendaylight.controller.cluster.raft.NoopProcedure
- apply(ApplySnapshot) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- apply(ApplySnapshot) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Applies a snapshot on a follower that was installed by the leader.
- applyCurrentLogRecoveryBatch() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort
-
This method is called during recovery at the end of a batch to apply the current batched log entries.
- ApplyJournalEntries - Class in org.opendaylight.controller.cluster.raft.persisted
-
This is an internal message that is stored in the akka's persistent journal.
- ApplyJournalEntries(long) - Constructor for class org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries
- applyLogToStateMachine(long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Applies the log entries up to the specified index that is known to be committed to the state machine.
- applyModificationToStateBeforeConsensus() - Method in class org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy
- applyModificationToStateBeforeConsensus() - Method in class org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy
- applyModificationToStateBeforeConsensus() - Method in interface org.opendaylight.controller.cluster.raft.policy.RaftPolicy
-
According to Raft consensus on a Raft entry is achieved only after a Leader replicates a log entry to a majority of it's followers.
- applyRecoverySnapshot(Snapshot.State) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort
-
This method is called during recovery to reconstruct the state of the actor.
- applySnapshot(Snapshot.State) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort
-
This method is called to apply a snapshot installed by the leader.
- applySnapshot(Snapshot.State) - Method in class org.opendaylight.controller.cluster.raft.NoopRaftActorSnapshotCohort
- ApplySnapshot - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Internal message, issued by follower to its actor.
- ApplySnapshot(Snapshot) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot
- ApplySnapshot(Snapshot, ApplySnapshot.Callback) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot
- ApplySnapshot.Callback - Interface in org.opendaylight.controller.cluster.raft.base.messages
- applyState(ActorRef, Identifier, Object) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
The applyState method will be called by the RaftActor when some data needs to be applied to the actor's state.
- ApplyState - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Local message sent by a RaftActor to itself to signal state has been applied to the state machine.
- ApplyState(ActorRef, Identifier, ReplicatedLogEntry) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.ApplyState
- ARGON_VERSION - Static variable in class org.opendaylight.controller.cluster.raft.RaftVersions
- automaticElectionsEnabled() - Method in class org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy
- automaticElectionsEnabled() - Method in class org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy
- automaticElectionsEnabled() - Method in interface org.opendaylight.controller.cluster.raft.policy.RaftPolicy
-
According to Raft a Follower which does not receive a heartbeat (aka AppendEntries) in a given period should become a Candidate and trigger an election.
B
- beforeSendHeartbeat() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- beforeSendHeartbeat() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Leader
- build() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- builder() - Static method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- Builder() - Constructor for class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.Builder
C
- Candidate - Class in org.opendaylight.controller.cluster.raft.behaviors
-
The behavior of a RaftActor when it is in the Candidate raft state.
- Candidate - Enum constant in enum class org.opendaylight.controller.cluster.raft.RaftState
- Candidate(RaftActorContext) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- canGrantVote(RequestVote) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- canStartElection() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- capture(ReplicatedLogEntry, long) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- capture(ReplicatedLogEntry, long) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Initiates a capture snapshot.
- CaptureSnapshot - Class in org.opendaylight.controller.cluster.raft.base.messages
- CaptureSnapshot(long, long, long, long, long, long, List<ReplicatedLogEntry>, boolean) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- captureSnapshotIfReady(ReplicatedLogEntry) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Determines if a snapshot needs to be captured based on the count/memory consumed and initiates the capture.
- CaptureSnapshotReply - Class in org.opendaylight.controller.cluster.raft.base.messages
- CaptureSnapshotReply(Snapshot.State, Optional<OutputStream>) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply
- captureToInstall(ReplicatedLogEntry, long, String) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- captureToInstall(ReplicatedLogEntry, long, String) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Initiates a capture snapshot for the purposing of installing the snapshot on a follower.
- captureWithForcedTrim(ReplicatedLogEntry, long) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- captureWithForcedTrim(ReplicatedLogEntry, long) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Initiates a capture snapshot, while enforcing trimming of the log up to lastAppliedIndex.
- changeCurrentBehavior(RaftActorBehavior) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- ChangeServersVotingStatus - Class in org.opendaylight.controller.cluster.raft.messages
-
Message sent to change the raft voting status for servers.
- ChangeServersVotingStatus(Map<String, Boolean>) - Constructor for class org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus
- ChangeServersVotingStatus(Map<String, Boolean>, Collection<String>) - Constructor for class org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus
- CheckConsensusReached - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Internal message sent to the leader after persistence is complete to check if replication consensus has been reached.
- clear(int, int) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- clear(int, int) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Clears the journal entries with startIndex (inclusive) and endIndex (exclusive).
- clearLeaderInstallSnapshotState() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Clears the LeaderInstallSnapshotState when an install snapshot is complete.
- clientActor() - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Returns the value of the
clientActorrecord component. - clientActor() - Method in record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Returns the value of the
clientActorrecord component. - ClientRequestTracker - Record Class in org.opendaylight.controller.cluster.raft
-
Consensus forwarding tracker.
- ClientRequestTracker(long, ActorRef, Identifier) - Constructor for record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Creates an instance of a
ClientRequestTrackerrecord class. - close() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- close() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- close() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- close() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Leader
- close() - Method in class org.opendaylight.controller.cluster.raft.behaviors.LeaderInstallSnapshotState
- close() - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
- commit(long, long) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- commit(long, long) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Commit the snapshot by trimming the log.
- commitIndex(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- ConfigParams - Interface in org.opendaylight.controller.cluster.raft
-
Configuration Parameter interface for configuring the Raft consensus system.
- context - Variable in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Information about the RaftActor whose behavior this class represents.
- convertSnapshot(ByteSource) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- copyOf(ElectionTerm) - Static method in class org.opendaylight.controller.cluster.raft.ImmutableElectionTerm
- create(Snapshot.State, List<ReplicatedLogEntry>, long, long, long, long, long, String, ServerConfigurationPayload) - Static method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- createBehavior(RaftActorContext, RaftState) - Static method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- createSnapshot(ActorRef, Optional<OutputStream>) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort
-
This method is called by the RaftActor when a snapshot needs to be created.
- createSnapshot(ActorRef, Optional<OutputStream>) - Method in class org.opendaylight.controller.cluster.raft.NoopRaftActorSnapshotCohort
- CURRENT_VERSION - Static variable in class org.opendaylight.controller.cluster.raft.RaftVersions
- currentTerm() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the current election term.
- currentTerm(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- customRaftPolicyClassName(String) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
D
- dataSize() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- dataSize() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Returns the size of the data in the log (in bytes).
- decrNextIndex(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Decrements the value of the follower's next index, taking into account its reported last log index.
- DefaultConfigParamsImpl - Class in org.opendaylight.controller.cluster.raft
-
Default implementation of the ConfigParams.
- DefaultConfigParamsImpl() - Constructor for class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- DefaultRaftPolicy - Class in org.opendaylight.controller.cluster.raft.policy
- DefaultRaftPolicy() - Constructor for class org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy
- DeleteEntries - Class in org.opendaylight.controller.cluster.raft.persisted
-
Internal message that is stored in the akka's persistent journal to delete journal entries.
- DeleteEntries(long) - Constructor for class org.opendaylight.controller.cluster.raft.persisted.DeleteEntries
- deserializeSnapshot(ByteSource) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort
-
This method is called to de-serialize snapshot data that was previously serialized via
RaftActorSnapshotCohort.createSnapshot(akka.actor.ActorRef, java.util.Optional<java.io.OutputStream>)to a State instance. - deserializeSnapshot(ByteSource) - Method in class org.opendaylight.controller.cluster.raft.NoopRaftActorSnapshotCohort
- DisableElectionsRaftPolicy - Class in org.opendaylight.controller.cluster.raft.policy
-
DisableElectionsRaftPolicy can be used for actors that does not participate in shard election.
- DisableElectionsRaftPolicy() - Constructor for class org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy
- DOES_NOT_EXIST - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
For a RemoveServer request, the server to remove does not exist.
E
- electionDuration() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns a duration for election with an additional variance for randomness.
- electionDuration() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- ElectionTerm - Interface in org.opendaylight.controller.cluster.raft
-
ElectionTerm contains information about a RaftActors election term.
- ElectionTimeout - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Local message sent to indicate the current election term has timed out.
- EmptyState - Class in org.opendaylight.controller.cluster.raft.persisted
-
Empty Snapshot State implementation.
- equals(Object) - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- equals(Object) - Method in record class org.opendaylight.controller.cluster.raft.persisted.ServerInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
F
- FindLeader - Class in org.opendaylight.controller.cluster.raft.client.messages
-
Request to locate the leader raft actor.
- FindLeaderReply - Class in org.opendaylight.controller.cluster.raft.client.messages
-
Reply to
FindLeadermessage, containing the address of the leader actor, as known to the raft actor which sent the message. - FindLeaderReply(String) - Constructor for class org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply
- FLUORINE_VERSION - Static variable in class org.opendaylight.controller.cluster.raft.RaftVersions
- Follower - Class in org.opendaylight.controller.cluster.raft.behaviors
-
The behavior of a RaftActor in the Follower raft state.
- Follower - Enum constant in enum class org.opendaylight.controller.cluster.raft.RaftState
- Follower(RaftActorContext) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.Follower
- Follower(RaftActorContext, String, short) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.Follower
- followerInfoList(List<FollowerInfo>) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- FollowerInitialSyncUpStatus - Class in org.opendaylight.controller.cluster.raft.base.messages
-
The FollowerInitialSyncUpStatus is sent by a Follower to inform any RaftActor subclass whether the Follower is at least at the same commitIndex as the Leader was when it sent the follower the very first heart beat.
- FollowerInitialSyncUpStatus(boolean, String) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus
- FollowerLogInformation - Class in org.opendaylight.controller.cluster.raft
-
The state of the followers log as known by the Leader.
- FollowerLogInformation(PeerInfo, RaftActorContext) - Constructor for class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Constructs an instance with no matching index.
- followerLogSize() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- fromBinaryJava(byte[], Class<?>) - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntrySerializer
G
- get(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- get(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Return the replicated log entry at the specified index.
- getActor() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the reference to the RaftActor.
- getActor() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getActorSystem() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the The ActorSystem associated with this context.
- getActorSystem() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getAddress() - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
- getApplyStateConsumer() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the consumer of ApplyState operations.
- getApplyStateConsumer() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getCallback() - Method in class org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot
- getCandidateElectionTimeoutDivisor() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the number by which a candidate should divide the election timeout it has calculated.
- getCandidateElectionTimeoutDivisor() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getCandidateId() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestVote
- getCaptureSnapshot() - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- getChunkIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getChunkIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply
- getClientActor() - Method in class org.opendaylight.controller.cluster.raft.base.messages.ApplyState
- getCluster() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
The akka Cluster singleton for the actor system if one is configured.
- getCluster() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getCommitIndex() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getCommitIndex() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the index of highest log entry known to be committed.
- getCommitIndex() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getConfigParams() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the ConfigParams instance.
- getConfigParams() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getCurrentBehavior() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- getCurrentBehavior() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the current behavior attached to the RaftActor.
- getCurrentBehavior() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getCurrentTerm() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getCurrentTerm() - Method in interface org.opendaylight.controller.cluster.raft.ElectionTerm
-
Returns the current leader's Raft term.
- getCurrentTerm() - Method in class org.opendaylight.controller.cluster.raft.ImmutableElectionTerm
- getCurrentTerm() - Method in class org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm
- getCurrentTerm() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- getCustomRaftPolicyClassName() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getCustomRaftPolicyImplementationClass() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the custom RaftPolicy class name.
- getCustomRaftPolicyImplementationClass() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getData() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getData() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- getData() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Returns the payload/data to be replicated.
- getElectionTerm() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getElectionTimeoutFactor() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the multiplication factor to be used to determine the shard election timeout.
- getElectionTimeoutFactor() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getElectionTimeOutInterval() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the interval after which a new election should be triggered if no leader is available.
- getElectionTimeOutInterval() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getElectionTimeVariance() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the maximum election time variance.
- getElectionTimeVariance() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getElectionVotedFor() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getEntries() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getExecutor() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Return an Executor which is guaranteed to run tasks in the context of
RaftActorContext.getActor(). - getExecutor() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getFileBackedOutputStreamFactory() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the
FileBackedOutputStreamFactoryinstance with a common configuration. - getFileBackedOutputStreamFactory() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getFileBackedStreamingThreshold() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the threshold in terms of number of bytes when streaming data before it should switch from storing in memory to buffering to a file.
- getFileBackedStreamingThreshold() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getFollower(String) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- getFollowerId() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- getFollowerId() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply
- getFollowerId() - Method in class org.opendaylight.controller.cluster.raft.messages.UnInitializedFollowerSnapshotReply
- getFollowerIds() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
-
Return an immutable collection of follower identifiers.
- getFollowerInfoList() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getFrom(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- getFrom(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Returns a list of log entries starting from the given index to the end of the log.
- getFrom(long, int, long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- getFrom(long, int, long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Returns a list of log entries starting from the given index up to the given maximum of entries or the given maximum accumulated size, whichever comes first.
- getFromIndex() - Method in class org.opendaylight.controller.cluster.raft.persisted.DeleteEntries
- getHeartBeatInterval() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the interval at which a heart beat message should be sent to remote followers.
- getHeartBeatInterval() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getId() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- getId() - Method in class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply
- getId() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the identifier of the follower.
- getId() - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
- getId() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- getId() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the identifier for the RaftActor.
- getId() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getIdentifier() - Method in class org.opendaylight.controller.cluster.raft.base.messages.ApplyState
- getIndex() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- getIndex() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Returns the index of the entry.
- getInMemoryJournalDataSize() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getInMemoryJournalLogSize() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getInstallSnapshotState() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the LeaderInstallSnapshotState for the in progress install snapshot.
- getInstallSnapshotStream() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply
- getIsolatedCheckIntervalInMillis() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the interval in which the leader needs to check if its isolated.
- getIsolatedCheckIntervalInMillis() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getJournalRecoveryLogBatchSize() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the maximum number of journal log entries to batch on recovery before applying.
- getJournalRecoveryLogBatchSize() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getLastApplied() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getLastApplied() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns index of highest log entry applied to state machine.
- getLastApplied() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getLastAppliedIndex() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getLastAppliedIndex() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getLastAppliedTerm() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getLastAppliedTerm() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getLastChunkHashCode() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getLastIncludedIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getLastIncludedTerm() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getLastIndex() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getLastIndex() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getLastIndex() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getLastLogIndex() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getLastLogIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestVote
- getLastLogTerm() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getLastLogTerm() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestVote
- getLastSequenceNumber() - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- getLastTerm() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getLastTerm() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getLastTerm() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getLeader() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getLeader() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Derived actor can call getLeader if they need a reference to the Leader.
- getLeaderActor() - Method in class org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply
- getLeaderCommit() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getLeaderHint() - Method in class org.opendaylight.controller.cluster.raft.messages.AbstractServerChangeReply
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- getLeaderId() - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Returns the id of the leader.
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getLeaderId() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Returns the id of the current leader.
- getLeaderPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- getLeaderPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- getLeaderPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- getLeaderPayloadVersion() - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Returns the leader's payload data version.
- getLeaderRaftVersion() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getLogEntryIndex(long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the actual index of the entry in replicated log for the given index or -1 if not found.
- getLogEntryOrSnapshotTerm(long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the actual term of the entry in the replicated log for the given index or, if not present, returns the snapshot term if the given index is in the snapshot or -1 otherwise.
- getLogEntryTerm(long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the actual term of the entry in the replicated log for the given index or -1 if not found.
- getLogger() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the logger to be used for logging messages.
- getLogger() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getLogLastIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- getLogLastTerm() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- getMajorityVoteCount(int) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- getMatchIndex() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the index of highest log entry known to be replicated on the follower.
- getMaximumMessageSliceSize() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the maximum size (in bytes) for the snapshot chunk sent from a Leader.
- getMaximumMessageSliceSize() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getMinIsolatedLeaderPeerCount() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- getName() - Method in class org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus
- getNewServerAddress() - Method in class org.opendaylight.controller.cluster.raft.messages.AddServer
- getNewServerId() - Method in class org.opendaylight.controller.cluster.raft.messages.AddServer
- getNewState() - Method in class org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior
- getNewTerm() - Method in class org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior
- getNextIndex() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the index of the next log entry to send to the follower.
- GetOnDemandRaftState - Class in org.opendaylight.controller.cluster.raft.client.messages
-
Local message sent to a RaftActor to obtain a snapshot of statistical information.
- getPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the log entry payload data version of the follower.
- getPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- getPayloadVersion() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the payload version to be used when replicating data.
- getPayloadVersion() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeerActorSelection(String) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns an ActorSelection for a peer.
- getPeerActorSelection(String) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeerAddress(String) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Gets the address of a peer as a String.
- getPeerAddress(String) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeerAddresses() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getPeerAddressResolver() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the PeerAddressResolver.
- getPeerAddressResolver() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getPeerIds() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the id's for each peer.
- getPeerIds() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeerInfo(String) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the PeerInfo for the given peer.
- getPeerInfo(String) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeers() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the PeerInfo instances for each peer.
- getPeers() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeerServerInfo(boolean) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the peer information as a ServerConfigurationPayload if dynamic server configurations have been applied.
- getPeerServerInfo(boolean) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPeerVotingStates() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getPersistenceProvider() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the DataPersistenceProvider instance.
- getPersistenceProvider() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getPrevLogIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getPrevLogTerm() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getRaftActorContext() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- getRaftActorLeadershipTransferCohort() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the RaftActorLeadershipTransferCohort if leadership transfer is in progress.
- getRaftActorLeadershipTransferCohort() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getRaftActorRecoveryCohort() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Returns the RaftActorRecoveryCohort to participate in persistence recovery.
- getRaftActorSnapshotCohort() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Returns the RaftActorSnapshotCohort to participate in snapshot captures.
- getRaftPolicy() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the RaftPolicy used to determine certain Raft behaviors.
- getRaftPolicy() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getRaftPolicy() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the RaftPolicy used to determine certain Raft behaviors.
- getRaftPolicy() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getRaftState() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getRaftState() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- getRaftVersion() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the the raft version of the follower.
- getRaftVersion() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- getRecoverySnapshotIntervalSeconds() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the interval(in seconds) after which a snapshot should be taken during recovery.
- getRecoverySnapshotIntervalSeconds() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getReplicatedLog() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the ReplicatedLog instance.
- getReplicatedLog() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getReplicatedLogEntry() - Method in class org.opendaylight.controller.cluster.raft.base.messages.ApplyState
- getReplicatedToAllIndex() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getReplicatedToAllIndex() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- getReplicatedToAllIndex() - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Returns the index of the last log entry that has been replicated to all peers.
- getReplicatedToAllIndex() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getReplicatedToAllIndex() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- getReplicatedToAllTerm() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getReplyTo() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestLeadership
- getRequestedFollowerId() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestLeadership
- getRequestedFollowerId() - Method in class org.opendaylight.controller.cluster.raft.RaftActorLeadershipTransferCohort
- getRestoreFromSnapshot() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort
-
Returns the snapshot to restore from on recovery.
- getRoleChangeNotifier() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Notifier Actor for this RaftActor to notify when a role change happens.
- getServerConfig() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getServerConfig() - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- getServerConfiguration() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getServerId() - Method in class org.opendaylight.controller.cluster.raft.messages.RemoveServer
- getServerId() - Method in class org.opendaylight.controller.cluster.raft.messages.ServerRemoved
- getServersVisited() - Method in class org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus
- getServerVotingStatusMap() - Method in class org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus
- getSnapshot() - Method in class org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot
- getSnapshot() - Method in class org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot
- getSnapshot() - Method in class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply
- GetSnapshot - Class in org.opendaylight.controller.cluster.raft.client.messages
-
Internal client message to get a snapshot of the current state based on whether or not persistence is enabled.
- GetSnapshot(Timeout) - Constructor for class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot
- getSnapshotBatchCount() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the minimum number of entries to be present in the in-memory Raft log for a snapshot to be taken.
- getSnapshotBatchCount() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getSnapshotBytes() - Method in class org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot
- getSnapshotDataThreshold() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the max size of memory used in the in-memory Raft log before a snapshot should be taken.
- getSnapshotDataThreshold() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getSnapshotDataThresholdPercentage() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the percentage of total memory used in the in-memory Raft log before a snapshot should be taken.
- getSnapshotDataThresholdPercentage() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getSnapshotIndex() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- getSnapshotIndex() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getSnapshotIndex() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Returns the index of the snapshot.
- getSnapshotManager() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the SnapshotManager instance.
- getSnapshotManager() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- GetSnapshotReply - Class in org.opendaylight.controller.cluster.raft.client.messages
-
Reply to GetSnapshot that returns a serialized Snapshot instance.
- GetSnapshotReply(String, Snapshot) - Constructor for class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply
- getSnapshotState() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply
- getSnapshotTerm() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- getSnapshotTerm() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getSnapshotTerm() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Returns the term of the snapshot.
- getState() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getStatus() - Method in class org.opendaylight.controller.cluster.raft.messages.AbstractServerChangeReply
- getSyncIndexThreshold() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the threshold in terms of number journal entries that we can lag behind a leader until we raise a 'not synced' transition.
- getSyncIndexThreshold() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getTempFileDirectory() - Method in interface org.opendaylight.controller.cluster.raft.ConfigParams
-
Returns the directory in which to create temp files.
- getTempFileDirectory() - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- getTerm() - Method in class org.opendaylight.controller.cluster.raft.messages.AbstractRaftRPC
- getTerm() - Method in interface org.opendaylight.controller.cluster.raft.messages.RaftRPC
-
Return the term in which this call is being made.
- getTerm() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- getTerm() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Returns the term of the entry.
- getTermInformation() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the current ElectionTerm information.
- getTermInformation() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getTimeout() - Method in class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot
- getToIndex() - Method in class org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries
- getTotalChunks() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- getTotalMemory() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Returns the total available memory for use in calculations.
- getTotalMemory() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- getUnAppliedEntries() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- getUnAppliedEntries() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- getVotedFor() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- getVotedFor() - Method in interface org.opendaylight.controller.cluster.raft.ElectionTerm
-
Returns the id of the candidate that this server voted for in current term.
- getVotedFor() - Method in class org.opendaylight.controller.cluster.raft.ImmutableElectionTerm
- getVotedFor() - Method in class org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm
- getVotingState() - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
H
- handleAppendEntries(ActorRef, AppendEntries) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- handleAppendEntries(ActorRef, AppendEntries) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Derived classes should not directly handle AppendEntries messages it should let the base class handle it first.
- handleAppendEntries(ActorRef, AppendEntries) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- handleAppendEntries(ActorRef, AppendEntries) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- handleAppendEntriesReply(ActorRef, AppendEntriesReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- handleAppendEntriesReply(ActorRef, AppendEntriesReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Derived classes should not directly handle AppendEntriesReply messages it should let the base class handle it first.
- handleAppendEntriesReply(ActorRef, AppendEntriesReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- handleAppendEntriesReply(ActorRef, AppendEntriesReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- handleAppendEntriesReply(ActorRef, AppendEntriesReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.IsolatedLeader
- handleAppendEntriesReply(ActorRef, AppendEntriesReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Leader
- handleCommand(Object) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Deprecated.
- handleMessage(ActorRef, Object) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- handleMessage(ActorRef, Object) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- handleMessage(ActorRef, Object) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- handleMessage(ActorRef, Object) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- handleMessage(ActorRef, Object) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Leader
- handleMessage(ActorRef, Object) - Method in class org.opendaylight.controller.cluster.raft.behaviors.PreLeader
- handleMessage(ActorRef, Object) - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Handle a message.
- handleNonRaftCommand(Object) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Method exposed for subclasses to plug-in their logic.
- handleRecover(Object) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- handleRequestVoteReply(ActorRef, RequestVoteReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- handleRequestVoteReply(ActorRef, RequestVoteReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Derived classes should not directly handle RequestVoteReply messages it should let the base class handle it first.
- handleRequestVoteReply(ActorRef, RequestVoteReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Candidate
- handleRequestVoteReply(ActorRef, RequestVoteReply) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- hasFollowers() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- hasFollowers() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Determines if there are any peer followers.
- hasFollowers() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- hashCode() - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Returns a hash code value for this object.
- hashCode() - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- hashCode() - Method in record class org.opendaylight.controller.cluster.raft.persisted.ServerInfo
-
Returns a hash code value for this object.
- hashCode() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- hasStaleCommitIndex(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
- HEART_BEAT_INTERVAL - Static variable in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
-
The interval at which a heart beat message will be sent to the remote RaftActor.
I
- IdentifiablePayload<T extends org.opendaylight.yangtools.concepts.Identifier> - Class in org.opendaylight.controller.cluster.raft.messages
- IdentifiablePayload() - Constructor for class org.opendaylight.controller.cluster.raft.messages.IdentifiablePayload
- identifier() - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Returns the value of the
identifierrecord component. - identifier() - Method in record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Returns the value of the
identifierrecord component. - identifier() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntrySerializer
- ImmutableElectionTerm - Class in org.opendaylight.controller.cluster.raft
-
Immutable implementation of ElectionTerm.
- includeManifest() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntrySerializer
- increaseJournalLogCapacity(int) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- increaseJournalLogCapacity(int) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Optimization method to increase the capacity of the journal log prior to appending entries.
- incrMatchIndex() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Increments the value of the follower's match index.
- initiateCaptureSnapshot(String) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
-
Initiates a snapshot capture to install on a follower.
- InitiateCaptureSnapshot - Class in org.opendaylight.controller.cluster.raft.base.messages
- InitiateCaptureSnapshot() - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot
- inMemoryJournalDataSize(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- inMemoryJournalLogSize(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- InstallSnapshot - Class in org.opendaylight.controller.cluster.raft.messages
-
Message sent from a leader to install a snapshot chunk on a follower.
- InstallSnapshot(long, String, long, long, byte[], int, int) - Constructor for class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- InstallSnapshot(long, String, long, long, byte[], int, int, OptionalInt, Optional<ServerConfigurationPayload>, short) - Constructor for class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- InstallSnapshotReply - Class in org.opendaylight.controller.cluster.raft.messages
- InstallSnapshotReply(long, String, int, boolean) - Constructor for class org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply
- instance() - Static method in class org.opendaylight.controller.cluster.raft.NoopProcedure
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.base.messages.CheckConsensusReached
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.client.messages.FindLeader
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.client.messages.Shutdown
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.NoopPeerAddressResolver
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.NoopRaftActorSnapshotCohort
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.persisted.EmptyState
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.persisted.NoopPayload
- INSTANCE - Static variable in class org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy
- internalSwitchBehavior(RaftActorBehavior) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- internalSwitchBehavior(RaftState) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- INVALID_REQUEST - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
Some part of the request is invalid.
- isApplying() - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- isCapturing() - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- isCapturing() - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Returns whether or not a capture is in progress.
- isDynamicServerConfigurationInUse() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Determines if there have been any dynamic server configuration changes applied.
- isDynamicServerConfigurationInUse() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- isFollowerActive() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Checks if the follower is active by comparing the time of the last activity with the election time out.
- isForceInstallSnapshot() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- isInitialSyncDone() - Method in class org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus
- isInSnapshot(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- isInSnapshot(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Checks if the entry is present in a snapshot.
- isLeader() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Derived actors can call the isLeader method to check if the current RaftActor is the Leader or not.
- isLeaderActive() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- isLeaderIsolated() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- isLeadershipTransferInProgress() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- isLogEntrySlicingInProgress() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Return whether or not log entry slicing is currently in progress.
- isMandatoryTrim() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- isMigrated() - Method in interface org.opendaylight.controller.cluster.raft.persisted.LegacySerializable
-
Deprecated, for removal: This API element is subject to removal in a future version.
- isMigrated() - Method in interface org.opendaylight.controller.cluster.raft.persisted.MigratedSerializable
-
Return true if this object was created from a previous serialization format.
- isNeedsLeaderAddress() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- IsolatedLeader - Class in org.opendaylight.controller.cluster.raft.behaviors
-
Leader which is termed as isolated.
- IsolatedLeader - Enum constant in enum class org.opendaylight.controller.cluster.raft.RaftState
- IsolatedLeader(RaftActorContext) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.IsolatedLeader
- isPersistencePending() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- isPersistencePending() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Checks if persistence is pending for this entry.
- isPresent(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- isPresent(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Checks if the entry at the specified index is present or not.
- isSnapshotCaptureInitiated() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- isSnapshotCaptureInitiated(boolean) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- isSuccess() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- isSuccess() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply
- isVoteGranted() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestVoteReply
- isVoting() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- isVoting() - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
- isVoting() - Method in record class org.opendaylight.controller.cluster.raft.persisted.ServerInfo
-
Returns the value of the
isVotingrecord component. - isVoting(boolean) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- isVotingMember() - Method in class org.opendaylight.controller.cluster.raft.messages.AddServer
- isVotingMember() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Determines if this peer is a voting member of the cluster.
- isVotingMember() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
L
- last() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- last() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Return the last replicated log entry in the log or null of not found.
- lastApplied(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- lastIndex() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- lastIndex() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the index of the last entry in the log.
- lastIndex() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Return the index of the last entry in the log or -1 if the log is empty.
- lastIndex(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- lastLogIndex(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- lastLogTerm(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- lastTerm() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- lastTerm() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the term of the last entry in the log.
- lastTerm() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Return the term of the last entry in the log or -1 if the log is empty.
- lastTerm(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- leader(String) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- Leader - Class in org.opendaylight.controller.cluster.raft.behaviors
-
The behavior of a RaftActor when it is in the Leader state.
- Leader - Enum constant in enum class org.opendaylight.controller.cluster.raft.RaftState
- Leader(RaftActorContext) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.Leader
- leaderAddress() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- LeaderInstallSnapshotState - Class in org.opendaylight.controller.cluster.raft.behaviors
-
Encapsulates the leader state and logic for sending snapshot chunks to a follower.
- LeadershipTransferFailedException - Exception in org.opendaylight.controller.cluster.raft
- LeadershipTransferFailedException(String) - Constructor for exception org.opendaylight.controller.cluster.raft.LeadershipTransferFailedException
- LeadershipTransferFailedException(String, Throwable) - Constructor for exception org.opendaylight.controller.cluster.raft.LeadershipTransferFailedException
- LeaderTransitioning - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Message sent from a leader to its followers to indicate leadership transfer is starting.
- LeaderTransitioning(String) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning
- LegacySerializable - Interface in org.opendaylight.controller.cluster.raft.persisted
-
Deprecated.
- log - Variable in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Used for message logging.
- logIndex() - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Returns the value of the
logIndexrecord component. - logIndex() - Method in record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Returns the value of the
logIndexrecord component. - logName() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
M
- markFollowerActive() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Marks the follower as active.
- markFollowerInActive() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Marks the follower as inactive.
- MEGABYTE - Static variable in interface org.opendaylight.controller.cluster.raft.ConfigParams
- MigratedSerializable - Interface in org.opendaylight.controller.cluster.raft.persisted
-
Transitional marker interface for use with evolution of serializable classes held in persistence.
N
- nanosSinceLastActivity() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Returns the time since the last activity occurred for the follower.
- needsLeaderAddress(String) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
- needsMigration() - Method in interface org.opendaylight.controller.cluster.raft.persisted.Snapshot.State
-
Indicate whether the snapshot requires migration, i.e.
- newCaptureSnapshot(ReplicatedLogEntry, long, boolean) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
-
Constructs a CaptureSnapshot instance.
- newLeaderStateChanged(String, String, short) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- newOnDemandRaftStateBuilder() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- newRaftActorRecoverySupport() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- NO_INDEX - Static variable in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
- NO_LEADER - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
No leader exists to process the request.
- NO_MAX_SIZE - Static variable in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
- NON_VOTING - Enum constant in enum class org.opendaylight.controller.cluster.raft.VotingState
- NoopPayload - Class in org.opendaylight.controller.cluster.raft.persisted
-
Payload used for no-op log entries that are put into the journal by the PreLeader in order to commit entries from the prior term.
- NoopPeerAddressResolver - Class in org.opendaylight.controller.cluster.raft
-
Implementation of PeerAddressResolver that does nothing.
- NoopProcedure<T> - Class in org.opendaylight.controller.cluster.raft
-
An akka Procedure that does nothing.
- NoopRaftActorSnapshotCohort - Class in org.opendaylight.controller.cluster.raft
-
RaftActorSnapshotCohort implementation that does nothing.
- NOT_SUPPORTED - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
An unsupported request, for example removing the leader in a single node cluster.
O
- OK - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
Request successfully completed.
- okToReplicate(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
This method checks if the next replicate message can be sent to the follower.
- OnDemandRaftState - Class in org.opendaylight.controller.cluster.raft.client.messages
-
The response to a GetOnDemandRaftState message.
- OnDemandRaftState() - Constructor for class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState
- OnDemandRaftState.AbstractBuilder<B extends OnDemandRaftState.AbstractBuilder<B,
T>, T extends OnDemandRaftState> - Class in org.opendaylight.controller.cluster.raft.client.messages - OnDemandRaftState.Builder - Class in org.opendaylight.controller.cluster.raft.client.messages
- onFailure() - Method in interface org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot.Callback
- onLeaderChanged(String, String) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- onRecoveryComplete() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
This method is called when recovery is complete.
- onStateChanged() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
This method will be called by the RaftActor when the state of the RaftActor changes.
- onSuccess() - Method in interface org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot.Callback
- onVotingStateChangeComplete() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
This method is called on the leader when a voting change operation completes.
- org.opendaylight.controller.cluster.raft - package org.opendaylight.controller.cluster.raft
- org.opendaylight.controller.cluster.raft.base.messages - package org.opendaylight.controller.cluster.raft.base.messages
- org.opendaylight.controller.cluster.raft.behaviors - package org.opendaylight.controller.cluster.raft.behaviors
- org.opendaylight.controller.cluster.raft.client.messages - package org.opendaylight.controller.cluster.raft.client.messages
- org.opendaylight.controller.cluster.raft.messages - package org.opendaylight.controller.cluster.raft.messages
- org.opendaylight.controller.cluster.raft.persisted - package org.opendaylight.controller.cluster.raft.persisted
- org.opendaylight.controller.cluster.raft.policy - package org.opendaylight.controller.cluster.raft.policy
P
- pauseLeader(Runnable) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
This method is called prior to operations such as leadership transfer and actor shutdown when the leader must pause or stop its duties.
- Payload - Class in org.opendaylight.controller.cluster.raft.messages
-
An instance of a
Payloadclass is meant to be used as the Payload forAppendEntries. - Payload() - Constructor for class org.opendaylight.controller.cluster.raft.messages.Payload
- peerAddresses(Map<String, String>) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- PeerAddressResolver - Interface in org.opendaylight.controller.cluster.raft
-
Interface to resolve raft actor peer addresses.
- peerId() - Method in record class org.opendaylight.controller.cluster.raft.persisted.ServerInfo
-
Returns the value of the
peerIdrecord component. - PeerInfo - Class in org.opendaylight.controller.cluster.raft
-
Stores information about a raft peer.
- PeerInfo(String, String, VotingState) - Constructor for class org.opendaylight.controller.cluster.raft.PeerInfo
-
Constructs an instance.
- peerVotingStates(Map<String, Boolean>) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- performSnapshotWithoutCapture(long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Performs a snapshot with no capture on the replicated log.
- persist(Snapshot.State, Optional<OutputStream>, long) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- persist(Snapshot.State, Optional<OutputStream>, long) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Persists a snapshot.
- persistData(ActorRef, Identifier, Payload, boolean) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
Persists the given Payload in the journal and replicates to any followers.
- persistence() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- PersistentPayload - Interface in org.opendaylight.controller.cluster.raft.messages
-
This is a tagging interface for a Payload implementation that needs to always be persisted regardless of whether or not the component is configured to be persistent.
- postStop() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- PreLeader - Class in org.opendaylight.controller.cluster.raft.behaviors
-
The behavior of a RaftActor when it is in the PreLeader state.
- PreLeader - Enum constant in enum class org.opendaylight.controller.cluster.raft.RaftState
- PreLeader(RaftActorContext) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.PreLeader
- preStart() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- printFollowerStates() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- PRIOR_REQUEST_CONSENSUS_TIMEOUT - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
The leader could not process the request due to a prior request that timed out while trying to achieve replication consensus.
R
- RaftActor - Class in org.opendaylight.controller.cluster.raft
-
RaftActor encapsulates a state machine that needs to be kept synchronized in a cluster.
- RaftActor(String, Map<String, String>, Optional<ConfigParams>, short) - Constructor for class org.opendaylight.controller.cluster.raft.RaftActor
- RaftActorBehavior - Interface in org.opendaylight.controller.cluster.raft.behaviors
-
The interface for a class that implements a specific behavior of a RaftActor.
- RaftActorContext - Interface in org.opendaylight.controller.cluster.raft
-
The RaftActorContext contains that portion of the RaftActors state that needs to be shared with it's behaviors.
- RaftActorContextImpl - Class in org.opendaylight.controller.cluster.raft
-
Implementation of the RaftActorContext interface.
- RaftActorContextImpl(ActorRef, ActorContext, String, ElectionTerm, long, long, Map<String, String>, ConfigParams, DataPersistenceProvider, Consumer<ApplyState>, Logger, Executor) - Constructor for class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- RaftActorLeadershipTransferCohort - Class in org.opendaylight.controller.cluster.raft
-
A raft actor support class that participates in leadership transfer.
- RaftActorRecoveryCohort - Interface in org.opendaylight.controller.cluster.raft
-
Interface for a class that participates in raft actor persistence recovery.
- RaftActorSnapshotCohort - Interface in org.opendaylight.controller.cluster.raft
-
Interface for a class that participates in raft actor snapshotting.
- RaftPolicy - Interface in org.opendaylight.controller.cluster.raft.policy
-
The RaftPolicy is intended to change the default behavior of Raft.
- RaftRPC - Interface in org.opendaylight.controller.cluster.raft.messages
-
Interface implemented by all requests exchanged in the Raft protocol.
- raftState(String) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- RaftState - Enum Class in org.opendaylight.controller.cluster.raft
- RaftVersions - Class in org.opendaylight.controller.cluster.raft
-
Enumerates the raft versions.
- removeFollower(String) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- removeFrom(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- removeFrom(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Removes entries from the in-memory log starting at the given index.
- removeFromAndPersist(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Removes entries from the in-memory log and the persisted log starting at the given index.
- removePeer(String) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Removes a peer.
- removePeer(String) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- RemoveServer - Class in org.opendaylight.controller.cluster.raft.messages
-
Message sent to remove a replica (§4.1).
- RemoveServer(String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.RemoveServer
- RemoveServerReply - Class in org.opendaylight.controller.cluster.raft.messages
-
Reply to a RemoveServer message (§4.1).
- RemoveServerReply(ServerChangeStatus, String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.RemoveServerReply
- Replicate - Record Class in org.opendaylight.controller.cluster.raft.base.messages
- Replicate(long, boolean, ActorRef, Identifier) - Constructor for record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Creates an instance of a
Replicaterecord class. - ReplicatedLog - Interface in org.opendaylight.controller.cluster.raft
-
Represents the ReplicatedLog that needs to be kept in sync by the RaftActor.
- ReplicatedLogEntry - Interface in org.opendaylight.controller.cluster.raft
-
Represents one entry in the replicated log.
- replicatedToAllIndex(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- RequestLeadership - Class in org.opendaylight.controller.cluster.raft.messages
-
Message sent to leader to transfer leadership to a particular follower.
- RequestLeadership(String, ActorRef) - Constructor for class org.opendaylight.controller.cluster.raft.messages.RequestLeadership
- requestVote(ActorRef, RequestVote) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Handles the logic for the RequestVote message that is common for all behaviors.
- RequestVote - Class in org.opendaylight.controller.cluster.raft.messages
-
Invoked by candidates to gather votes (§5.2).
- RequestVote(long, String, long, long) - Constructor for class org.opendaylight.controller.cluster.raft.messages.RequestVote
- RequestVoteReply - Class in org.opendaylight.controller.cluster.raft.messages
- RequestVoteReply(long, boolean) - Constructor for class org.opendaylight.controller.cluster.raft.messages.RequestVoteReply
- resolve(String) - Method in class org.opendaylight.controller.cluster.raft.NoopPeerAddressResolver
- resolve(String) - Method in interface org.opendaylight.controller.cluster.raft.PeerAddressResolver
-
Resolves a raft actor peer id to its remote actor address.
- rollback() - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- rollback() - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Rolls back the snapshot on failure.
S
- scheduleElection(FiniteDuration) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Schedule a new election.
- self() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- sendAppendEntries(long, boolean) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- SendHeartBeat - Class in org.opendaylight.controller.cluster.raft.base.messages
-
This messages is sent via a schedule to the Leader to prompt it to send a heart beat to its followers.
- sendImmediate() - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Returns the value of the
sendImmediaterecord component. - SendInstallSnapshot - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Internal message sent from the SnapshotManager to its associated leader when a snapshot capture is complete to prompt the leader to install the snapshot on its followers as needed.
- SendInstallSnapshot(Snapshot, ByteSource) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot
- serializedSize() - Method in class org.opendaylight.controller.cluster.raft.messages.Payload
-
Return the estimate of serialized size of this payload when passed through serialization.
- serializedSize() - Method in class org.opendaylight.controller.cluster.raft.persisted.NoopPayload
- serializedSize() - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- serializedSize() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- serializedSize() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Return the estimate of serialized size of this entry when passed through serialization.
- ServerChangeReply - Class in org.opendaylight.controller.cluster.raft.messages
-
A general server change reply.
- ServerChangeReply(ServerChangeStatus, String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.ServerChangeReply
- ServerChangeStatus - Enum Class in org.opendaylight.controller.cluster.raft.messages
-
Enumerates server configuration change status reply codes.
- ServerConfigurationPayload - Class in org.opendaylight.controller.cluster.raft.persisted
-
Payload data for server configuration log entries.
- ServerConfigurationPayload(List<ServerInfo>) - Constructor for class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- ServerInfo - Record Class in org.opendaylight.controller.cluster.raft.persisted
-
Server information.
- ServerInfo(String, boolean) - Constructor for record class org.opendaylight.controller.cluster.raft.persisted.ServerInfo
-
Creates an instance of a
ServerInforecord class. - ServerRemoved - Class in org.opendaylight.controller.cluster.raft.messages
-
The ServerRemoved message is sent to a server which has been removed successfully from the ServerConfiguration.
- ServerRemoved(String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.ServerRemoved
- setAddress(String) - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
- setCandidateElectionTimeoutDivisor(long) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setCommitIndex(long) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets the index of highest log entry known to be committed.
- setCommitIndex(long) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setConfigParams(ConfigParams) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setCustomRaftPolicyImplementationClass(String) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setDynamicServerConfigurationInUse() - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets that dynamic server configuration changes have been applied.
- setDynamicServerConfigurationInUse() - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setElectionTimeoutFactor(long) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setFileBackedStreamingThreshold(int) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setHeartBeatInterval(FiniteDuration) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setIsolatedLeaderCheckInterval(FiniteDuration) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setJournalRecoveryLogBatchSize(int) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setLastApplied(long) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets index of highest log entry applied to state machine.
- setLastApplied(long) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setLeaderId(String) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- setLeaderInstallSnapshotState(LeaderInstallSnapshotState) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Sets the LeaderInstallSnapshotState when an install snapshot is initiated.
- setLeaderPayloadVersion(short) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Follower
- setMatchIndex(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Sets the index of the follower's highest log entry.
- setMaximumMessageSliceSize(int) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setNeedsLeaderAddress(boolean) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
- setNextIndex(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Sets the index of the follower's next log entry.
- setPayloadVersion(short) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Sets the payload data version of the follower.
- setPayloadVersion(short) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setPeerAddress(String, String) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
setPeerAddress sets the address of a known peer at a later time.
- setPeerAddress(String, String) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets the address of a peer.
- setPeerAddress(String, String) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setPeerAddressResolver(PeerAddressResolver) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setPersistence(boolean) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- setPersistence(DataPersistenceProvider) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- setPersistencePending(boolean) - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- setPersistencePending(boolean) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Sets whether or not persistence is pending for this entry.
- setRaftActorLeadershipTransferCohort(RaftActorLeadershipTransferCohort) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets the RaftActorLeadershipTransferCohort for transferring leadership.
- setRaftActorLeadershipTransferCohort(RaftActorLeadershipTransferCohort) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setRaftVersion(short) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Sets the raft version of the follower.
- setRecoverySnapshotIntervalSeconds(int) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setReplicatedLog(ReplicatedLog) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets the ReplicatedLog instance.
- setReplicatedLog(ReplicatedLog) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setReplicatedToAllIndex(long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- setReplicatedToAllIndex(long) - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Sets the index of the last log entry that has been replicated to all peers.
- setResolved(String, String) - Method in interface org.opendaylight.controller.cluster.raft.PeerAddressResolver
-
Sets the actor address for a raft peer.
- setSentCommitIndex(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
- setSlicedLogEntryIndex(long) - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
-
Sets the index of the log entry whose payload size exceeds the maximum size for a single message and thus needs to be sliced into smaller chunks.
- setSnapshotBatchCount(long) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setSnapshotDataThreshold(int) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setSnapshotDataThresholdPercentage(int) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setSnapshotIndex(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- setSnapshotIndex(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Sets the snapshot index in the replicated log.
- setSnapshotTerm(long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- setSnapshotTerm(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Sets snapshot term.
- setSyncIndexThreshold(long) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setTempFileDirectory(String) - Method in class org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl
- setTotalMemoryRetriever(LongSupplier) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Sets the retriever of the total memory metric.
- setTotalMemoryRetriever(LongSupplier) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
- setVotingState(VotingState) - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
- shouldCaptureSnapshot(long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Determines if a snapshot should be captured based on the count/memory consumed.
- shouldUpdateTerm(RaftRPC) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- Shutdown - Class in org.opendaylight.controller.cluster.raft.client.messages
-
Message sent to a raft actor to shutdown gracefully.
- SimpleReplicatedLogEntry - Class in org.opendaylight.controller.cluster.raft.persisted
-
A
ReplicatedLogEntryimplementation. - SimpleReplicatedLogEntry(long, long, Payload) - Constructor for class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
-
Constructs an instance.
- SimpleReplicatedLogEntrySerializer - Class in org.opendaylight.controller.cluster.raft.persisted
-
Specialized serializer for
SimpleReplicatedLogEntrythat optimizes serialization. - SimpleReplicatedLogEntrySerializer(ExtendedActorSystem) - Constructor for class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntrySerializer
- size() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- size() - Method in class org.opendaylight.controller.cluster.raft.messages.Payload
-
Return the estimate of in-memory size of this payload.
- size() - Method in class org.opendaylight.controller.cluster.raft.persisted.NoopPayload
- size() - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- size() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- size() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Returns the number of entries in the journal.
- size() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLogEntry
-
Returns the size of the entry in bytes.
- Snapshot - Class in org.opendaylight.controller.cluster.raft.persisted
-
Represents a snapshot of the raft data.
- Snapshot.State - Interface in org.opendaylight.controller.cluster.raft.persisted
-
Implementations of this interface are used as the state payload for a snapshot.
- snapshotCommit() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Sets the Replicated log to state after snapshot success.
- snapshotCommit(boolean) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- snapshotCommit(boolean) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Sets the Replicated log to state after snapshot success.
- SnapshotComplete - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Internal message sent when a snapshot capture is complete.
- snapshotIndex(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- SnapshotManager - Class in org.opendaylight.controller.cluster.raft
-
Manages the capturing of snapshots for a RaftActor.
- SnapshotManager(RaftActorContext, Logger) - Constructor for class org.opendaylight.controller.cluster.raft.SnapshotManager
-
Constructs an instance.
- snapshotPreCommit(long, long) - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- snapshotPreCommit(long, long) - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Handles all the bookkeeping in order to perform a rollback in the event of SaveSnapshotFailure.
- snapshotRollback() - Method in class org.opendaylight.controller.cluster.raft.AbstractReplicatedLogImpl
- snapshotRollback() - Method in interface org.opendaylight.controller.cluster.raft.ReplicatedLog
-
Restores the replicated log to a state in the event of a save snapshot failure.
- snapshotSequenceNr() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- SnapshotState - Interface in org.opendaylight.controller.cluster.raft
-
Interface for a snapshot phase state.
- snapshotTerm(long) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- startLogRecoveryBatch(int) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort
-
This method is called during recovery at the start of a batch of state entries.
- state() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- state() - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Returns the state associated with this behavior.
- state() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- state() - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.Builder
- stopElection() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Stops the currently scheduled election.
- switchBehavior(RaftActorBehavior) - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
- switchBehavior(RaftActorBehavior) - Method in interface org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior
-
Closes the current behavior and switches to the specified behavior, if possible.
- SwitchBehavior - Class in org.opendaylight.controller.cluster.raft.base.messages
- SwitchBehavior(RaftState, long) - Constructor for class org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior
- SyncStatusTracker - Class in org.opendaylight.controller.cluster.raft.behaviors
-
The SyncStatusTracker tracks if a Follower is in sync with any given Leader or not When an update is received from the Leader and the update happens to be the first update from that Leader then the SyncStatusTracker will not mark the Follower as not in-sync till the Followers commitIndex matches the commitIndex that the Leader sent in it's very first update.
- SyncStatusTracker(ActorRef, String, long) - Constructor for class org.opendaylight.controller.cluster.raft.behaviors.SyncStatusTracker
T
- TIMEOUT - Enum constant in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
For an AddServer request, the leader timed out trying to install a snapshot on the new server.
- TimeoutNow - Class in org.opendaylight.controller.cluster.raft.base.messages
-
Message sent to a follower to force an immediate election time out.
- toBinary(Object) - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntrySerializer
- toString() - Method in class org.opendaylight.controller.cluster.raft.base.messages.ApplyState
- toString() - Method in class org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot
- toString() - Method in class org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning
- toString() - Method in record class org.opendaylight.controller.cluster.raft.base.messages.Replicate
-
Returns a string representation of this record class.
- toString() - Method in class org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior
- toString() - Method in class org.opendaylight.controller.cluster.raft.behaviors.LeaderInstallSnapshotState
- toString() - Method in class org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply
- toString() - Method in record class org.opendaylight.controller.cluster.raft.ClientRequestTracker
-
Returns a string representation of this record class.
- toString() - Method in class org.opendaylight.controller.cluster.raft.FollowerLogInformation
- toString() - Method in class org.opendaylight.controller.cluster.raft.ImmutableElectionTerm
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.AbstractServerChangeReply
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.AddServer
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntries
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshot
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.RemoveServer
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestLeadership
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestVote
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.RequestVoteReply
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.ServerRemoved
- toString() - Method in class org.opendaylight.controller.cluster.raft.messages.UnInitializedFollowerSnapshotReply
- toString() - Method in class org.opendaylight.controller.cluster.raft.PeerInfo
- toString() - Method in class org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries
- toString() - Method in class org.opendaylight.controller.cluster.raft.persisted.DeleteEntries
- toString() - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
- toString() - Method in record class org.opendaylight.controller.cluster.raft.persisted.ServerInfo
-
Returns a string representation of this record class.
- toString() - Method in class org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry
- toString() - Method in class org.opendaylight.controller.cluster.raft.persisted.Snapshot
- toString() - Method in class org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm
- transferComplete() - Method in class org.opendaylight.controller.cluster.raft.RaftActorLeadershipTransferCohort
-
This method is invoked when leadership transfer was carried out and complete.
- transferLeadership(RaftActorLeadershipTransferCohort) - Method in class org.opendaylight.controller.cluster.raft.behaviors.Leader
-
Attempts to transfer leadership to a follower as per the raft paper (§3.10) as follows: Start a timer (Stopwatch). Send an initial AppendEntries heartbeat to all followers. On AppendEntriesReply, check if the follower's new match Index matches the leader's last index If it matches, Send an additional AppendEntries to ensure the follower has applied all its log entries to its state. Send an ElectionTimeout to the follower to immediately start an election. Notify
RaftActorLeadershipTransferCohort.transferComplete(). Otherwise if the election time out period elapses, notifyRaftActorLeadershipTransferCohort.abortTransfer(). - trimLog(long) - Method in class org.opendaylight.controller.cluster.raft.SnapshotManager
- trimLog(long) - Method in interface org.opendaylight.controller.cluster.raft.SnapshotState
-
Trims the in-memory log.
U
- UnInitializedFollowerSnapshotReply - Class in org.opendaylight.controller.cluster.raft.messages
-
Local message sent to self on receiving the InstallSnapshotReply from a follower indicating that the catch up of the follower has completed successfully for an AddServer operation.
- UnInitializedFollowerSnapshotReply(String) - Constructor for class org.opendaylight.controller.cluster.raft.messages.UnInitializedFollowerSnapshotReply
- unpauseLeader() - Method in class org.opendaylight.controller.cluster.raft.RaftActor
-
This method is invoked when the actions hooked to the leader becoming paused failed to execute and the leader should resume normal operations.
- update(long, String) - Method in interface org.opendaylight.controller.cluster.raft.ElectionTerm
-
This method updates the in-memory election term state.
- update(long, String) - Method in class org.opendaylight.controller.cluster.raft.ImmutableElectionTerm
- update(String, long, long) - Method in class org.opendaylight.controller.cluster.raft.behaviors.SyncStatusTracker
- updateAndPersist(long, String) - Method in interface org.opendaylight.controller.cluster.raft.ElectionTerm
-
This method updates the in-memory election term state and persists it so it can be recovered on next restart.
- updateAndPersist(long, String) - Method in class org.opendaylight.controller.cluster.raft.ImmutableElectionTerm
- updateConfigParams(ConfigParams) - Method in class org.opendaylight.controller.cluster.raft.RaftActor
- UpdateElectionTerm - Class in org.opendaylight.controller.cluster.raft.persisted
-
Message class to persist election term information.
- UpdateElectionTerm(long, String) - Constructor for class org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm
- updateMinReplicaCount() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader
- updatePeerIds(ServerConfigurationPayload) - Method in interface org.opendaylight.controller.cluster.raft.RaftActorContext
-
Updates the peers and information to match the given ServerConfigurationPayload.
- updatePeerIds(ServerConfigurationPayload) - Method in class org.opendaylight.controller.cluster.raft.RaftActorContextImpl
V
- valueOf(String) - Static method in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.opendaylight.controller.cluster.raft.RaftState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.opendaylight.controller.cluster.raft.VotingState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.opendaylight.controller.cluster.raft.RaftState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.opendaylight.controller.cluster.raft.VotingState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- votedFor() - Method in class org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior
-
Returns the id of the candidate that this server voted for in current term.
- votedFor(String) - Method in class org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState.AbstractBuilder
- VOTING - Enum constant in enum class org.opendaylight.controller.cluster.raft.VotingState
- VOTING_NOT_INITIALIZED - Enum constant in enum class org.opendaylight.controller.cluster.raft.VotingState
- VotingState - Enum Class in org.opendaylight.controller.cluster.raft
-
Enumerates voting states for a peer.
W
- writeReplace() - Method in class org.opendaylight.controller.cluster.raft.messages.Payload
-
Return the serialization proxy for this object.
- writeReplace() - Method in interface org.opendaylight.controller.cluster.raft.persisted.MigratedSerializable
-
Return a serialization proxy.
- writeReplace() - Method in class org.opendaylight.controller.cluster.raft.persisted.NoopPayload
- writeReplace() - Method in class org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
RaftActor.handleNonRaftCommand(Object)instead.