DotNext.Net.Cluster by Roman Sakno

<PackageReference Include="DotNext.Net.Cluster" Version="3.2.1" />

---

API Diff between 3.2.1 and 0.5.0

202 Additions 37 Removals

DotNext.Net.Cluster

• public struct ClusterMemberId : IEquatable<ClusterMemberId>, ISerializable
  • public ClusterMemberId(ReadOnlySpan<byte> bytes)
  • public static ClusterMemberId FromEndPoint(EndPoint ep)
  • public static bool op_Equality(ref ClusterMemberId x, ref ClusterMemberId y)
  • public static bool op_Inequality(ref ClusterMemberId x, ref ClusterMemberId y)
  • public static bool TryParse(ReadOnlySpan<char> identifier, out ClusterMemberId value)
  • public static bool TryParse(string identifier, out ClusterMemberId value)
  • public bool Equals(ClusterMemberId other)
• public interface IClusterMember
  • IPEndPoint Endpoint { get; }
  • EndPoint EndPoint { get; }
  • ClusterMemberId Id { get; }
  • ValueTask<IReadOnlyDictionary<string, string>> GetMetadata(bool refresh = false, CancellationToken token = default)
  • void OnMemberStatusChanged(IClusterMember member, ref AtomicEnum status, ClusterMemberStatus newState, ClusterMemberStatusChanged memberStatusChanged)
  • ValueTask<IReadOnlyDictionary<string, string>> GetMetadataAsync(bool refresh = false, CancellationToken token = default)

DotNext.Net.Cluster.Consensus.Raft

• public struct BufferedRaftLogEntry : IRaftLogEntry, ILogEntry, IDataTransferObject, IDisposable
  • public bool IsSnapshot { get; }
  • public long Length { get; }
  • public long Term { get; }
  • public DateTimeOffset Timestamp { get; }
  • public static ValueTask<BufferedRaftLogEntry> CopyAsync<TEntry>(TEntry entry, RaftLogEntryBufferingOptions options, CancellationToken token) where TEntry : IRaftLogEntry
  • public void Dispose()
• public struct BufferedRaftLogEntryList : IDisposable, IReadOnlyList<BufferedRaftLogEntry>, IEnumerable<BufferedRaftLogEntry>, IEnumerable, IReadOnlyCollection<BufferedRaftLogEntry>
  • public int Count { get; }
  • public BufferedRaftLogEntry& modreq(System.Runtime.InteropServices.InAttribute) this[int index] { get; }
  • public static Task<BufferedRaftLogEntryList> CopyAsync<TEntry>(ILogEntryProducer<TEntry> producer, RaftLogEntriesBufferingOptions options, CancellationToken token = default) where TEntry : IRaftLogEntry
  • public static Task<BufferedRaftLogEntryList> CopyAsync<TEntry, TList>(TList list, RaftLogEntriesBufferingOptions options, CancellationToken token = default) where TEntry : IRaftLogEntry where TList : IReadOnlyList<TEntry>
  • public void Dispose()
  • public ILogEntryProducer<BufferedRaftLogEntry> ToProducer()
• public sealed class ConsensusOnlyState : Disposable, IPersistentState, IAuditTrail<IRaftLogEntry>, IAuditTrail
  • public ConsensusOnlyState()
  • public long GetLastIndex(bool committed)
  • public ValueTask<TResult> ReadAsync<TResult>(LogEntryConsumer<IRaftLogEntry, TResult> reader, long startIndex, long endIndex, CancellationToken token)
  • public ValueTask<TResult> ReadAsync<TResult>(LogEntryConsumer<IRaftLogEntry, TResult> reader, long startIndex, CancellationToken token)
• public struct ElectionTimeout
  • public ElectionTimeout Modify(int lowerValue, int upperValue)
• public static class ElectionTimeoutExtensions
  • public static void Update(this ref ElectionTimeout timeout, int? lowerValue, int? upperValue)
• public struct EmptyLogEntry : IRaftLogEntry, ILogEntry, IDataTransferObject
  • public long Term { get; }
  • public DateTimeOffset Timestamp { get; }
  • public EmptyLogEntry(long term)
• public interface IClusterMemberConfiguration
  • bool Standby { get; }
• public interface ILogEntry : IMessage
• public sealed class InMemoryAuditTrail : AsyncReaderWriterLock, IPersistentState, IAuditTrail<ILogEntry>
• public interface IPersistentState : IAuditTrail<IRaftLogEntry>, IAuditTrail
  • Task EnsureConsistencyAsync(TimeSpan timeout, CancellationToken token = default)
  • ValueTask UpdateTermAsync(long term)
  • ValueTask UpdateTermAsync(long term, bool resetLastVote)
