blob: 1529611858967a27100dfd08399af22f0da1ad2e [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Interface ISslStreamFactory
| Apache Ignite.NET API Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Interface ISslStreamFactory
| Apache Ignite.NET API Documentation ">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.min.css">
<link rel="stylesheet" href="../styles/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="docfx:docurl" content="https://github.com/apache/ignite-3/new/main/apiSpec/new?filename=Apache_Ignite_ISslStreamFactory.md&amp;value=---%0Auid%3A%20Apache.Ignite.ISslStreamFactory%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">
<script>
MathJax = {
options: {
processHtmlClass: ['tex2jax_process', 'math']
}
};
</script>
<script type="text/javascript" src="../styles/docfx.min.js"></script>
<script type="text/javascript" src="../styles/main.js"></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="../images/logo.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">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</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="Apache.Ignite.ISslStreamFactory">
<h1 id="Apache_Ignite_ISslStreamFactory" data-uid="Apache.Ignite.ISslStreamFactory" class="text-break">
Interface ISslStreamFactory
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/ISslStreamFactory.cs/#L29"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Apache.html">Apache</a>.<a class="xref" href="Apache.Ignite.html">Ignite</a></dd></dl>
<dl><dt>Assembly</dt><dd>Apache.Ignite.dll</dd></dl>
</div>
<div class="markdown summary"><p>SSL Stream Factory defines how SSL connection is established.</p>
<p></p>
See <a class="xref" href="Apache.Ignite.IgniteClientConfiguration.html#Apache_Ignite_IgniteClientConfiguration_SslStreamFactory">SslStreamFactory</a>, <a class="xref" href="Apache.Ignite.SslStreamFactory.html">SslStreamFactory</a>.
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface ISslStreamFactory</code></pre>
</div>
<h2 class="section" id="methods">Methods
</h2>
<a id="Apache_Ignite_ISslStreamFactory_CreateAsync_" data-uid="Apache.Ignite.ISslStreamFactory.CreateAsync*"></a>
<h3 id="Apache_Ignite_ISslStreamFactory_CreateAsync_System_IO_Stream_System_String_" data-uid="Apache.Ignite.ISslStreamFactory.CreateAsync(System.IO.Stream,System.String)">
CreateAsync(Stream, string)
<a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/ISslStreamFactory.cs/#L39"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Creates the SSL stream.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;SslStream?&gt; CreateAsync(Stream stream, string targetHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>stream</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></dt>
<dd><p>The underlying raw stream.</p>
</dd>
<dt><code>targetHost</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Target host.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.net.security.sslstream">SslStream</a>&gt;</dt>
<dd><p>SSL stream, or null if SSL is not enabled.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
<a href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/ISslStreamFactory.cs/#L29" class="edit-link">Edit this page</a>
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top">
<div class="container-xxl">
<div class="flex-fill">
Copyright 2023 The Apache Software Foundation
</div>
</div>
</footer>
</body>
</html>