Google Git
Sign in
apache / pulsar-dotpulsar / refs/heads/gh-pages / . / api / DotPulsar.Internal.PulsarClientBuilder.html
blob: d46ef552667841d47cd8e6793daf6a37142d7b0a [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class PulsarClientBuilder | Official DotPulsar Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PulsarClientBuilder | 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_PulsarClientBuilder.md&amp;value=---%0Auid%3A%20DotPulsar.Internal.PulsarClientBuilder%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.PulsarClientBuilder">
<h1 id="DotPulsar_Internal_PulsarClientBuilder" data-uid="DotPulsar.Internal.PulsarClientBuilder" class="text-break">
Class PulsarClientBuilder <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.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>.<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 PulsarClientBuilder : IPulsarClientBuilder</code></pre>
</div>
<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">PulsarClientBuilder</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="DotPulsar.Extensions.PulsarClientBuilderExtensions.html#DotPulsar_Extensions_PulsarClientBuilderExtensions_ExceptionHandler_DotPulsar_Abstractions_IPulsarClientBuilder_System_Action_DotPulsar_ExceptionContext__">PulsarClientBuilderExtensions.ExceptionHandler(IPulsarClientBuilder, Action&lt;ExceptionContext&gt;)</a>
</div>
<div>
<a class="xref" href="DotPulsar.Extensions.PulsarClientBuilderExtensions.html#DotPulsar_Extensions_PulsarClientBuilderExtensions_ExceptionHandler_DotPulsar_Abstractions_IPulsarClientBuilder_System_Func_DotPulsar_ExceptionContext_System_Threading_Tasks_ValueTask__">PulsarClientBuilderExtensions.ExceptionHandler(IPulsarClientBuilder, Func&lt;ExceptionContext, ValueTask&gt;)</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_PulsarClientBuilder__ctor_" data-uid="DotPulsar.Internal.PulsarClientBuilder.#ctor*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder__ctor" data-uid="DotPulsar.Internal.PulsarClientBuilder.#ctor">
PulsarClientBuilder()
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L39"><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 PulsarClientBuilder()</code></pre>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="DotPulsar_Internal_PulsarClientBuilder_AuthenticateUsingClientCertificate_" data-uid="DotPulsar.Internal.PulsarClientBuilder.AuthenticateUsingClientCertificate*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_AuthenticateUsingClientCertificate_System_Security_Cryptography_X509Certificates_X509Certificate2_" data-uid="DotPulsar.Internal.PulsarClientBuilder.AuthenticateUsingClientCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
AuthenticateUsingClientCertificate(X509Certificate2)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L62"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Authenticate using a client certificate. This is optional.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder AuthenticateUsingClientCertificate(X509Certificate2 clientCertificate)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>clientCertificate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.x509certificate2">X509Certificate2</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_Authentication_" data-uid="DotPulsar.Internal.PulsarClientBuilder.Authentication*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_Authentication_DotPulsar_Abstractions_IAuthentication_" data-uid="DotPulsar.Internal.PulsarClientBuilder.Authentication(DotPulsar.Abstractions.IAuthentication)">
Authentication(IAuthentication)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L69"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the authentication provider. This is optional.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder Authentication(IAuthentication authentication)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>authentication</code> <a class="xref" href="DotPulsar.Abstractions.IAuthentication.html">IAuthentication</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_Build_" data-uid="DotPulsar.Internal.PulsarClientBuilder.Build*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_Build" data-uid="DotPulsar.Internal.PulsarClientBuilder.Build">
Build()
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L141"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Create the client.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClient Build()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClient.html">IPulsarClient</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_CheckCertificateRevocation_" data-uid="DotPulsar.Internal.PulsarClientBuilder.CheckCertificateRevocation*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_CheckCertificateRevocation_System_Boolean_" data-uid="DotPulsar.Internal.PulsarClientBuilder.CheckCertificateRevocation(System.Boolean)">
CheckCertificateRevocation(bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L75"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Specifies whether the certificate revocation list is checked during authentication. The default is 'true'.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder CheckCertificateRevocation(bool checkCertificateRevocation)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>checkCertificateRevocation</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.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_CloseInactiveConnectionsInterval_" data-uid="DotPulsar.Internal.PulsarClientBuilder.CloseInactiveConnectionsInterval*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_CloseInactiveConnectionsInterval_System_TimeSpan_" data-uid="DotPulsar.Internal.PulsarClientBuilder.CloseInactiveConnectionsInterval(System.TimeSpan)">
CloseInactiveConnectionsInterval(TimeSpan)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L135"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The time to wait before closing inactive connections. The default is 60 seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder CloseInactiveConnectionsInterval(TimeSpan interval)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>interval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_ConnectionSecurity_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ConnectionSecurity*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_ConnectionSecurity_DotPulsar_EncryptionPolicy_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ConnectionSecurity(DotPulsar.EncryptionPolicy)">
ConnectionSecurity(EncryptionPolicy)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L81"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set connection encryption policy. The default is 'EnforceUnencrypted' if the ServiceUrl scheme is 'pulsar' and 'EnforceEncrypted' if it's 'pulsar+ssl'.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder ConnectionSecurity(EncryptionPolicy encryptionPolicy)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>encryptionPolicy</code> <a class="xref" href="DotPulsar.EncryptionPolicy.html">EncryptionPolicy</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_ExceptionHandler_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ExceptionHandler*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_ExceptionHandler_DotPulsar_Abstractions_IHandleException_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ExceptionHandler(DotPulsar.Abstractions.IHandleException)">
ExceptionHandler(IHandleException)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L87"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Register a custom exception handler that will be invoked before the default exception handler.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder ExceptionHandler(IHandleException exceptionHandler)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>exceptionHandler</code> <a class="xref" href="DotPulsar.Abstractions.IHandleException.html">IHandleException</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_KeepAliveInterval_" data-uid="DotPulsar.Internal.PulsarClientBuilder.KeepAliveInterval*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_KeepAliveInterval_System_TimeSpan_" data-uid="DotPulsar.Internal.PulsarClientBuilder.KeepAliveInterval(System.TimeSpan)">
KeepAliveInterval(TimeSpan)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L93"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The time to wait before sending a 'ping' if there has been no activity on the connection. The default is 30 seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder KeepAliveInterval(TimeSpan interval)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>interval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_ListenerName_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ListenerName*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_ListenerName_System_String_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ListenerName(System.String)">
ListenerName(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L99"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Set the listener name. This is optional.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder ListenerName(string listenerName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>listenerName</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.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_RetryInterval_" data-uid="DotPulsar.Internal.PulsarClientBuilder.RetryInterval*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_RetryInterval_System_TimeSpan_" data-uid="DotPulsar.Internal.PulsarClientBuilder.RetryInterval(System.TimeSpan)">
RetryInterval(TimeSpan)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L105"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The time to wait before retrying an operation or a reconnect. The default is 3 seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder RetryInterval(TimeSpan interval)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>interval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_ServiceUrl_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ServiceUrl*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_ServiceUrl_System_Uri_" data-uid="DotPulsar.Internal.PulsarClientBuilder.ServiceUrl(System.Uri)">
ServiceUrl(Uri)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L111"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>The service URL for the Pulsar cluster. The default is &quot;pulsar://localhost:6650&quot;.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder ServiceUrl(Uri uri)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>uri</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uri">Uri</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_TrustedCertificateAuthority_" data-uid="DotPulsar.Internal.PulsarClientBuilder.TrustedCertificateAuthority*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_TrustedCertificateAuthority_System_Security_Cryptography_X509Certificates_X509Certificate2_" data-uid="DotPulsar.Internal.PulsarClientBuilder.TrustedCertificateAuthority(System.Security.Cryptography.X509Certificates.X509Certificate2)">
TrustedCertificateAuthority(X509Certificate2)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L117"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Add a trusted certificate authority. This is optional.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder TrustedCertificateAuthority(X509Certificate2 trustedCertificateAuthority)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>trustedCertificateAuthority</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.x509certificate2">X509Certificate2</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="DotPulsar.Abstractions.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_VerifyCertificateAuthority_" data-uid="DotPulsar.Internal.PulsarClientBuilder.VerifyCertificateAuthority*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_VerifyCertificateAuthority_System_Boolean_" data-uid="DotPulsar.Internal.PulsarClientBuilder.VerifyCertificateAuthority(System.Boolean)">
VerifyCertificateAuthority(bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L123"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Verify the certificate authority. The default is 'true'.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder VerifyCertificateAuthority(bool verifyCertificateAuthority)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>verifyCertificateAuthority</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.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
<a id="DotPulsar_Internal_PulsarClientBuilder_VerifyCertificateName_" data-uid="DotPulsar.Internal.PulsarClientBuilder.VerifyCertificateName*"></a>
<h3 id="DotPulsar_Internal_PulsarClientBuilder_VerifyCertificateName_System_Boolean_" data-uid="DotPulsar.Internal.PulsarClientBuilder.VerifyCertificateName(System.Boolean)">
VerifyCertificateName(bool)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.cs/#L129"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Verify the certificate name with the hostname. The default is 'false'.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPulsarClientBuilder VerifyCertificateName(bool verifyCertificateName)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>verifyCertificateName</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.IPulsarClientBuilder.html">IPulsarClientBuilder</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/apache/pulsar-dotpulsar/blob/3.3.1/src/DotPulsar/Internal/PulsarClientBuilder.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>