| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title>Class SubConsumer<TMessage> | Official DotPulsar Documentation </title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="title" content="Class SubConsumer<TMessage> | Official DotPulsar Documentation "> |
| |
| |
| <link rel="icon" href="../assets/favicon.ico"> |
| <link rel="stylesheet" href="../public/docfx.min.css"> |
| <link rel="stylesheet" href="../public/main.css"> |
| <meta name="docfx:navrel" content="../toc.html"> |
| <meta name="docfx:tocrel" content="toc.html"> |
| |
| |
| |
| |
| <meta name="docfx:docurl" content="https://github.com/apache/pulsar-dotpulsar/new/3.3.1/apiSpec/new?filename=DotPulsar_Internal_SubConsumer_1.md&value=---%0Auid%3A%20DotPulsar.Internal.SubConsumer%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> |
| <meta name="loc:inThisArticle" content="In this article"> |
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> |
| <meta name="loc:searchNoResults" content="No results for "{query}""> |
| <meta name="loc:tocFilter" content="Filter by title"> |
| <meta name="loc:nextArticle" content="Next"> |
| <meta name="loc:prevArticle" content="Previous"> |
| <meta name="loc:themeLight" content="Light"> |
| <meta name="loc:themeDark" content="Dark"> |
| <meta name="loc:themeAuto" content="Auto"> |
| <meta name="loc:changeTheme" content="Change theme"> |
| <meta name="loc:copy" content="Copy"> |
| <meta name="loc:downloadPdf" content="Download PDF"> |
| |
| <script type="module" src="./../public/docfx.min.js"></script> |
| |
| <script> |
| const theme = localStorage.getItem('theme') || 'auto' |
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) |
| </script> |
| |
| </head> |
| |
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> |
| <header class="bg-body border-bottom"> |
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> |
| <div class="container-xxl flex-nowrap"> |
| <a class="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../assets/pulsar.svg" alt=""> |
| |
| </a> |
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> |
| <i class="bi bi-three-dots"></i> |
| </button> |
| <div class="collapse navbar-collapse" id="navpanel"> |
| <div id="navbar"> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| <main class="container-xxl"> |
| <div class="toc-offcanvas"> |
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> |
| <div class="offcanvas-header"> |
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> |
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> |
| </div> |
| <div class="offcanvas-body"> |
| <nav class="toc" id="toc"></nav> |
| </div> |
| </div> |
| </div> |
| |
| <div class="content"> |
| <div class="actionbar"> |
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> |
| <i class="bi bi-list"></i> |
| </button> |
| |
| <nav id="breadcrumb"></nav> |
| </div> |
| |
| <article data-uid="DotPulsar.Internal.SubConsumer`1"> |
| |
| |
| |
| <h1 id="DotPulsar_Internal_SubConsumer_1" data-uid="DotPulsar.Internal.SubConsumer`1" class="text-break"> |
| Class SubConsumer<TMessage> <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L25"><i class="bi bi-code-slash"></i></a> |
| </h1> |
| |
| <div class="facts text-secondary"> |
| <dl><dt>Namespace</dt><dd><a class="xref" href="DotPulsar.html">DotPulsar</a>.<a class="xref" href="DotPulsar.Internal.html">Internal</a></dd></dl> |
| <dl><dt>Assembly</dt><dd>DotPulsar.dll</dd></dl> |
| </div> |
| |
| <div class="markdown summary"></div> |
| <div class="markdown conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class SubConsumer<TMessage> : IConsumer<TMessage>, IConsumer, IGetLastMessageIds, ISeek, IState<ConsumerState>, IReceive<IMessage<TMessage>>, IContainsChannel, IAsyncDisposable</code></pre> |
| </div> |
| |
| |
| |
| <h4 class="section">Type Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>TMessage</code></dt> |
| <dd></dd> |
| </dl> |
| |
| <dl class="typelist inheritance"> |
| <dt>Inheritance</dt> |
| <dd> |
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> |
| <div><span class="xref">SubConsumer<TMessage></span></div> |
| </dd> |
| </dl> |
| |
| <dl class="typelist implements"> |
| <dt>Implements</dt> |
| <dd> |
| <div><a class="xref" href="DotPulsar.Abstractions.IConsumer-1.html">IConsumer</a><TMessage></div> |
| <div><a class="xref" href="DotPulsar.Abstractions.IConsumer.html">IConsumer</a></div> |
| <div><a class="xref" href="DotPulsar.Abstractions.IGetLastMessageIds.html">IGetLastMessageIds</a></div> |
| <div><a class="xref" href="DotPulsar.Abstractions.ISeek.html">ISeek</a></div> |
| <div><a class="xref" href="DotPulsar.Abstractions.IState-1.html">IState</a><<a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a>></div> |
| <div><a class="xref" href="DotPulsar.Abstractions.IReceive-1.html">IReceive</a><<a class="xref" href="DotPulsar.Abstractions.IMessage-1.html">IMessage</a><TMessage>></div> |
| <div><a class="xref" href="DotPulsar.Internal.Abstractions.IContainsChannel.html">IContainsChannel</a></div> |
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iasyncdisposable">IAsyncDisposable</a></div> |
| </dd> |
| </dl> |
| |
| |
| <dl class="typelist inheritedMembers"> |
| <dt>Inherited Members</dt> |
| <dd> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a> |
| </div> |
| </dd></dl> |
| |
| <dl class="typelist extensionMethods"> |
| <dt>Extension Methods</dt> |
| <dd> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_Acknowledge_DotPulsar_Abstractions_IConsumer_DotPulsar_Abstractions_IMessage_System_Threading_CancellationToken_">ConsumerExtensions.Acknowledge(IConsumer, IMessage, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_AcknowledgeCumulative_DotPulsar_Abstractions_IConsumer_DotPulsar_Abstractions_IMessage_System_Threading_CancellationToken_">ConsumerExtensions.AcknowledgeCumulative(IConsumer, IMessage, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_StateChangedFrom_DotPulsar_Abstractions_IConsumer_DotPulsar_ConsumerState_System_Threading_CancellationToken_">ConsumerExtensions.StateChangedFrom(IConsumer, ConsumerState, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_StateChangedFrom_DotPulsar_Abstractions_IConsumer_DotPulsar_ConsumerState_System_TimeSpan_System_Threading_CancellationToken_">ConsumerExtensions.StateChangedFrom(IConsumer, ConsumerState, TimeSpan, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_StateChangedTo_DotPulsar_Abstractions_IConsumer_DotPulsar_ConsumerState_System_Threading_CancellationToken_">ConsumerExtensions.StateChangedTo(IConsumer, ConsumerState, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_StateChangedTo_DotPulsar_Abstractions_IConsumer_DotPulsar_ConsumerState_System_TimeSpan_System_Threading_CancellationToken_">ConsumerExtensions.StateChangedTo(IConsumer, ConsumerState, TimeSpan, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_Process__1_DotPulsar_Abstractions_IConsumer___0__System_Func_DotPulsar_Abstractions_IMessage___0__System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__DotPulsar_ProcessingOptions_System_Threading_CancellationToken_">ConsumerExtensions.Process<TMessage>(IConsumer<TMessage>, Func<IMessage<TMessage>, CancellationToken, ValueTask>, ProcessingOptions, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ConsumerExtensions.html#DotPulsar_Extensions_ConsumerExtensions_Process__1_DotPulsar_Abstractions_IConsumer___0__System_Func_DotPulsar_Abstractions_IMessage___0__System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">ConsumerExtensions.Process<TMessage>(IConsumer<TMessage>, Func<IMessage<TMessage>, CancellationToken, ValueTask>, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ReceiveExtensions.html#DotPulsar_Extensions_ReceiveExtensions_Messages__1_DotPulsar_Abstractions_IReceive___0__System_Threading_CancellationToken_">ReceiveExtensions.Messages<TMessage>(IReceive<TMessage>, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ReceiveExtensions.html#DotPulsar_Extensions_ReceiveExtensions_TryReceive__1_DotPulsar_Abstractions_IReceive___0____0__">ReceiveExtensions.TryReceive<TMessage>(IReceive<TMessage>, out TMessage?)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.SeekExtensions.html#DotPulsar_Extensions_SeekExtensions_Seek_DotPulsar_Abstractions_ISeek_System_DateTime_System_Threading_CancellationToken_">SeekExtensions.Seek(ISeek, DateTime, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.SeekExtensions.html#DotPulsar_Extensions_SeekExtensions_Seek_DotPulsar_Abstractions_ISeek_System_DateTimeOffset_System_Threading_CancellationToken_">SeekExtensions.Seek(ISeek, DateTimeOffset, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_OnStateChangeFrom__1_DotPulsar_Abstractions_IState___0____0_System_TimeSpan_System_Threading_CancellationToken_">StateExtensions.OnStateChangeFrom<TState>(IState<TState>, TState, TimeSpan, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_OnStateChangeTo__1_DotPulsar_Abstractions_IState___0____0_System_TimeSpan_System_Threading_CancellationToken_">StateExtensions.OnStateChangeTo<TState>(IState<TState>, TState, TimeSpan, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_DelayedStateMonitor__2___0___1_System_TimeSpan_System_Action___0___1__System_Action___0___1__System_Threading_CancellationToken_">StateExtensions.DelayedStateMonitor<TEntity, TState>(TEntity, TState, TimeSpan, Action<TEntity, TState>, Action<TEntity, TState>, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_DelayedStateMonitor__2___0___1_System_TimeSpan_System_Func___0___1_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Func___0___1_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">StateExtensions.DelayedStateMonitor<TEntity, TState>(TEntity, TState, TimeSpan, Func<TEntity, TState, CancellationToken, ValueTask>, Func<TEntity, TState, CancellationToken, ValueTask>, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_DelayedStateMonitor__3___0___1_System_TimeSpan_System_Func___0___1_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask___2___System_Func___0___1___2_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">StateExtensions.DelayedStateMonitor<TEntity, TState, TFaultContext>(TEntity, TState, TimeSpan, Func<TEntity, TState, CancellationToken, ValueTask<TFaultContext>>, Func<TEntity, TState, TFaultContext, CancellationToken, ValueTask>, CancellationToken)</a> |
| </div> |
| </dd></dl> |
| |
| |
| |
| |
| |
| <h2 class="section" id="constructors">Constructors |
| </h2> |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1__ctor_" data-uid="DotPulsar.Internal.SubConsumer`1.#ctor*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1__ctor_System_Guid_System_Uri_System_String_DotPulsar_SubscriptionType_System_String_DotPulsar_Internal_Abstractions_IRegisterEvent_DotPulsar_Internal_Abstractions_IConsumerChannel__0__DotPulsar_Internal_Abstractions_IExecute_DotPulsar_Internal_Abstractions_IStateChanged_DotPulsar_ConsumerState__DotPulsar_Internal_Abstractions_IConsumerChannelFactory__0__" data-uid="DotPulsar.Internal.SubConsumer`1.#ctor(System.Guid,System.Uri,System.String,DotPulsar.SubscriptionType,System.String,DotPulsar.Internal.Abstractions.IRegisterEvent,DotPulsar.Internal.Abstractions.IConsumerChannel{`0},DotPulsar.Internal.Abstractions.IExecute,DotPulsar.Internal.Abstractions.IStateChanged{DotPulsar.ConsumerState},DotPulsar.Internal.Abstractions.IConsumerChannelFactory{`0})"> |
| SubConsumer(Guid, Uri, string, SubscriptionType, string, IRegisterEvent, IConsumerChannel<TMessage>, IExecute, IStateChanged<ConsumerState>, IConsumerChannelFactory<TMessage>) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L42"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SubConsumer(Guid correlationId, Uri serviceUrl, string subscriptionName, SubscriptionType subscriptionType, string topic, IRegisterEvent eventRegister, IConsumerChannel<TMessage> initialChannel, IExecute executor, IStateChanged<ConsumerState> state, IConsumerChannelFactory<TMessage> factory)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>correlationId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></dt> |
| <dd></dd> |
| <dt><code>serviceUrl</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uri">Uri</a></dt> |
| <dd></dd> |
| <dt><code>subscriptionName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd></dd> |
| <dt><code>subscriptionType</code> <a class="xref" href="DotPulsar.SubscriptionType.html">SubscriptionType</a></dt> |
| <dd></dd> |
| <dt><code>topic</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd></dd> |
| <dt><code>eventRegister</code> <a class="xref" href="DotPulsar.Internal.Abstractions.IRegisterEvent.html">IRegisterEvent</a></dt> |
| <dd></dd> |
| <dt><code>initialChannel</code> <a class="xref" href="DotPulsar.Internal.Abstractions.IConsumerChannel-1.html">IConsumerChannel</a><TMessage></dt> |
| <dd></dd> |
| <dt><code>executor</code> <a class="xref" href="DotPulsar.Internal.Abstractions.IExecute.html">IExecute</a></dt> |
| <dd></dd> |
| <dt><code>state</code> <a class="xref" href="DotPulsar.Internal.Abstractions.IStateChanged-1.html">IStateChanged</a><<a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a>></dt> |
| <dd></dd> |
| <dt><code>factory</code> <a class="xref" href="DotPulsar.Internal.Abstractions.IConsumerChannelFactory-1.html">IConsumerChannelFactory</a><TMessage></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="properties">Properties |
| </h2> |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_ServiceUrl_" data-uid="DotPulsar.Internal.SubConsumer`1.ServiceUrl*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_ServiceUrl" data-uid="DotPulsar.Internal.SubConsumer`1.ServiceUrl"> |
| ServiceUrl |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L37"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The consumer's service url.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Uri ServiceUrl { get; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uri">Uri</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_SubscriptionName_" data-uid="DotPulsar.Internal.SubConsumer`1.SubscriptionName*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_SubscriptionName" data-uid="DotPulsar.Internal.SubConsumer`1.SubscriptionName"> |
| SubscriptionName |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L38"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The consumer's subscription name.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string SubscriptionName { get; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_SubscriptionType_" data-uid="DotPulsar.Internal.SubConsumer`1.SubscriptionType*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_SubscriptionType" data-uid="DotPulsar.Internal.SubConsumer`1.SubscriptionType"> |
| SubscriptionType |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L39"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The consumer's subscription type.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SubscriptionType SubscriptionType { get; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="DotPulsar.SubscriptionType.html">SubscriptionType</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_Topic_" data-uid="DotPulsar.Internal.SubConsumer`1.Topic*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_Topic" data-uid="DotPulsar.Internal.SubConsumer`1.Topic"> |
| Topic |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L40"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The consumer's topic.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string Topic { get; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="methods">Methods |
| </h2> |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_Acknowledge_" data-uid="DotPulsar.Internal.SubConsumer`1.Acknowledge*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_Acknowledge_DotPulsar_MessageId_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.Acknowledge(DotPulsar.MessageId,System.Threading.CancellationToken)"> |
| Acknowledge(MessageId, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L100"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Acknowledge the consumption of a single message using the MessageId.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask Acknowledge(MessageId messageId, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>messageId</code> <a class="xref" href="DotPulsar.MessageId.html">MessageId</a></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_AcknowledgeCumulative_" data-uid="DotPulsar.Internal.SubConsumer`1.AcknowledgeCumulative*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_AcknowledgeCumulative_DotPulsar_MessageId_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.AcknowledgeCumulative(DotPulsar.MessageId,System.Threading.CancellationToken)"> |
| AcknowledgeCumulative(MessageId, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L103"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Acknowledge the consumption of all the messages in the topic up to and including the provided MessageId.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask AcknowledgeCumulative(MessageId messageId, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>messageId</code> <a class="xref" href="DotPulsar.MessageId.html">MessageId</a></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_ChannelFaulted_" data-uid="DotPulsar.Internal.SubConsumer`1.ChannelFaulted*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_ChannelFaulted_System_Exception_" data-uid="DotPulsar.Internal.SubConsumer`1.ChannelFaulted(System.Exception)"> |
| ChannelFaulted(Exception) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L163"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask ChannelFaulted(Exception exception)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>exception</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_CloseChannel_" data-uid="DotPulsar.Internal.SubConsumer`1.CloseChannel*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_CloseChannel_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.CloseChannel(System.Threading.CancellationToken)"> |
| CloseChannel(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L160"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask CloseChannel(CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_DisposeAsync_" data-uid="DotPulsar.Internal.SubConsumer`1.DisposeAsync*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_DisposeAsync" data-uid="DotPulsar.Internal.SubConsumer`1.DisposeAsync"> |
| DisposeAsync() |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L82"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or |
| resetting unmanaged resources asynchronously.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask DisposeAsync()</code></pre> |
| </div> |
| |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_EstablishNewChannel_" data-uid="DotPulsar.Internal.SubConsumer`1.EstablishNewChannel*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_EstablishNewChannel_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.EstablishNewChannel(System.Threading.CancellationToken)"> |
| EstablishNewChannel(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L149"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Task EstablishNewChannel(CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_GetLastMessageId_" data-uid="DotPulsar.Internal.SubConsumer`1.GetLastMessageId*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_GetLastMessageId_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.GetLastMessageId(System.Threading.CancellationToken)"> |
| GetLastMessageId(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L134"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask<MessageId> GetLastMessageId(CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1">ValueTask</a><<a class="xref" href="DotPulsar.MessageId.html">MessageId</a>></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_GetLastMessageIds_" data-uid="DotPulsar.Internal.SubConsumer`1.GetLastMessageIds*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_GetLastMessageIds_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.GetLastMessageIds(System.Threading.CancellationToken)"> |
| GetLastMessageIds(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L223"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Get the message ids of the last messages on the topic. Non-partitioned topics will only return one message id.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask<IEnumerable<MessageId>> GetLastMessageIds(CancellationToken cancellationToken = default)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1">ValueTask</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><<a class="xref" href="DotPulsar.MessageId.html">MessageId</a>>></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_IsFinalState_" data-uid="DotPulsar.Internal.SubConsumer`1.IsFinalState*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_IsFinalState" data-uid="DotPulsar.Internal.SubConsumer`1.IsFinalState"> |
| IsFinalState() |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L76"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Ask whether the current state is final, meaning that it will never change.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool IsFinalState()</code></pre> |
| </div> |
| |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> |
| <dd><p>True if it's final and False if it's not.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_IsFinalState_" data-uid="DotPulsar.Internal.SubConsumer`1.IsFinalState*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_IsFinalState_DotPulsar_ConsumerState_" data-uid="DotPulsar.Internal.SubConsumer`1.IsFinalState(DotPulsar.ConsumerState)"> |
| IsFinalState(ConsumerState) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L79"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Ask whether the provided state is final, meaning that it will never change.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool IsFinalState(ConsumerState state)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>state</code> <a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> |
| <dd><p>True if it's final and False if it's not.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_OnStateChangeFrom_" data-uid="DotPulsar.Internal.SubConsumer`1.OnStateChangeFrom*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_OnStateChangeFrom_DotPulsar_ConsumerState_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.OnStateChangeFrom(DotPulsar.ConsumerState,System.Threading.CancellationToken)"> |
| OnStateChangeFrom(ConsumerState, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L73"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Wait for the state to change from a specific state.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask<ConsumerState> OnStateChangeFrom(ConsumerState state, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>state</code> <a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1">ValueTask</a><<a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a>></dt> |
| <dd><p>The current state.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="section" id="DotPulsar_Internal_SubConsumer_1_OnStateChangeFrom_DotPulsar_ConsumerState_System_Threading_CancellationToken__remarks">Remarks</h4> |
| <div class="markdown level1 remarks"><p>If the state change to a final state, then all awaiting tasks will complete.</p> |
| </div> |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_OnStateChangeTo_" data-uid="DotPulsar.Internal.SubConsumer`1.OnStateChangeTo*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_OnStateChangeTo_DotPulsar_ConsumerState_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.OnStateChangeTo(DotPulsar.ConsumerState,System.Threading.CancellationToken)"> |
| OnStateChangeTo(ConsumerState, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L70"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Wait for the state to change to a specific state.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask<ConsumerState> OnStateChangeTo(ConsumerState state, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>state</code> <a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1">ValueTask</a><<a class="xref" href="DotPulsar.ConsumerState.html">ConsumerState</a>></dt> |
| <dd><p>The current state.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| <h4 class="section" id="DotPulsar_Internal_SubConsumer_1_OnStateChangeTo_DotPulsar_ConsumerState_System_Threading_CancellationToken__remarks">Remarks</h4> |
| <div class="markdown level1 remarks"><p>If the state change to a final state, then all awaiting tasks will complete.</p> |
| </div> |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_Receive_" data-uid="DotPulsar.Internal.SubConsumer`1.Receive*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_Receive_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.Receive(System.Threading.CancellationToken)"> |
| Receive(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L97"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Receive a single message.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask<IMessage<TMessage>> Receive(CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1">ValueTask</a><<a class="xref" href="DotPulsar.Abstractions.IMessage-1.html">IMessage</a><TMessage>></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_RedeliverUnacknowledgedMessages_" data-uid="DotPulsar.Internal.SubConsumer`1.RedeliverUnacknowledgedMessages*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_RedeliverUnacknowledgedMessages_System_Collections_Generic_IEnumerable_DotPulsar_MessageId__System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.RedeliverUnacknowledgedMessages(System.Collections.Generic.IEnumerable{DotPulsar.MessageId},System.Threading.CancellationToken)"> |
| RedeliverUnacknowledgedMessages(IEnumerable<MessageId>, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L106"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Redeliver the pending messages that were pushed to this consumer that are not yet acknowledged.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask RedeliverUnacknowledgedMessages(IEnumerable<MessageId> messageIds, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>messageIds</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><<a class="xref" href="DotPulsar.MessageId.html">MessageId</a>></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_RedeliverUnacknowledgedMessages_" data-uid="DotPulsar.Internal.SubConsumer`1.RedeliverUnacknowledgedMessages*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_RedeliverUnacknowledgedMessages_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.RedeliverUnacknowledgedMessages(System.Threading.CancellationToken)"> |
| RedeliverUnacknowledgedMessages(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L113"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Redeliver all pending messages that were pushed to this consumer that are not yet acknowledged.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask RedeliverUnacknowledgedMessages(CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_Seek_" data-uid="DotPulsar.Internal.SubConsumer`1.Seek*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_Seek_DotPulsar_MessageId_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.Seek(DotPulsar.MessageId,System.Threading.CancellationToken)"> |
| Seek(MessageId, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L122"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Reset the cursor associated with the consumer or reader to a specific MessageId.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask Seek(MessageId messageId, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>messageId</code> <a class="xref" href="DotPulsar.MessageId.html">MessageId</a></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_Seek_" data-uid="DotPulsar.Internal.SubConsumer`1.Seek*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_Seek_System_UInt64_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.Seek(System.UInt64,System.Threading.CancellationToken)"> |
| Seek(ulong, CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L128"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Reset the cursor associated with the consumer or reader to a specific message publish time using unix time in milliseconds.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask Seek(ulong publishTime, CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>publishTime</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint64">ulong</a></dt> |
| <dd></dd> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_SubConsumer_1_Unsubscribe_" data-uid="DotPulsar.Internal.SubConsumer`1.Unsubscribe*"></a> |
| |
| <h3 id="DotPulsar_Internal_SubConsumer_1_Unsubscribe_System_Threading_CancellationToken_" data-uid="DotPulsar.Internal.SubConsumer`1.Unsubscribe(System.Threading.CancellationToken)"> |
| Unsubscribe(CancellationToken) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L116"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Unsubscribe the consumer.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueTask Unsubscribe(CancellationToken cancellationToken)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| <div class="contribution d-print-none"> |
| <a href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/SubConsumer.cs/#L25" class="edit-link">Edit this page</a> |
| </div> |
| |
| |
| </div> |
| |
| <div class="affix"> |
| <nav id="affix"></nav> |
| </div> |
| </main> |
| |
| |
| <footer class="border-top text-secondary"> |
| <div class="container-xxl"> |
| <div class="flex-fill"> |
| Copyright © 2019-2024 The Apache Software Foundation. All Rights Reserved. Apache, Pulsar, Apache Pulsar, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |