| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title>Class ReaderOptions<TMessage> | Official DotPulsar Documentation </title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="title" content="Class ReaderOptions<TMessage> | Official DotPulsar Documentation "> |
| |
| <meta name="description" content="The reader building options."> |
| <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_ReaderOptions_1.md&value=---%0Auid%3A%20DotPulsar.ReaderOptions%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.ReaderOptions`1"> |
| |
| |
| |
| <h1 id="DotPulsar_ReaderOptions_1" data-uid="DotPulsar.ReaderOptions`1" class="text-break"> |
| Class ReaderOptions<TMessage> <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L22"><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></dd></dl> |
| <dl><dt>Assembly</dt><dd>DotPulsar.dll</dd></dl> |
| </div> |
| |
| <div class="markdown summary"><p>The reader building options.</p> |
| </div> |
| <div class="markdown conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class ReaderOptions<TMessage></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">ReaderOptions<TMessage></span></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.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_ReaderOptions_1__ctor_" data-uid="DotPulsar.ReaderOptions`1.#ctor*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1__ctor_DotPulsar_MessageId_System_String_DotPulsar_Abstractions_ISchema__0__" data-uid="DotPulsar.ReaderOptions`1.#ctor(DotPulsar.MessageId,System.String,DotPulsar.Abstractions.ISchema{`0})"> |
| ReaderOptions(MessageId, string, ISchema<TMessage>) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L37"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Initializes a new instance using the specified startMessageId and topic.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ReaderOptions(MessageId startMessageId, string topic, ISchema<TMessage> schema)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>startMessageId</code> <a class="xref" href="DotPulsar.MessageId.html">MessageId</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>schema</code> <a class="xref" href="DotPulsar.Abstractions.ISchema-1.html">ISchema</a><TMessage></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="fields">Fields |
| </h2> |
| |
| |
| |
| <h3 id="DotPulsar_ReaderOptions_1_DefaultMessagePrefetchCount" data-uid="DotPulsar.ReaderOptions`1.DefaultMessagePrefetchCount"> |
| DefaultMessagePrefetchCount |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L27"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The default message prefetch count.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly uint DefaultMessagePrefetchCount</code></pre> |
| </div> |
| |
| |
| |
| |
| <h4 class="section">Field Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 id="DotPulsar_ReaderOptions_1_DefaultReadCompacted" data-uid="DotPulsar.ReaderOptions`1.DefaultReadCompacted"> |
| DefaultReadCompacted |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L32"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The default of whether to read compacted.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly bool DefaultReadCompacted</code></pre> |
| </div> |
| |
| |
| |
| |
| <h4 class="section">Field Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="properties">Properties |
| </h2> |
| |
| |
| <a id="DotPulsar_ReaderOptions_1_MessagePrefetchCount_" data-uid="DotPulsar.ReaderOptions`1.MessagePrefetchCount*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_MessagePrefetchCount" data-uid="DotPulsar.ReaderOptions`1.MessagePrefetchCount"> |
| MessagePrefetchCount |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L49"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Number of messages that will be prefetched. The default is 1000.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public uint MessagePrefetchCount { get; set; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_ReaderOptions_1_ReadCompacted_" data-uid="DotPulsar.ReaderOptions`1.ReadCompacted*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_ReadCompacted" data-uid="DotPulsar.ReaderOptions`1.ReadCompacted"> |
| ReadCompacted |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L54"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Whether to read from the compacted topic. The default is 'false'.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool ReadCompacted { get; set; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_ReaderOptions_1_ReaderName_" data-uid="DotPulsar.ReaderOptions`1.ReaderName*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_ReaderName" data-uid="DotPulsar.ReaderOptions`1.ReaderName"> |
| ReaderName |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L59"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Set the reader name. This is optional.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string? ReaderName { get; set; }</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_ReaderOptions_1_Schema_" data-uid="DotPulsar.ReaderOptions`1.Schema*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_Schema" data-uid="DotPulsar.ReaderOptions`1.Schema"> |
| Schema |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L64"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Set the schema. This is required.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ISchema<TMessage> Schema { get; set; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="DotPulsar.Abstractions.ISchema-1.html">ISchema</a><TMessage></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_ReaderOptions_1_StartMessageId_" data-uid="DotPulsar.ReaderOptions`1.StartMessageId*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_StartMessageId" data-uid="DotPulsar.ReaderOptions`1.StartMessageId"> |
| StartMessageId |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L69"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>The initial reader position is set to the specified message id. This is required.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public MessageId StartMessageId { get; set; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="DotPulsar.MessageId.html">MessageId</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_ReaderOptions_1_StateChangedHandler_" data-uid="DotPulsar.ReaderOptions`1.StateChangedHandler*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_StateChangedHandler" data-uid="DotPulsar.ReaderOptions`1.StateChangedHandler"> |
| StateChangedHandler |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L74"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Register a state changed handler. This is optional.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IHandleStateChanged<ReaderStateChanged>? StateChangedHandler { get; set; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="DotPulsar.Abstractions.IHandleStateChanged-1.html">IHandleStateChanged</a><<a class="xref" href="DotPulsar.ReaderStateChanged.html">ReaderStateChanged</a>></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_ReaderOptions_1_Topic_" data-uid="DotPulsar.ReaderOptions`1.Topic*"></a> |
| |
| <h3 id="DotPulsar_ReaderOptions_1_Topic" data-uid="DotPulsar.ReaderOptions`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/ReaderOptions.cs/#L79"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Set the topic for this reader. This is required.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string Topic { get; set; }</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| <div class="contribution d-print-none"> |
| <a href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/ReaderOptions.cs/#L22" 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> |