Documentation

SwarmSpecRaft

Table of Contents

$electionTick  : int|null
The number of ticks that a follower will wait for a message from.
$heartbeatTick  : int|null
The number of ticks between heartbeats. Every HeartbeatTick ticks,.
$keepOldSnapshots  : int|null
The number of snapshots to keep beyond the current snapshot.
$logEntriesForSlowFollowers  : int|null
The number of log entries to keep around to sync up slow followers.
$snapshotInterval  : int|null
The number of log entries between snapshots.
getElectionTick()  : int|null
The number of ticks that a follower will wait for a message from.
getHeartbeatTick()  : int|null
The number of ticks between heartbeats. Every HeartbeatTick ticks,.
getKeepOldSnapshots()  : int|null
The number of snapshots to keep beyond the current snapshot.
getLogEntriesForSlowFollowers()  : int|null
The number of log entries to keep around to sync up slow followers.
getSnapshotInterval()  : int|null
The number of log entries between snapshots.
setElectionTick()  : self
The number of ticks that a follower will wait for a message from.
setHeartbeatTick()  : self
The number of ticks between heartbeats. Every HeartbeatTick ticks,.
setKeepOldSnapshots()  : self
The number of snapshots to keep beyond the current snapshot.
setLogEntriesForSlowFollowers()  : self
The number of log entries to keep around to sync up slow followers.
setSnapshotInterval()  : self
The number of log entries between snapshots.

Properties

$electionTick

The number of ticks that a follower will wait for a message from.

protected int|null $electionTick

$heartbeatTick

The number of ticks between heartbeats. Every HeartbeatTick ticks,.

protected int|null $heartbeatTick

$keepOldSnapshots

The number of snapshots to keep beyond the current snapshot.

protected int|null $keepOldSnapshots

$logEntriesForSlowFollowers

The number of log entries to keep around to sync up slow followers.

protected int|null $logEntriesForSlowFollowers

$snapshotInterval

The number of log entries between snapshots.

protected int|null $snapshotInterval

Methods

getElectionTick()

The number of ticks that a follower will wait for a message from.

public getElectionTick() : int|null

directly to seconds currently, but this is NOT guaranteed.

Return values
int|null

getHeartbeatTick()

The number of ticks between heartbeats. Every HeartbeatTick ticks,.

public getHeartbeatTick() : int|null

directly to seconds currently, but this is NOT guaranteed.

Return values
int|null

getKeepOldSnapshots()

The number of snapshots to keep beyond the current snapshot.

public getKeepOldSnapshots() : int|null
Return values
int|null

getLogEntriesForSlowFollowers()

The number of log entries to keep around to sync up slow followers.

public getLogEntriesForSlowFollowers() : int|null

after a snapshot is created.

Return values
int|null

getSnapshotInterval()

The number of log entries between snapshots.

public getSnapshotInterval() : int|null
Return values
int|null

setElectionTick()

The number of ticks that a follower will wait for a message from.

public setElectionTick(int|null $electionTick) : self

directly to seconds currently, but this is NOT guaranteed.

Parameters
$electionTick : int|null
Return values
self

setHeartbeatTick()

The number of ticks between heartbeats. Every HeartbeatTick ticks,.

public setHeartbeatTick(int|null $heartbeatTick) : self

directly to seconds currently, but this is NOT guaranteed.

Parameters
$heartbeatTick : int|null
Return values
self

setKeepOldSnapshots()

The number of snapshots to keep beyond the current snapshot.

public setKeepOldSnapshots(int|null $keepOldSnapshots) : self
Parameters
$keepOldSnapshots : int|null
Return values
self

setLogEntriesForSlowFollowers()

The number of log entries to keep around to sync up slow followers.

public setLogEntriesForSlowFollowers(int|null $logEntriesForSlowFollowers) : self

after a snapshot is created.

Parameters
$logEntriesForSlowFollowers : int|null
Return values
self

setSnapshotInterval()

The number of log entries between snapshots.

public setSnapshotInterval(int|null $snapshotInterval) : self
Parameters
$snapshotInterval : int|null
Return values
self

Search results