Class RaftClusterMember

Represents Raft cluster member that is accessible through the network.

Inheritance
Object
Disposable
RaftClusterMember
Inherited Members
Namespace: DotNext.Net.Cluster.Consensus.Raft
Assembly: DotNext.Net.Cluster.dll
Syntax
public abstract class RaftClusterMember : Disposable, IDisposable, IRaftClusterMember, IClusterMember

Properties

| Improve this Doc View Source

Endpoint

Gets the address of this cluster member.

Declaration
public IPEndPoint Endpoint { get; }
Property Value
Type Description
IPEndPoint
| Improve this Doc View Source

IsLeader

Determines whether this member is a leader.

Declaration
public bool IsLeader { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsRemote

Determines whether this member is not a local node.

Declaration
public bool IsRemote { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Status

Gets the status of this member.

Declaration
public ClusterMemberStatus Status { get; }
Property Value
Type Description
ClusterMemberStatus

Methods

| Improve this Doc View Source

CancelPendingRequests()

Cancels pending requests scheduled for this member.

Declaration
[Obsolete("Use CancelPendingRequestsAsync method instead")]
public virtual void CancelPendingRequests()
| Improve this Doc View Source

CancelPendingRequestsAsync()

Cancels pending requests scheduled for this member.

Declaration
public virtual ValueTask CancelPendingRequestsAsync()
Returns
Type Description
ValueTask

The task representing asynchronous execution of this method.

Events

| Improve this Doc View Source

MemberStatusChanged

Informs about status change.

Declaration
public event ClusterMemberStatusChanged MemberStatusChanged
Event Type
Type Description
ClusterMemberStatusChanged

Explicit Interface Implementations

| Improve this Doc View Source

IRaftClusterMember.AppendEntriesAsync<TEntry, TList>(Int64, TList, Int64, Int64, Int64, CancellationToken)

Declaration
Task<Result<bool>> IRaftClusterMember.AppendEntriesAsync<TEntry, TList>(long term, TList entries, long prevLogIndex, long prevLogTerm, long commitIndex, CancellationToken token)

    where TEntry : IRaftLogEntry where TList : IReadOnlyList<TEntry>
Parameters
Type Name Description
Int64 term
TList entries
Int64 prevLogIndex
Int64 prevLogTerm
Int64 commitIndex
CancellationToken token
Returns
Type Description
Task<Result<Boolean>>
Type Parameters
Name Description
TEntry
TList
| Improve this Doc View Source

IRaftClusterMember.InstallSnapshotAsync(Int64, IRaftLogEntry, Int64, CancellationToken)

Declaration
Task<Result<bool>> IRaftClusterMember.InstallSnapshotAsync(long term, IRaftLogEntry snapshot, long snapshotIndex, CancellationToken token)
Parameters
Type Name Description
Int64 term
IRaftLogEntry snapshot
Int64 snapshotIndex
CancellationToken token
Returns
Type Description
Task<Result<Boolean>>
| Improve this Doc View Source

IRaftClusterMember.NextIndex

Declaration
long IRaftClusterMember.NextIndex { get; }
Returns
Type Description
Int64
| Improve this Doc View Source

IRaftClusterMember.VoteAsync(Int64, Int64, Int64, CancellationToken)

Declaration
Task<Result<bool>> IRaftClusterMember.VoteAsync(long term, long lastLogIndex, long lastLogTerm, CancellationToken token)
Parameters
Type Name Description
Int64 term
Int64 lastLogIndex
Int64 lastLogTerm
CancellationToken token
Returns
Type Description
Task<Result<Boolean>>
| Improve this Doc View Source

IClusterMember.GetMetadataAsync(Boolean, CancellationToken)

Declaration
ValueTask<IReadOnlyDictionary<string, string>> IClusterMember.GetMetadataAsync(bool refresh, CancellationToken token)
Parameters
Type Name Description
Boolean refresh
CancellationToken token
Returns
Type Description
ValueTask<IReadOnlyDictionary<String, String>>
| Improve this Doc View Source

IClusterMember.ResignAsync(CancellationToken)

Declaration
Task<bool> IClusterMember.ResignAsync(CancellationToken token)
Parameters
Type Name Description
CancellationToken token
Returns
Type Description
Task<Boolean>

Implements

Extension Methods