• public interface IRaftClusterMember : IClusterMember
  • Task<Result<bool>> AppendEntriesAsync(long term, IReadOnlyList<ILogEntry> entries, long prevLogIndex, long prevLogTerm, long commitIndex, CancellationToken token)
  • void CancelPendingRequests()
  • Task<Result<bool>> AppendEntriesAsync<TEntry, TList>(long term, TList entries, long prevLogIndex, long prevLogTerm, long commitIndex, CancellationToken token) where TEntry : IRaftLogEntry where TList : IReadOnlyList<TEntry>
  • ValueTask CancelPendingRequestsAsync()
  • Task<Result<bool>> InstallSnapshotAsync(long term, IRaftLogEntry snapshot, long snapshotIndex, CancellationToken token)
  • Task<Result<bool>> PreVoteAsync(long term, long lastLogIndex, long lastLogTerm, CancellationToken token)
• public interface IRaftLogEntry : ILogEntry, IDataTransferObject
  • int? CommandId { get; }
  • long Term { get; }
• public struct JsonLogEntry<T> : IRaftLogEntry, ILogEntry, IDataTransferObject
  • public T Content { get; }
  • public long Term { get; }
  • public DateTimeOffset Timestamp { get; }
• public class PersistentState : Disposable, IPersistentState, IAuditTrail<IRaftLogEntry>, IAuditTrail, IAsyncDisposable
  • public enum CompactionMode
  • public enum LogEntryCacheEvictionPolicy
  • public sealed class MissingPartitionException : IntegrityException
  • public class Options : IBufferManagerSettings, IAsyncLockSettings
  • protected abstract class SnapshotBuilder : Disposable, IRaftLogEntry, ILogEntry, IDataTransferObject
  • public struct WriteLockToken : IDisposable
  • protected Memory<byte> Buffer { get; }
  • public long CompactionCount { get; }
  • public bool IsBackgroundCompaction { get; }
  • public long Term { get; }
  • public PersistentState(DirectoryInfo path, int recordsPerPartition, Options configuration = null)
  • public PersistentState(string path, int recordsPerPartition, Options configuration = null)
  • public static Task RestoreFromBackupAsync(Stream backup, DirectoryInfo destination, CancellationToken token = default)
  • public Task<WriteLockToken> AcquireWriteLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task<WriteLockToken> AcquireWriteLockAsync(CancellationToken token)
  • public Task<bool> AppendAndEnsureCommitAsync<TEntry>(TEntry entry, TimeSpan timeout, bool addToCache = false, CancellationToken token = default) where TEntry : IRaftLogEntry
  • public ValueTask AppendAsync<TEntry>(ref WriteLockToken writeLock, TEntry entry, long startIndex) where TEntry : IRaftLogEntry
  • public ValueTask AppendAsync<TEntry>(TEntry entry, long startIndex, CancellationToken token = default) where TEntry : IRaftLogEntry
  • public ValueTask<long> AppendAsync<TEntry>(ref WriteLockToken writeLock, TEntry entry, bool flush = true, CancellationToken token = default) where TEntry : IRaftLogEntry
  • public ValueTask<long> AppendAsync<TEntry>(TEntry entry, CancellationToken token = default) where TEntry : IRaftLogEntry
  • public ValueTask<long> AppendAsync<TEntry>(TEntry entry, bool addToCache, CancellationToken token = default) where TEntry : IRaftLogEntry
  • public ValueTask<long> AppendAsync<TEntry>(ILogEntryProducer<TEntry> entries, CancellationToken token = default) where TEntry : IRaftLogEntry
  • protected virtual ValueTask ApplyAsync(LogEntry entry)
  • public ValueTask<long> CommitAsync(long endIndex, CancellationToken token)
  • public ValueTask<long> CommitAsync(CancellationToken token)
  • public Task CreateBackupAsync(Stream output, CancellationToken token = default)
  • public JsonLogEntry<T> CreateJsonLogEntry<T>(T content, string typeId = null, JsonSerializerOptions options = null)
  • protected virtual SnapshotBuilder CreateSnapshotBuilder()
  • public ValueTask DisposeAsync()
  • public ValueTask<long> DropAsync(long startIndex, bool reuseSpace = false, CancellationToken token = default)
  • public Task EnsureConsistencyAsync(TimeSpan timeout, CancellationToken token)
  • protected virtual ValueTask FlushAsync()
  • public ValueTask ForceCompactionAsync(long count, CancellationToken token)
  • public long GetLastIndex(bool committed)
  • public Task InitializeAsync(CancellationToken token = default)
  • public ValueTask<TResult> ReadAsync<TResult>(LogEntryConsumer<IRaftLogEntry, TResult> reader, long startIndex, long endIndex, CancellationToken token = default)
  • public ValueTask<TResult> ReadAsync<TResult>(LogEntryConsumer<IRaftLogEntry, TResult> reader, long startIndex, CancellationToken token = default)
  • public Task ReplayAsync(CancellationToken token = default)
  • public bool Validate(ref WriteLockToken token)
  • public Task<bool> WaitForCommitAsync(TimeSpan timeout, CancellationToken token)
  • public Task<bool> WaitForCommitAsync(long index, TimeSpan timeout, CancellationToken token)
