Skip to content

Commit

Permalink
Refreshed docs for 5.6.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
@sakno
sakno committed May 30, 2024
1 parent edae206 commit 7bf4f67
Show file tree
Hide file tree
Showing 18 changed files with 876 additions and 72 deletions.
50 changes: 49 additions & 1 deletion api/DotNext.Net.Cluster.Consensus.Raft.BinaryLogEntry-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,12 @@ <h1 id="DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1" data-uid="DotNext.N
<div class="markdown level0 conceptual"></div>
<div class="implements">
<h5>Implements</h5>
<div><a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.IInputLogEntry.html">IInputLogEntry</a></div>
<div><a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.IRaftLogEntry.html">IRaftLogEntry</a></div>
<div><a class="xref" href="DotNext.IO.Log.ILogEntry.html">ILogEntry</a></div>
<div><a class="xref" href="DotNext.IO.IDataTransferObject.html">IDataTransferObject</a></div>
<div><a class="xref" href="DotNext.ISupplier-2.html">ISupplier</a>&lt;<a class="xref" href="DotNext.Buffers.MemoryAllocator-1.html">MemoryAllocator</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>&gt;, <a class="xref" href="DotNext.Buffers.MemoryOwner-1.html">MemoryOwner</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>&gt;&gt;</div>
<div><a class="xref" href="DotNext.Runtime.CompilerServices.IFunctional-1.html">IFunctional</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="DotNext.Buffers.MemoryAllocator-1.html">MemoryAllocator</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>&gt;, <a class="xref" href="DotNext.Buffers.MemoryOwner-1.html">MemoryOwner</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>&gt;&gt;&gt;</div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
Expand All @@ -104,7 +107,7 @@ <h6><strong>Namespace</strong>: <a class="xref" href="DotNext.html">DotNext</a>.
<h6><strong>Assembly</strong>: DotNext.Net.Cluster.dll</h6>
<h5 id="DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly struct BinaryLogEntry&lt;T&gt; : IRaftLogEntry, ILogEntry, IDataTransferObject where T : notnull, IBinaryFormattable&lt;T&gt;</code></pre>
<pre><code class="lang-csharp hljs">public readonly struct BinaryLogEntry&lt;T&gt; : IInputLogEntry, IRaftLogEntry, ILogEntry, IDataTransferObject, ISupplier&lt;MemoryAllocator&lt;byte&gt;, MemoryOwner&lt;byte&gt;&gt;, IFunctional&lt;Func&lt;MemoryAllocator&lt;byte&gt;, MemoryOwner&lt;byte&gt;&gt;&gt; where T : notnull, IBinaryFormattable&lt;T&gt;</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-condensed">
Expand Down Expand Up @@ -204,6 +207,42 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnet/dotNext/new/gh-pages/docs/api/new?filename=DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1_Context.md&amp;value=---%0Auid%3A%20DotNext.Net.Cluster.Consensus.Raft.BinaryLogEntry%601.Context%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnet/dotNext/blob/gh-pages/src/cluster/DotNext.Net.Cluster/Net/Cluster/Consensus/Raft/BinaryLogEntry.cs/#L48">View Source</a>
</span>
<a id="DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1_Context_" data-uid="DotNext.Net.Cluster.Consensus.Raft.BinaryLogEntry`1.Context*"></a>
<h4 id="DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1_Context" data-uid="DotNext.Net.Cluster.Consensus.Raft.BinaryLogEntry`1.Context">Context</h4>
<div class="markdown level1 summary"><p>Gets or sets runtime context associated with the log entry.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object? Context { get; init; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1_Context_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The value passes through <a class="xref" href="DotNext.IO.Log.IAuditTrail-1.html#DotNext_IO_Log_IAuditTrail_1_AppendAsync__1___0_System_Threading_CancellationToken_">AppendAsync&lt;TEntryImpl&gt;(TEntryImpl, CancellationToken)</a>
to <a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.MemoryBasedStateMachine.html#DotNext_Net_Cluster_Consensus_Raft_MemoryBasedStateMachine_ApplyAsync_DotNext_Net_Cluster_Consensus_Raft_PersistentState_LogEntry_">ApplyAsync(LogEntry)</a> or <a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.DiskBasedStateMachine.html#DotNext_Net_Cluster_Consensus_Raft_DiskBasedStateMachine_ApplyAsync_DotNext_Net_Cluster_Consensus_Raft_PersistentState_LogEntry_">ApplyAsync(LogEntry)</a>.
It can be retrieved by using <a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.PersistentState.LogEntry.html#DotNext_Net_Cluster_Consensus_Raft_PersistentState_LogEntry_Context">Context</a> property.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnet/dotNext/new/gh-pages/docs/api/new?filename=DotNext_Net_Cluster_Consensus_Raft_BinaryLogEntry_1_Term.md&amp;value=---%0Auid%3A%20DotNext.Net.Cluster.Consensus.Raft.BinaryLogEntry%601.Term%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
Expand Down Expand Up @@ -267,6 +306,9 @@ <h5 class="propertyValue">Property Value</h5>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.IInputLogEntry.html">IInputLogEntry</a>
</div>
<div>
<a class="xref" href="DotNext.Net.Cluster.Consensus.Raft.IRaftLogEntry.html">IRaftLogEntry</a>
</div>
Expand All @@ -276,6 +318,12 @@ <h3 id="implements">Implements</h3>
<div>
<a class="xref" href="DotNext.IO.IDataTransferObject.html">IDataTransferObject</a>
</div>
<div>
<a class="xref" href="DotNext.ISupplier-2.html">ISupplier&lt;T, TResult&gt;</a>
</div>
<div>
<a class="xref" href="DotNext.Runtime.CompilerServices.IFunctional-1.html">IFunctional&lt;TDelegate&gt;</a>
</div>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="DotNext.BasicExtensions.html#DotNext_BasicExtensions_IsBetween__3___0___1___2_">BasicExtensions.IsBetween&lt;T, TLowerBound, TUpperBound&gt;(T, TLowerBound, TUpperBound)</a>
Expand Down
Loading

0 comments on commit 7bf4f67

Please sign in to comment.