Google Git
Sign in
apache / pulsar-dotpulsar / 4df0803d2580a8fc518f5166933f76ad33a7d8d3 / . / api / DotPulsar.ProducerOptions-1.html
blob: 023d54ce0ddee3cbd625bd2dd6c681c8f6a8d8d0 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ProducerOptions&lt;TMessage&gt; | Official DotPulsar Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ProducerOptions&lt;TMessage&gt; | Official DotPulsar Documentation ">
<meta name="description" content="The producer 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.2.1/apiSpec/new?filename=DotPulsar_ProducerOptions_1.md&amp;value=---%0Auid%3A%20DotPulsar.ProducerOptions%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.ProducerOptions`1">
<h1 id="DotPulsar_ProducerOptions_1" data-uid="DotPulsar.ProducerOptions`1" class="text-break">
Class ProducerOptions&lt;TMessage&gt; <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.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 producer building options.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class ProducerOptions&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">ProducerOptions&lt;TMessage&gt;</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&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_ProducerOptions_1__ctor_" data-uid="DotPulsar.ProducerOptions`1.#ctor*"></a>
<h3 id="DotPulsar_ProducerOptions_1__ctor_System_String_DotPulsar_Abstractions_ISchema__0__" data-uid="DotPulsar.ProducerOptions`1.#ctor(System.String,DotPulsar.Abstractions.ISchema{`0})">
ProducerOptions(string, ISchema&lt;TMessage&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L42"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance using the specified topic.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ProducerOptions(string topic, ISchema&lt;TMessage&gt; schema)</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>
<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="fields">Fields
</h2>
<h3 id="DotPulsar_ProducerOptions_1_DefaultCompressionType" data-uid="DotPulsar.ProducerOptions`1.DefaultCompressionType">
DefaultCompressionType
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L27"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The default compression type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly CompressionType DefaultCompressionType</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.CompressionType.html">CompressionType</a></dt>
<dd></dd>
</dl>
<h3 id="DotPulsar_ProducerOptions_1_DefaultInitialSequenceId" data-uid="DotPulsar.ProducerOptions`1.DefaultInitialSequenceId">
DefaultInitialSequenceId
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L32"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The default initial sequence id.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly ulong DefaultInitialSequenceId</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint64">ulong</a></dt>
<dd></dd>
</dl>
<h3 id="DotPulsar_ProducerOptions_1_DefaultProducerAccessMode" data-uid="DotPulsar.ProducerOptions`1.DefaultProducerAccessMode">
DefaultProducerAccessMode
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L37"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The default producer access mode.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly ProducerAccessMode DefaultProducerAccessMode</code></pre>
</div>
<h4 class="section">Field Value</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.ProducerAccessMode.html">ProducerAccessMode</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="DotPulsar_ProducerOptions_1_AttachTraceInfoToMessages_" data-uid="DotPulsar.ProducerOptions`1.AttachTraceInfoToMessages*"></a>
<h3 id="DotPulsar_ProducerOptions_1_AttachTraceInfoToMessages" data-uid="DotPulsar.ProducerOptions`1.AttachTraceInfoToMessages">
AttachTraceInfoToMessages
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L56"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Whether to attach the sending trace's parent and state to the outgoing messages metadata. The default is 'false'.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool AttachTraceInfoToMessages { 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_ProducerOptions_1_CompressionType_" data-uid="DotPulsar.ProducerOptions`1.CompressionType*"></a>
<h3 id="DotPulsar_ProducerOptions_1_CompressionType" data-uid="DotPulsar.ProducerOptions`1.CompressionType">
CompressionType
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L61"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the compression type. The default is 'None'.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CompressionType CompressionType { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.CompressionType.html">CompressionType</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_ProducerOptions_1_InitialSequenceId_" data-uid="DotPulsar.ProducerOptions`1.InitialSequenceId*"></a>
<h3 id="DotPulsar_ProducerOptions_1_InitialSequenceId" data-uid="DotPulsar.ProducerOptions`1.InitialSequenceId">
InitialSequenceId
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L66"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the initial sequence id. The default is 0.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ulong InitialSequenceId { 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.uint64">ulong</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_ProducerOptions_1_MaxPendingMessages_" data-uid="DotPulsar.ProducerOptions`1.MaxPendingMessages*"></a>
<h3 id="DotPulsar_ProducerOptions_1_MaxPendingMessages" data-uid="DotPulsar.ProducerOptions`1.MaxPendingMessages">
MaxPendingMessages
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L101"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public uint MaxPendingMessages { 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_ProducerOptions_1_MessageRouter_" data-uid="DotPulsar.ProducerOptions`1.MessageRouter*"></a>
<h3 id="DotPulsar_ProducerOptions_1_MessageRouter" data-uid="DotPulsar.ProducerOptions`1.MessageRouter">
MessageRouter
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L96"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the message router. The default router is the Round Robin partition router.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IMessageRouter MessageRouter { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IMessageRouter.html">IMessageRouter</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_ProducerOptions_1_ProducerAccessMode_" data-uid="DotPulsar.ProducerOptions`1.ProducerAccessMode*"></a>
<h3 id="DotPulsar_ProducerOptions_1_ProducerAccessMode" data-uid="DotPulsar.ProducerOptions`1.ProducerAccessMode">
ProducerAccessMode
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L71"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the producer access mode. The default is 'Shared'</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ProducerAccessMode ProducerAccessMode { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.ProducerAccessMode.html">ProducerAccessMode</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_ProducerOptions_1_ProducerName_" data-uid="DotPulsar.ProducerOptions`1.ProducerName*"></a>
<h3 id="DotPulsar_ProducerOptions_1_ProducerName" data-uid="DotPulsar.ProducerOptions`1.ProducerName">
ProducerName
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L76"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the producer name. This is optional.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string? ProducerName { 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_ProducerOptions_1_Schema_" data-uid="DotPulsar.ProducerOptions`1.Schema*"></a>
<h3 id="DotPulsar_ProducerOptions_1_Schema" data-uid="DotPulsar.ProducerOptions`1.Schema">
Schema
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L81"><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&lt;TMessage&gt; 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>&lt;TMessage&gt;</dt>
<dd></dd>
</dl>
<a id="DotPulsar_ProducerOptions_1_StateChangedHandler_" data-uid="DotPulsar.ProducerOptions`1.StateChangedHandler*"></a>
<h3 id="DotPulsar_ProducerOptions_1_StateChangedHandler" data-uid="DotPulsar.ProducerOptions`1.StateChangedHandler">
StateChangedHandler
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L86"><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&lt;ProducerStateChanged&gt;? 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>&lt;<a class="xref" href="DotPulsar.ProducerStateChanged.html">ProducerStateChanged</a>&gt;</dt>
<dd></dd>
</dl>
<a id="DotPulsar_ProducerOptions_1_Topic_" data-uid="DotPulsar.ProducerOptions`1.Topic*"></a>
<h3 id="DotPulsar_ProducerOptions_1_Topic" data-uid="DotPulsar.ProducerOptions`1.Topic">
Topic
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1/src/DotPulsar/ProducerOptions.cs/#L91"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the topic for this producer. 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.2.1/src/DotPulsar/ProducerOptions.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 &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>