• public class RaftCluster : RaftCluster<RaftClusterMember>, ILocalMember
  • public abstract class NodeConfiguration : IClusterMemberConfiguration
  • public sealed class TcpConfiguration : NodeConfiguration
  • public sealed class UdpConfiguration : NodeConfiguration
  • public RaftCluster(NodeConfiguration configuration)
  • protected RaftClusterMember CreateClient(IPEndPoint address)
• public abstract class RaftCluster<TMember> : Disposable, IRaftCluster, IReplicationCluster<IRaftLogEntry>, IReplicationCluster, ICluster, IRaftStateMachine, IAsyncDisposable where TMember : IRaftClusterMember, IDisposable
  • protected struct MemberCollectionBuilder<TMember> where TMember : IRaftClusterMember, IDisposable
  • protected sealed delegate MemberCollectionMutator<TMember, T> : MulticastDelegate where TMember : IRaftClusterMember, IDisposable
  • protected struct MutableMemberCollection<TMember> where TMember : IRaftClusterMember, IDisposable
  • public TimeSpan ElectionTimeout { get; }
  • protected RaftCluster(IClusterMemberConfiguration config, out MutableMemberCollection members)
  • public event ReplicationCompletedEventHandler ReplicationCompleted
  • protected RaftCluster(IClusterMemberConfiguration config, out MemberCollectionBuilder members)
  • protected Task ChangeMembersAsync<T>(MemberCollectionMutator<TMember, T> mutator, T arg, CancellationToken token)
  • protected Task ChangeMembersAsync(MemberCollectionMutator<TMember> mutator, CancellationToken token)
  • public ValueTask DisposeAsync()
  • protected Task<Result<bool>> ReceiveEntries(TMember sender, long senderTerm, IReadOnlyList<ILogEntry> entries, long prevLogIndex, long prevLogTerm, long commitIndex)
  • protected Task<bool> ReceiveResign()
  • protected Task<Result<bool>> ReceiveVote(TMember sender, long senderTerm, long lastLogIndex, long lastLogTerm)
  • protected TMember FindMember<TArg>(Func<TMember, TArg, bool> criteria, TArg arg)
  • protected ValueTask<TMember> FindMemberAsync(Func<TMember, CancellationToken, ValueTask<bool>> criteria, CancellationToken token)
  • public Task<bool> ForceReplicationAsync(TimeSpan timeout, CancellationToken token = default)
  • protected Task<Result<bool>> ReceiveEntriesAsync<TEntry>(TMember sender, long senderTerm, ILogEntryProducer<TEntry> entries, long prevLogIndex, long prevLogTerm, long commitIndex, CancellationToken token) where TEntry : IRaftLogEntry
  • protected Task<Result<bool>> ReceivePreVoteAsync(long nextTerm, long lastLogIndex, long lastLogTerm, CancellationToken token)
  • protected Task<bool> ReceiveResignAsync(CancellationToken token)
  • protected Task<Result<bool>> ReceiveSnapshotAsync<TSnapshot>(TMember sender, long senderTerm, TSnapshot snapshot, long snapshotIndex, CancellationToken token) where TSnapshot : IRaftLogEntry
  • protected Task<Result<bool>> ReceiveVoteAsync(TMember sender, long senderTerm, long lastLogIndex, long lastLogTerm, CancellationToken token)
  • public ValueTask TurnIntoRegularNodeAsync(CancellationToken token)
