Skip to content

Commit

Permalink
docs: update docs for v4.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@BEagle1984
BEagle1984 committed Jan 9, 2025
1 parent fd8d20a commit 339a111
Show file tree
Hide file tree
Showing 12 changed files with 1,446 additions and 735 deletions.
390 changes: 390 additions & 0 deletions api/Silverback.Messaging.Broker.Kafka.OffsetsTracker.html
View file

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions api/Silverback.Messaging.Broker.Kafka.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ <h4><a class="xref" href="Silverback.Messaging.Broker.Kafka.MockedConfluentConsu
</section>
<h4><a class="xref" href="Silverback.Messaging.Broker.Kafka.MockedConfluentProducerBuilder.html">MockedConfluentProducerBuilder</a></h4>
<section><p>The builder for the <a class="xref" href="Silverback.Messaging.Broker.Kafka.Mocks.MockedConfluentProducer.html">MockedConfluentProducer</a>.</p>
</section>
<h4><a class="xref" href="Silverback.Messaging.Broker.Kafka.OffsetsTracker.html">OffsetsTracker</a></h4>
<section><p>Keeps track of the offsets of the messages being produced or consumed.</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
Expand Down
73 changes: 66 additions & 7 deletions api/Silverback.Messaging.Broker.KafkaConsumer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ <h3 id="methods">Methods
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_CommitCoreAsync_System_Collections_Generic_IReadOnlyCollection_Silverback_Messaging_Broker_KafkaOffset__.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.CommitCoreAsync(System.Collections.Generic.IReadOnlyCollection%7BSilverback.Messaging.Broker.KafkaOffset%7D)%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L252">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L281">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_CommitCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.CommitCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_CommitCoreAsync_System_Collections_Generic_IReadOnlyCollection_Silverback_Messaging_Broker_KafkaOffset__" data-uid="Silverback.Messaging.Broker.KafkaConsumer.CommitCoreAsync(System.Collections.Generic.IReadOnlyCollection{Silverback.Messaging.Broker.KafkaOffset})">CommitCoreAsync(IReadOnlyCollection&lt;KafkaOffset&gt;)</h4>
Expand Down Expand Up @@ -398,7 +398,7 @@ <h5 class="overrides">Overrides</h5>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_ConnectCoreAsync.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.ConnectCoreAsync%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L196">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L216">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_ConnectCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.ConnectCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_ConnectCoreAsync" data-uid="Silverback.Messaging.Broker.KafkaConsumer.ConnectCoreAsync">ConnectCoreAsync()</h4>
Expand Down Expand Up @@ -432,7 +432,7 @@ <h5 class="overrides">Overrides</h5>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_DisconnectCoreAsync.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.DisconnectCoreAsync%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L204">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L224">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_DisconnectCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.DisconnectCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_DisconnectCoreAsync" data-uid="Silverback.Messaging.Broker.KafkaConsumer.DisconnectCoreAsync">DisconnectCoreAsync()</h4>
Expand Down Expand Up @@ -499,12 +499,71 @@ <h5 class="overrides">Overrides</h5>
<h5 id="Silverback_Messaging_Broker_KafkaConsumer_GetCurrentSequenceStores_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Used only for testing and maintained to preserve backward compatibility.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_GetOffsetsForTimestamp_System_Collections_Generic_IEnumerable_Confluent_Kafka_TopicPartitionTimestamp__System_TimeSpan_.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.GetOffsetsForTimestamp(System.Collections.Generic.IEnumerable%7BConfluent.Kafka.TopicPartitionTimestamp%7D%2CSystem.TimeSpan)%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L124">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_GetOffsetsForTimestamp_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.GetOffsetsForTimestamp*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_GetOffsetsForTimestamp_System_Collections_Generic_IEnumerable_Confluent_Kafka_TopicPartitionTimestamp__System_TimeSpan_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.GetOffsetsForTimestamp(System.Collections.Generic.IEnumerable{Confluent.Kafka.TopicPartitionTimestamp},System.TimeSpan)">GetOffsetsForTimestamp(IEnumerable&lt;TopicPartitionTimestamp&gt;, TimeSpan)</h4>
<div class="markdown level1 summary"><p>Look up the offsets for the given partitions by timestamp. The returned offset for each partition
is the earliest offset for which the timestamp is greater than or equal to the given timestamp.
If the provided timestamp exceeds that of the last message in the partition, a value of
<code>Offset.End</code> (-1) will be returned.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang- hljs">public IReadOnlyList&lt;TopicPartitionOffset&gt; GetOffsetsForTimestamp(IEnumerable&lt;TopicPartitionTimestamp&gt; topicPartitionTimestamps, TimeSpan timeout)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;<span class="xref">TopicPartitionTimestamp</span>&gt;</td>
<td><span class="parametername">topicPartitionTimestamps</span></td>
<td><p>The list of partitions with the target timestamps.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></td>
<td><span class="parametername">timeout</span></td>
<td><p>The maximum amount of time to block waiting for the requested offsets.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped 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.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<span class="xref">TopicPartitionOffset</span>&gt;</td>
<td><p>The list of offsets for each partition.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_RollbackCoreAsync_System_Collections_Generic_IReadOnlyCollection_Silverback_Messaging_Broker_KafkaOffset__.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.RollbackCoreAsync(System.Collections.Generic.IReadOnlyCollection%7BSilverback.Messaging.Broker.KafkaOffset%7D)%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L279">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L309">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_RollbackCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.RollbackCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_RollbackCoreAsync_System_Collections_Generic_IReadOnlyCollection_Silverback_Messaging_Broker_KafkaOffset__" data-uid="Silverback.Messaging.Broker.KafkaConsumer.RollbackCoreAsync(System.Collections.Generic.IReadOnlyCollection{Silverback.Messaging.Broker.KafkaOffset})">RollbackCoreAsync(IReadOnlyCollection&lt;KafkaOffset&gt;)</h4>
Expand Down Expand Up @@ -557,7 +616,7 @@ <h5 class="overrides">Overrides</h5>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_StartCoreAsync.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.StartCoreAsync%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L214">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L234">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_StartCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.StartCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_StartCoreAsync" data-uid="Silverback.Messaging.Broker.KafkaConsumer.StartCoreAsync">StartCoreAsync()</h4>
Expand Down Expand Up @@ -591,7 +650,7 @@ <h5 class="overrides">Overrides</h5>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_StopCoreAsync.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.StopCoreAsync%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L238">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L267">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_StopCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.StopCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_StopCoreAsync" data-uid="Silverback.Messaging.Broker.KafkaConsumer.StopCoreAsync">StopCoreAsync()</h4>
Expand Down Expand Up @@ -625,7 +684,7 @@ <h5 class="overrides">Overrides</h5>
<a href="https://github.com/beagle1984/silverback/new/master/docs-ref-overwrite/new?filename=Silverback_Messaging_Broker_KafkaConsumer_WaitUntilConsumingStoppedCoreAsync.md&amp;value=---%0Auid%3A%20Silverback.Messaging.Broker.KafkaConsumer.WaitUntilConsumingStoppedCoreAsync%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">Improve this doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L246">View source</a>
<a href="https://github.com/BEagle1984/silverback/blob/master/src/Silverback.Integration.Kafka/Messaging/Broker/KafkaConsumer.cs/#L275">View source</a>
</span>
<a id="Silverback_Messaging_Broker_KafkaConsumer_WaitUntilConsumingStoppedCoreAsync_" data-uid="Silverback.Messaging.Broker.KafkaConsumer.WaitUntilConsumingStoppedCoreAsync*"></a>
<h4 id="Silverback_Messaging_Broker_KafkaConsumer_WaitUntilConsumingStoppedCoreAsync" data-uid="Silverback.Messaging.Broker.KafkaConsumer.WaitUntilConsumingStoppedCoreAsync">WaitUntilConsumingStoppedCoreAsync()</h4>
Expand Down
Loading

0 comments on commit 339a111

Please sign in to comment.