Class PersistentClusterConfigurationStorage<TAddress>

Represents persistent cluster configuration storage.

Inheritance
object
Disposable
ClusterConfigurationStorage<TAddress>
PersistentClusterConfigurationStorage<TAddress>
Implements
Inherited Members
Namespace: DotNext.Net.Cluster.Consensus.Raft.Membership
Assembly: DotNext.Net.Cluster.dll
Syntax
public abstract class PersistentClusterConfigurationStorage<TAddress> : ClusterConfigurationStorage<TAddress>, IClusterConfigurationStorage<TAddress>, IClusterConfigurationStorage, IDisposable, IAsyncDisposable where TAddress : notnull
Type Parameters
Name Description
TAddress

The type of the cluster member address.

Constructors

| Edit this page View Source

PersistentClusterConfigurationStorage(string, int, IEqualityComparer<TAddress>?, MemoryAllocator<byte>?)

Initializes a new persistent storage.

Declaration
protected PersistentClusterConfigurationStorage(string path, int fileBufferSize = 512, IEqualityComparer<TAddress>? comparer = null, MemoryAllocator<byte>? allocator = null)
Parameters
Type Name Description
string path

The full path to the folder used as persistent storage of cluster members.
int fileBufferSize

The buffer size for file I/O.
IEqualityComparer<TAddress> comparer

The address comparer.
MemoryAllocator<byte> allocator

The memory allocator for file I/O.

Properties

| Edit this page View Source

ActiveConfiguration

Gets active configuration.

Declaration
public override sealed IClusterConfiguration ActiveConfiguration { get; }
Property Value
Type Description
IClusterConfiguration
Overrides
| Edit this page View Source

HasProposal

Gets a value indicating that this storage has proposed configuration.

Declaration
public override sealed bool HasProposal { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

ProposedConfiguration

Gets proposed configuration.

Declaration
public override sealed IClusterConfiguration? ProposedConfiguration { get; }
Property Value
Type Description
IClusterConfiguration
Overrides

Methods

| Edit this page View Source

AddMemberAsync(TAddress, CancellationToken)

Proposes a new member.

Declaration
protected override sealed ValueTask<bool> AddMemberAsync(TAddress address, CancellationToken token = default)
Parameters
Type Name Description
TAddress address

The address of the cluster member.
CancellationToken token

The token that can be used to cancel the operation.
Returns
Type Description
ValueTask<bool>

true if the new member is added to the proposed configuration; false if the storage has the proposed configuration already.
Overrides
| Edit this page View Source

ApplyAsync(CancellationToken)

Applies proposed configuration as active configuration.

Declaration
protected override sealed ValueTask ApplyAsync(CancellationToken token = default)
Parameters
Type Name Description
CancellationToken token

The token that can be used to cancel the operation.
Returns
Type Description
ValueTask

The task representing asynchronous result.
Overrides
| Edit this page View Source

Dispose(bool)

Releases managed and unmanaged resources associated with this object.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if called from Dispose(); false if called from finalizer ~Disposable().
Overrides
| Edit this page View Source

DisposeAsync()

Releases managed resources associated with this object.

Declaration
public ValueTask DisposeAsync()
Returns
Type Description
ValueTask

The task representing asynchronous result.
| Edit this page View Source

DisposeAsyncCore()

Releases managed resources associated with this object asynchronously.

Declaration
protected override ValueTask DisposeAsyncCore()
Returns
Type Description
ValueTask

The task representing asynchronous execution of this method.
Overrides
Remarks

This method makes sense only if derived class implements IAsyncDisposable interface.

| Edit this page View Source

LoadConfigurationAsync(CancellationToken)

Loads configuration from the storage.

Declaration
protected override sealed ValueTask LoadConfigurationAsync(CancellationToken token = default)
Parameters
Type Name Description
CancellationToken token

The token that can be used to cancel the operation.
Returns
Type Description
ValueTask

The task representing asynchronous result.
Overrides
| Edit this page View Source

ProposeAsync(IClusterConfiguration, CancellationToken)

Proposes the configuration.

Declaration
protected override sealed ValueTask ProposeAsync(IClusterConfiguration configuration, CancellationToken token = default)
Parameters
Type Name Description
IClusterConfiguration configuration

The proposed configuration.
CancellationToken token

The token that can be used to cancel the operation.
Returns
Type Description
ValueTask

The task representing asynchronous result.
Overrides
Remarks

If method is called multiple times then ProposedConfiguration will be rewritten.

| Edit this page View Source

RemoveMemberAsync(TAddress, CancellationToken)

Proposes removal of the existing member.

Declaration
protected override sealed ValueTask<bool> RemoveMemberAsync(TAddress address, CancellationToken token = default)
Parameters
Type Name Description
TAddress address

The address of the cluster member.
CancellationToken token

The token that can be used to cancel the operation.
Returns
Type Description
ValueTask<bool>

true if the new member is added to the proposed configuration; false if the storage has the proposed configuration already.
Overrides

Implements

Extension Methods