363 lines
14 KiB
HTML
363 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class GrpcChannel
|
|
| gRPC for .NET </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class GrpcChannel
|
|
| gRPC for .NET ">
|
|
<meta name="generator" content="docfx 2.36.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Grpc.Net.Client.GrpcChannel">
|
|
|
|
|
|
<h1 id="Grpc_Net_Client_GrpcChannel" data-uid="Grpc.Net.Client.GrpcChannel" class="text-break">Class GrpcChannel
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents a gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
|
|
Client objects can reuse the same channel. Creating a channel is an expensive operation compared to invoking
|
|
a remote call so in general you should reuse a single channel for as many calls as possible.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">ChannelBase</span></div>
|
|
<div class="level1"><span class="xref">GrpcChannel</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">IDisposable</span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Net.Client.html">Grpc.Net.Client</a></h6>
|
|
<h6><strong>Assembly</strong>: Grpc.Net.Client.dll</h6>
|
|
<h5 id="Grpc_Net_Client_GrpcChannel_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class GrpcChannel : ChannelBase, IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<a id="Grpc_Net_Client_GrpcChannel_CreateCallInvoker_" data-uid="Grpc.Net.Client.GrpcChannel.CreateCallInvoker*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannel_CreateCallInvoker" data-uid="Grpc.Net.Client.GrpcChannel.CreateCallInvoker">CreateCallInvoker()</h4>
|
|
<div class="markdown level1 summary"><p>Create a new <see cref="!:CallInvoker"></see> for the channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override CallInvoker CreateCallInvoker()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">CallInvoker</span></td>
|
|
<td><p>A new <see cref="!:CallInvoker"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannel_Dispose_" data-uid="Grpc.Net.Client.GrpcChannel.Dispose*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannel_Dispose" data-uid="Grpc.Net.Client.GrpcChannel.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>Releases the resources used by the <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a> class.
|
|
Clients created with the channel can't be used after the channel is disposed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
<a id="Grpc_Net_Client_GrpcChannel_ForAddress_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannel_ForAddress_System_String_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress(System.String)">ForAddress(String)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a> for the specified address.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static GrpcChannel ForAddress(string address)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">address</span></td>
|
|
<td><p>The address the channel will use.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a></td>
|
|
<td><p>A new instance of <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannel_ForAddress_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannel_ForAddress_System_String_Grpc_Net_Client_GrpcChannelOptions_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress(System.String,Grpc.Net.Client.GrpcChannelOptions)">ForAddress(String, GrpcChannelOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a> for the specified address and configuration options.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static GrpcChannel ForAddress(string address, GrpcChannelOptions channelOptions)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">address</span></td>
|
|
<td><p>The address the channel will use.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html">GrpcChannelOptions</a></td>
|
|
<td><span class="parametername">channelOptions</span></td>
|
|
<td><p>The channel configuration options.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a></td>
|
|
<td><p>A new instance of <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannel_ForAddress_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannel_ForAddress_Uri_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress(Uri)">ForAddress(Uri)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a> for the specified address.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static GrpcChannel ForAddress(Uri address)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Uri</span></td>
|
|
<td><span class="parametername">address</span></td>
|
|
<td><p>The address the channel will use.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a></td>
|
|
<td><p>A new instance of <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Net_Client_GrpcChannel_ForAddress_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress*"></a>
|
|
<h4 id="Grpc_Net_Client_GrpcChannel_ForAddress_Uri_Grpc_Net_Client_GrpcChannelOptions_" data-uid="Grpc.Net.Client.GrpcChannel.ForAddress(Uri,Grpc.Net.Client.GrpcChannelOptions)">ForAddress(Uri, GrpcChannelOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a> for the specified address and configuration options.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static GrpcChannel ForAddress(Uri address, GrpcChannelOptions channelOptions)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Uri</span></td>
|
|
<td><span class="parametername">address</span></td>
|
|
<td><p>The address the channel will use.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Net.Client.GrpcChannelOptions.html">GrpcChannelOptions</a></td>
|
|
<td><span class="parametername">channelOptions</span></td>
|
|
<td><p>The channel configuration options.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a></td>
|
|
<td><p>A new instance of <a class="xref" href="Grpc.Net.Client.GrpcChannel.html">GrpcChannel</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">IDisposable</span>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|