• public abstract class RaftClusterMember : Disposable, IRaftClusterMember, IClusterMember
  • public EndPoint EndPoint { get; }
  • public bool IsLeader { get; }
  • public bool IsRemote { get; }
  • public ClusterMemberStatus Status { get; }
  • public event ClusterMemberStatusChanged MemberStatusChanged
  • public abstract ValueTask CancelPendingRequestsAsync()
• public class RaftLogEntriesBufferingOptions : RaftLogEntryBufferingOptions
  • public int MemoryLimit { get; set; }
  • public RaftLogEntriesBufferingOptions()
• public class RaftLogEntryBufferingOptions
  • public int BufferSize { get; set; }
  • public MemoryAllocator<byte> MemoryAllocator { get; set; }
  • public int MemoryThreshold { get; set; }
  • public string TempPath { get; set; }
  • public RaftLogEntryBufferingOptions()

DotNext.Net.Cluster.Consensus.Raft.Commands

• public sealed class CommandAttribute : Attribute
  • public Type Formatter { get; set; }
  • public string FormatterMember { get; set; }
  • public int Id { get; }
  • public CommandAttribute(int id)
• public class CommandInterpreter : Disposable
  • public sealed class Builder : ISupplier<CommandInterpreter>
  • protected sealed class CommandHandlerAttribute : Attribute
  • public sealed class UnknownCommandException : IntegrityException
  • protected CommandInterpreter()
  • public LogEntry<TCommand> CreateLogEntry<TCommand>(TCommand command, long term) where TCommand : struct
  • public ValueTask<int> InterpretAsync<TEntry>(TEntry entry, CancellationToken token = default) where TEntry : struct, IRaftLogEntry
• public struct LogEntry<TCommand> : IRaftLogEntry, ILogEntry, IDataTransferObject where TCommand : struct
  • public long Term { get; }
  • public DateTimeOffset Timestamp { get; }

DotNext.Net.Cluster.Consensus.Raft.Metrics

• public interface IClientMetricsCollector
  • void ReportResponseTime(TimeSpan value)

DotNext.Net.Cluster.Messaging

• public class BinaryMessage : BinaryTransferObject, IMessage, IDataTransferObject
  • public ReadOnlySequence<byte> Content { get; }
• public interface IAddressee : IClusterMember, IEquatable<IClusterMember>
• public class BinaryMessage<T> : BinaryTransferObject<T>, IMessage, IDataTransferObject where T : ValueType modreq(System.Runtime.InteropServices.UnmanagedType)
  • public static readonly MessageReader<T> Reader
  • public string Name { get; }
  • public ContentType Type { get; }
  • public BinaryMessage(string name, ContentType type)
• public interface IInputChannel
  • bool IsSupported(string messageName, bool oneWay)
  • Task<IMessage> ReceiveMessage(ISubscriber sender, IMessage message, object context, CancellationToken token)
  • Task ReceiveSignal(ISubscriber sender, IMessage signal, object context, CancellationToken token)
• public interface IMessage : IDataTransferObject
  • bool IsReusable { get; }
  • long? Length { get; }
  • Task CopyToAsync(Stream output)
  • ValueTask CopyToAsync(PipeWriter output, CancellationToken token = default)
• public interface IMessageBus : ICluster
  • IAddressee Leader { get; }
  • IReadOnlyCollection<IAddressee> Members { get; }
  • Task<TResponse> SendMessageToLeaderAsync<TResponse>(IMessage message, MessageReader<TResponse> responseReader, CancellationToken token = default)
  • Task SendSignalToLeaderAsync(IMessage message, CancellationToken token = default)
  • ISubscriber Leader { get; }
  • IOutputChannel LeaderRouter { get; }
  • IReadOnlyCollection<ISubscriber> Members { get; }
  • void AddListener(IInputChannel handler)
  • void RemoveListener(IInputChannel handler)
• public interface IOutputChannel
  • Task<TResponse> SendMessageAsync<TResponse>(IMessage message, MessageReader<TResponse> responseReader, CancellationToken token = default)
  • Task SendSignalAsync(IMessage message, CancellationToken token = default)
• public interface ISubscriber : IClusterMember, IOutputChannel
  • Task SendSignalAsync(IMessage message, bool requiresConfirmation = true, CancellationToken token = default)
• public sealed class JsonMessage<T> : IMessage, IDataTransferObject
  • public T Content { get; }
  • public string Name { get; }
  • public JsonSerializerOptions Options { get; set; }
  • public JsonMessage(string name, T content)
  • public static ValueTask<T> FromJsonAsync(IDataTransferObject message, JsonSerializerOptions options = null, MemoryAllocator<byte> allocator = null, CancellationToken token = default)
  • public static ValueTask<T> FromJsonAsync(IDataTransferObject message, CancellationToken token = default)
