| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title>Interface IReader<TMessage> | Official DotPulsar Documentation </title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="title" content="Interface IReader<TMessage> | Official DotPulsar Documentation "> |
| |
| <meta name="description" content="A generic reader abstraction."> |
| <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.2.1/apiSpec/new?filename=DotPulsar_Abstractions_IReader_1.md&value=---%0Auid%3A%20DotPulsar.Abstractions.IReader%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.Abstractions.IReader`1"> |
| |
| |
| |
| <h1 id="DotPulsar_Abstractions_IReader_1" data-uid="DotPulsar.Abstractions.IReader`1" class="text-break"> |
| Interface IReader<TMessage> <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/Abstractions/IReaderOfT.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.Abstractions.html">Abstractions</a></dd></dl> |
| <dl><dt>Assembly</dt><dd>DotPulsar.dll</dd></dl> |
| </div> |
| |
| <div class="markdown summary"><p>A generic reader abstraction.</p> |
| </div> |
| <div class="markdown conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface IReader<TMessage> : IReader, IGetLastMessageIds, ISeek, IState<ReaderState>, IAsyncDisposable, IReceive<IMessage<TMessage>></code></pre> |
| </div> |
| |
| |
| |
| <h4 class="section">Type Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>TMessage</code></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| <dl class="typelist inheritedMembers"> |
| <dt>Inherited Members</dt> |
| <dd> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IReader.html#DotPulsar_Abstractions_IReader_ServiceUrl">IReader.ServiceUrl</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IReader.html#DotPulsar_Abstractions_IReader_Topic">IReader.Topic</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IGetLastMessageIds.html#DotPulsar_Abstractions_IGetLastMessageIds_GetLastMessageIds_System_Threading_CancellationToken_">IGetLastMessageIds.GetLastMessageIds(CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.ISeek.html#DotPulsar_Abstractions_ISeek_Seek_DotPulsar_MessageId_System_Threading_CancellationToken_">ISeek.Seek(MessageId, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.ISeek.html#DotPulsar_Abstractions_ISeek_Seek_System_UInt64_System_Threading_CancellationToken_">ISeek.Seek(ulong, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IState-1.html#DotPulsar_Abstractions_IState_1_IsFinalState">IState<ReaderState>.IsFinalState()</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IState-1.html#DotPulsar_Abstractions_IState_1_IsFinalState__0_">IState<ReaderState>.IsFinalState(ReaderState)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IState-1.html#DotPulsar_Abstractions_IState_1_OnStateChangeTo__0_System_Threading_CancellationToken_">IState<ReaderState>.OnStateChangeTo(ReaderState, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IState-1.html#DotPulsar_Abstractions_IState_1_OnStateChangeFrom__0_System_Threading_CancellationToken_">IState<ReaderState>.OnStateChangeFrom(ReaderState, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iasyncdisposable.disposeasync">IAsyncDisposable.DisposeAsync()</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Abstractions.IReceive-1.html#DotPulsar_Abstractions_IReceive_1_Receive_System_Threading_CancellationToken_">IReceive<IMessage<TMessage>>.Receive(CancellationToken)</a> |
| </div> |
| </dd></dl> |
| |
| <dl class="typelist extensionMethods"> |
| <dt>Extension Methods</dt> |
| <dd> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ReaderExtensions.html#DotPulsar_Extensions_ReaderExtensions_StateChangedFrom_DotPulsar_Abstractions_IReader_DotPulsar_ReaderState_System_Threading_CancellationToken_">ReaderExtensions.StateChangedFrom(IReader, ReaderState, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ReaderExtensions.html#DotPulsar_Extensions_ReaderExtensions_StateChangedFrom_DotPulsar_Abstractions_IReader_DotPulsar_ReaderState_System_TimeSpan_System_Threading_CancellationToken_">ReaderExtensions.StateChangedFrom(IReader, ReaderState, TimeSpan, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ReaderExtensions.html#DotPulsar_Extensions_ReaderExtensions_StateChangedTo_DotPulsar_Abstractions_IReader_DotPulsar_ReaderState_System_Threading_CancellationToken_">ReaderExtensions.StateChangedTo(IReader, ReaderState, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.ReaderExtensions.html#DotPulsar_Extensions_ReaderExtensions_StateChangedTo_DotPulsar_Abstractions_IReader_DotPulsar_ReaderState_System_TimeSpan_System_Threading_CancellationToken_">ReaderExtensions.StateChangedTo(IReader, ReaderState, 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> |
| <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> |
| </dd></dl> |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| <div class="contribution d-print-none"> |
| <a href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/Abstractions/IReaderOfT.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> |
