api/DotPulsar.Internal.ReaderBuilder-1.html - pulsar-dotpulsar - Git at Google

 <!DOCTYPE html>
 <html>
   <head>
     <meta charset="utf-8">
       <title>Class ReaderBuilder&lt;TMessage&gt; | Official DotPulsar Documentation </title>
       <meta name="viewport" content="width=device-width, initial-scale=1.0">
       <meta name="title" content="Class ReaderBuilder&lt;TMessage&gt; | 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_ReaderBuilder_1.md&amp;value=---%0Auid%3A%20DotPulsar.Internal.ReaderBuilder%601%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">
       <meta name="loc:inThisArticle" content="In this article">
       <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
       <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
       <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.ReaderBuilder`1">


   <h1 id="DotPulsar_Internal_ReaderBuilder_1" data-uid="DotPulsar.Internal.ReaderBuilder`1" class="text-break">
 Class ReaderBuilder&lt;TMessage&gt;  <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L20"><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 ReaderBuilder&lt;TMessage&gt; : IReaderBuilder&lt;TMessage&gt;</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">ReaderBuilder&lt;TMessage&gt;</span></div>
     </dd>
   </dl>

   <dl class="typelist implements">
     <dt>Implements</dt>
     <dd>
       <div><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</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.ReaderBuilderExtensions.html#DotPulsar_Extensions_ReaderBuilderExtensions_StateChangedHandler__1_DotPulsar_Abstractions_IReaderBuilder___0__System_Action_DotPulsar_ReaderStateChanged_System_Threading_CancellationToken__System_Threading_CancellationToken_">ReaderBuilderExtensions.StateChangedHandler&lt;TMessage&gt;(IReaderBuilder&lt;TMessage&gt;, Action&lt;ReaderStateChanged, CancellationToken&gt;, CancellationToken)</a>
   </div>
   <div>
       <a class="xref" href="DotPulsar.Extensions.ReaderBuilderExtensions.html#DotPulsar_Extensions_ReaderBuilderExtensions_StateChangedHandler__1_DotPulsar_Abstractions_IReaderBuilder___0__System_Action_DotPulsar_ReaderStateChanged__">ReaderBuilderExtensions.StateChangedHandler&lt;TMessage&gt;(IReaderBuilder&lt;TMessage&gt;, Action&lt;ReaderStateChanged&gt;)</a>
   </div>
   <div>
       <a class="xref" href="DotPulsar.Extensions.ReaderBuilderExtensions.html#DotPulsar_Extensions_ReaderBuilderExtensions_StateChangedHandler__1_DotPulsar_Abstractions_IReaderBuilder___0__System_Func_DotPulsar_ReaderStateChanged_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">ReaderBuilderExtensions.StateChangedHandler&lt;TMessage&gt;(IReaderBuilder&lt;TMessage&gt;, Func&lt;ReaderStateChanged, CancellationToken, ValueTask&gt;, 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&lt;TEntity, TState&gt;(TEntity, TState, TimeSpan, Action&lt;TEntity, TState&gt;, Action&lt;TEntity, TState&gt;, 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&lt;TEntity, TState&gt;(TEntity, TState, TimeSpan, Func&lt;TEntity, TState, CancellationToken, ValueTask&gt;, Func&lt;TEntity, TState, CancellationToken, ValueTask&gt;, 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&lt;TEntity, TState, TFaultContext&gt;(TEntity, TState, TimeSpan, Func&lt;TEntity, TState, CancellationToken, ValueTask&lt;TFaultContext&gt;&gt;, Func&lt;TEntity, TState, TFaultContext, CancellationToken, ValueTask&gt;, CancellationToken)</a>
   </div>
   </dd></dl>


   <h2 class="section" id="constructors">Constructors
 </h2>


   <a id="DotPulsar_Internal_ReaderBuilder_1__ctor_" data-uid="DotPulsar.Internal.ReaderBuilder`1.#ctor*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1__ctor_DotPulsar_Abstractions_IPulsarClient_DotPulsar_Abstractions_ISchema__0__" data-uid="DotPulsar.Internal.ReaderBuilder`1.#ctor(DotPulsar.Abstractions.IPulsarClient,DotPulsar.Abstractions.ISchema{`0})">
   ReaderBuilder(IPulsarClient, ISchema&lt;TMessage&gt;)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L31"><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 ReaderBuilder(IPulsarClient pulsarClient, ISchema&lt;TMessage&gt; schema)</code></pre>
   </div>

   <h4 class="section">Parameters</h4>
   <dl class="parameters">
     <dt><code>pulsarClient</code> <a class="xref" href="DotPulsar.Abstractions.IPulsarClient.html">IPulsarClient</a></dt>
     <dd></dd>
     <dt><code>schema</code> <a class="xref" href="DotPulsar.Abstractions.ISchema-1.html">ISchema</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <h2 class="section" id="methods">Methods
 </h2>


   <a id="DotPulsar_Internal_ReaderBuilder_1_Create_" data-uid="DotPulsar.Internal.ReaderBuilder`1.Create*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_Create" data-uid="DotPulsar.Internal.ReaderBuilder`1.Create">
   Create()
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L75"><i class="bi bi-code-slash"></i></a>
   </h3>

   <div class="markdown level1 summary"><p>Create the reader.</p>
 </div>
   <div class="markdown level1 conceptual"></div>

   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public IReader&lt;TMessage&gt; Create()</code></pre>
   </div>


   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReader-1.html">IReader</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <a id="DotPulsar_Internal_ReaderBuilder_1_MessagePrefetchCount_" data-uid="DotPulsar.Internal.ReaderBuilder`1.MessagePrefetchCount*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_MessagePrefetchCount_System_UInt32_" data-uid="DotPulsar.Internal.ReaderBuilder`1.MessagePrefetchCount(System.UInt32)">
   MessagePrefetchCount(uint)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L39"><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 IReaderBuilder&lt;TMessage&gt; MessagePrefetchCount(uint count)</code></pre>
   </div>

   <h4 class="section">Parameters</h4>
   <dl class="parameters">
     <dt><code>count</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></dt>
     <dd></dd>
   </dl>

   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <a id="DotPulsar_Internal_ReaderBuilder_1_ReadCompacted_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReadCompacted*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_ReadCompacted_System_Boolean_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReadCompacted(System.Boolean)">
   ReadCompacted(bool)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L45"><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 IReaderBuilder&lt;TMessage&gt; ReadCompacted(bool readCompacted)</code></pre>
   </div>

   <h4 class="section">Parameters</h4>
   <dl class="parameters">
     <dt><code>readCompacted</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
     <dd></dd>
   </dl>

   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <a id="DotPulsar_Internal_ReaderBuilder_1_ReaderName_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReaderName*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_ReaderName_System_String_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReaderName(System.String)">
   ReaderName(string)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L51"><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 IReaderBuilder&lt;TMessage&gt; ReaderName(string name)</code></pre>
   </div>

   <h4 class="section">Parameters</h4>
   <dl class="parameters">
     <dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
     <dd></dd>
   </dl>

   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <a id="DotPulsar_Internal_ReaderBuilder_1_StartMessageId_" data-uid="DotPulsar.Internal.ReaderBuilder`1.StartMessageId*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_StartMessageId_DotPulsar_MessageId_" data-uid="DotPulsar.Internal.ReaderBuilder`1.StartMessageId(DotPulsar.MessageId)">
   StartMessageId(MessageId)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L57"><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 IReaderBuilder&lt;TMessage&gt; StartMessageId(MessageId messageId)</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>
   </dl>

   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <a id="DotPulsar_Internal_ReaderBuilder_1_StateChangedHandler_" data-uid="DotPulsar.Internal.ReaderBuilder`1.StateChangedHandler*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_StateChangedHandler_DotPulsar_Abstractions_IHandleStateChanged_DotPulsar_ReaderStateChanged__" data-uid="DotPulsar.Internal.ReaderBuilder`1.StateChangedHandler(DotPulsar.Abstractions.IHandleStateChanged{DotPulsar.ReaderStateChanged})">
   StateChangedHandler(IHandleStateChanged&lt;ReaderStateChanged&gt;)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L63"><i class="bi bi-code-slash"></i></a>
   </h3>

   <div class="markdown level1 summary"><p>Register a state changed handler.</p>
 </div>
   <div class="markdown level1 conceptual"></div>

   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public IReaderBuilder&lt;TMessage&gt; StateChangedHandler(IHandleStateChanged&lt;ReaderStateChanged&gt; handler)</code></pre>
   </div>

   <h4 class="section">Parameters</h4>
   <dl class="parameters">
     <dt><code>handler</code> <a class="xref" href="DotPulsar.Abstractions.IHandleStateChanged-1.html">IHandleStateChanged</a>&lt;<a class="xref" href="DotPulsar.ReaderStateChanged.html">ReaderStateChanged</a>&gt;</dt>
     <dd></dd>
   </dl>

   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</dt>
     <dd></dd>
   </dl>


   <a id="DotPulsar_Internal_ReaderBuilder_1_Topic_" data-uid="DotPulsar.Internal.ReaderBuilder`1.Topic*"></a>

   <h3 id="DotPulsar_Internal_ReaderBuilder_1_Topic_System_String_" data-uid="DotPulsar.Internal.ReaderBuilder`1.Topic(System.String)">
   Topic(string)
   <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L69"><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 IReaderBuilder&lt;TMessage&gt; Topic(string topic)</code></pre>
   </div>

   <h4 class="section">Parameters</h4>
   <dl class="parameters">
     <dt><code>topic</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
     <dd></dd>
   </dl>

   <h4 class="section">Returns</h4>
   <dl class="parameters">
     <dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a>&lt;TMessage&gt;</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/ReaderBuilder.cs/#L20" 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 &copy; 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>
	<!DOCTYPE html>
	<html>
	<head>
	<meta charset="utf-8">
	<title>Class ReaderBuilder<TMessage> \| Official DotPulsar Documentation </title>
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<meta name="title" content="Class ReaderBuilder<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_ReaderBuilder_1.md&value=---%0Auid%3A%20DotPulsar.Internal.ReaderBuilder%601%0Asummary%3A%20'You%20can%20override%20summary%20for%20the%20API%20here%20using%20MARKDOWN%20syntax'%0A---%0A%0APlease%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.ReaderBuilder`1">



	<h1 id="DotPulsar_Internal_ReaderBuilder_1" data-uid="DotPulsar.Internal.ReaderBuilder`1" class="text-break">
	Class ReaderBuilder<TMessage> <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L20"><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 ReaderBuilder<TMessage> : IReaderBuilder<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">ReaderBuilder<TMessage></span></div>
	</dd>
	</dl>

	<dl class="typelist implements">
	<dt>Implements</dt>
	<dd>
	<div><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></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.ReaderBuilderExtensions.html#DotPulsar_Extensions_ReaderBuilderExtensions_StateChangedHandler__1_DotPulsar_Abstractions_IReaderBuilder___0__System_Action_DotPulsar_ReaderStateChanged_System_Threading_CancellationToken__System_Threading_CancellationToken_">ReaderBuilderExtensions.StateChangedHandler<TMessage>(IReaderBuilder<TMessage>, Action<ReaderStateChanged, CancellationToken>, CancellationToken)</a>
	</div>
	<div>
	<a class="xref" href="DotPulsar.Extensions.ReaderBuilderExtensions.html#DotPulsar_Extensions_ReaderBuilderExtensions_StateChangedHandler__1_DotPulsar_Abstractions_IReaderBuilder___0__System_Action_DotPulsar_ReaderStateChanged__">ReaderBuilderExtensions.StateChangedHandler<TMessage>(IReaderBuilder<TMessage>, Action<ReaderStateChanged>)</a>
	</div>
	<div>
	<a class="xref" href="DotPulsar.Extensions.ReaderBuilderExtensions.html#DotPulsar_Extensions_ReaderBuilderExtensions_StateChangedHandler__1_DotPulsar_Abstractions_IReaderBuilder___0__System_Func_DotPulsar_ReaderStateChanged_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">ReaderBuilderExtensions.StateChangedHandler<TMessage>(IReaderBuilder<TMessage>, Func<ReaderStateChanged, CancellationToken, ValueTask>, 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_ReaderBuilder_1__ctor_" data-uid="DotPulsar.Internal.ReaderBuilder`1.#ctor*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1__ctor_DotPulsar_Abstractions_IPulsarClient_DotPulsar_Abstractions_ISchema__0__" data-uid="DotPulsar.Internal.ReaderBuilder`1.#ctor(DotPulsar.Abstractions.IPulsarClient,DotPulsar.Abstractions.ISchema{`0})">
	ReaderBuilder(IPulsarClient, ISchema<TMessage>)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L31"><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 ReaderBuilder(IPulsarClient pulsarClient, ISchema<TMessage> schema)</code></pre>
	</div>

	<h4 class="section">Parameters</h4>
	<dl class="parameters">
	<dt><code>pulsarClient</code> <a class="xref" href="DotPulsar.Abstractions.IPulsarClient.html">IPulsarClient</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="methods">Methods
	</h2>


	<a id="DotPulsar_Internal_ReaderBuilder_1_Create_" data-uid="DotPulsar.Internal.ReaderBuilder`1.Create*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_Create" data-uid="DotPulsar.Internal.ReaderBuilder`1.Create">
	Create()
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L75"><i class="bi bi-code-slash"></i></a>
	</h3>

	<div class="markdown level1 summary"><p>Create the reader.</p>
	</div>
	<div class="markdown level1 conceptual"></div>

	<div class="codewrapper">
	<pre><code class="lang-csharp hljs">public IReader<TMessage> Create()</code></pre>
	</div>


	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReader-1.html">IReader</a><TMessage></dt>
	<dd></dd>
	</dl>











	<a id="DotPulsar_Internal_ReaderBuilder_1_MessagePrefetchCount_" data-uid="DotPulsar.Internal.ReaderBuilder`1.MessagePrefetchCount*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_MessagePrefetchCount_System_UInt32_" data-uid="DotPulsar.Internal.ReaderBuilder`1.MessagePrefetchCount(System.UInt32)">
	MessagePrefetchCount(uint)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L39"><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 IReaderBuilder<TMessage> MessagePrefetchCount(uint count)</code></pre>
	</div>

	<h4 class="section">Parameters</h4>
	<dl class="parameters">
	<dt><code>count</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></dt>
	<dd></dd>
	</dl>

	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></dt>
	<dd></dd>
	</dl>











	<a id="DotPulsar_Internal_ReaderBuilder_1_ReadCompacted_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReadCompacted*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_ReadCompacted_System_Boolean_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReadCompacted(System.Boolean)">
	ReadCompacted(bool)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L45"><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 IReaderBuilder<TMessage> ReadCompacted(bool readCompacted)</code></pre>
	</div>

	<h4 class="section">Parameters</h4>
	<dl class="parameters">
	<dt><code>readCompacted</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
	<dd></dd>
	</dl>

	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></dt>
	<dd></dd>
	</dl>











	<a id="DotPulsar_Internal_ReaderBuilder_1_ReaderName_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReaderName*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_ReaderName_System_String_" data-uid="DotPulsar.Internal.ReaderBuilder`1.ReaderName(System.String)">
	ReaderName(string)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L51"><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 IReaderBuilder<TMessage> ReaderName(string name)</code></pre>
	</div>

	<h4 class="section">Parameters</h4>
	<dl class="parameters">
	<dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
	<dd></dd>
	</dl>

	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></dt>
	<dd></dd>
	</dl>











	<a id="DotPulsar_Internal_ReaderBuilder_1_StartMessageId_" data-uid="DotPulsar.Internal.ReaderBuilder`1.StartMessageId*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_StartMessageId_DotPulsar_MessageId_" data-uid="DotPulsar.Internal.ReaderBuilder`1.StartMessageId(DotPulsar.MessageId)">
	StartMessageId(MessageId)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L57"><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 IReaderBuilder<TMessage> StartMessageId(MessageId messageId)</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>
	</dl>

	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></dt>
	<dd></dd>
	</dl>











	<a id="DotPulsar_Internal_ReaderBuilder_1_StateChangedHandler_" data-uid="DotPulsar.Internal.ReaderBuilder`1.StateChangedHandler*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_StateChangedHandler_DotPulsar_Abstractions_IHandleStateChanged_DotPulsar_ReaderStateChanged__" data-uid="DotPulsar.Internal.ReaderBuilder`1.StateChangedHandler(DotPulsar.Abstractions.IHandleStateChanged{DotPulsar.ReaderStateChanged})">
	StateChangedHandler(IHandleStateChanged<ReaderStateChanged>)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L63"><i class="bi bi-code-slash"></i></a>
	</h3>

	<div class="markdown level1 summary"><p>Register a state changed handler.</p>
	</div>
	<div class="markdown level1 conceptual"></div>

	<div class="codewrapper">
	<pre><code class="lang-csharp hljs">public IReaderBuilder<TMessage> StateChangedHandler(IHandleStateChanged<ReaderStateChanged> handler)</code></pre>
	</div>

	<h4 class="section">Parameters</h4>
	<dl class="parameters">
	<dt><code>handler</code> <a class="xref" href="DotPulsar.Abstractions.IHandleStateChanged-1.html">IHandleStateChanged</a><<a class="xref" href="DotPulsar.ReaderStateChanged.html">ReaderStateChanged</a>></dt>
	<dd></dd>
	</dl>

	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></dt>
	<dd></dd>
	</dl>











	<a id="DotPulsar_Internal_ReaderBuilder_1_Topic_" data-uid="DotPulsar.Internal.ReaderBuilder`1.Topic*"></a>

	<h3 id="DotPulsar_Internal_ReaderBuilder_1_Topic_System_String_" data-uid="DotPulsar.Internal.ReaderBuilder`1.Topic(System.String)">
	Topic(string)
	<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/ReaderBuilder.cs/#L69"><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 IReaderBuilder<TMessage> Topic(string topic)</code></pre>
	</div>

	<h4 class="section">Parameters</h4>
	<dl class="parameters">
	<dt><code>topic</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
	<dd></dd>
	</dl>

	<h4 class="section">Returns</h4>
	<dl class="parameters">
	<dt><a class="xref" href="DotPulsar.Abstractions.IReaderBuilder-1.html">IReaderBuilder</a><TMessage></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/ReaderBuilder.cs/#L20" 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>