• public sealed delegate MessageReader<T> : MulticastDelegate
  • public virtual IAsyncResult BeginInvoke(IMessage message, AsyncCallback callback, object object)
  • public virtual Task<T> EndInvoke(IAsyncResult result)
  • public virtual Task<T> Invoke(IMessage message)
  • public virtual IAsyncResult BeginInvoke(IMessage message, CancellationToken token, AsyncCallback callback, object object)
  • public virtual ValueTask<T> EndInvoke(IAsyncResult result)
  • public virtual ValueTask<T> Invoke(IMessage message, CancellationToken token)
• public static class Messenger
  • public static Task<string> ReadAsTextAsync(this IMessage message)
  • public static Task<string> ReadAsTextAsync(this IMessage message, CancellationToken token = default)
  • public static Task<TResponse> SendTextMessageAsync<TResponse>(this IAddressee messenger, MessageReader<TResponse> responseReader, string messageName, string text, string mediaType = null, CancellationToken token = default)
  • public static Task SendTextSignalAsync(this IAddressee messenger, string messageName, string text, bool requiresConfirmation = true, string mediaType = null, CancellationToken token = default)
  • public static Task<TResponse> SendJsonMessageAsync<TRequest, TResponse>(this ISubscriber messenger, MessageReader<TResponse> responseReader, string messageName, TRequest request, CancellationToken token)
  • public static Task SendJsonSignalAsync<TSignal>(this ISubscriber messenger, string messageName, TSignal signal, bool requiresConfirmation = true, CancellationToken token = default)
  • public static Task<TResponse> SendTextMessageAsync<TResponse>(this ISubscriber messenger, MessageReader<TResponse> responseReader, string messageName, string text, string mediaType = null, CancellationToken token = default)
  • public static Task SendTextSignalAsync(this ISubscriber messenger, string messageName, string text, bool requiresConfirmation = true, string mediaType = null, CancellationToken token = default)
• public class StreamMessage : StreamTransferObject, IDisposableMessage, IMessage, IDataTransferObject, IDisposable, IAsyncDisposable
  • public bool IsReusable { get; }
  • public static Task<StreamMessage> CreateBufferedMessageAsync(IMessage message)

DotNext.Net.Cluster.Replication

• public sealed delegate CommitEventHandler<LogEntry> : MulticastDelegate where LogEntry : IMessage
• public sealed delegate DataHandler<T, LogEntry> : MulticastDelegate where LogEntry : IMessage
• public interface IAuditTrail<LogEntry> where LogEntry : IMessage
• public interface IReplicationCluster : ICluster
  • IAuditTrail AuditTrail { get; }
  • event ReplicationCompletedEventHandler ReplicationCompleted
  • Task<bool> ForceReplicationAsync(TimeSpan timeout, CancellationToken token = default)
• public interface IReplicationCluster<TEntry> : IReplicationCluster, ICluster where TEntry : ILogEntry
  • IAuditTrail<LogEntry> AuditTrail { get; }
  • Task WriteAsync<T>(DataHandler<T, LogEntry> handler, T input, WriteConcern concern)
  • IAuditTrail<TEntry> AuditTrail { get; }
• public enum WriteConcern
• public sealed delegate ReplicationCompletedEventHandler : MulticastDelegate
  • public ReplicationCompletedEventHandler(object object, IntPtr method)
  • public virtual IAsyncResult BeginInvoke(ICluster cluster, IClusterMember source, AsyncCallback callback, object object)
  • public virtual void EndInvoke(IAsyncResult result)
  • public virtual void Invoke(ICluster cluster, IClusterMember source)

DotNext.Net.Security

• public class SslOptions
  • public SslClientAuthenticationOptions ClientOptions { get; }
  • public SslServerAuthenticationOptions ServerOptions { get; }
  • public SslOptions(SslServerAuthenticationOptions serverOptions, SslClientAuthenticationOptions clientOptions)
  • public SslOptions()

DotNext.Runtime.Serialization

• public interface IFormatter<T>
  • ValueTask<T> DeserializeAsync<TReader>(TReader reader, CancellationToken token) where TReader : IAsyncBinaryReader
  • long? GetLength(T obj)
  • ValueTask SerializeAsync<TWriter>(T obj, TWriter writer, CancellationToken token) where TWriter : IAsyncBinaryWriter