grpc/csharp-dotnet/api/Grpc.Core.CallInvoker.html

518 lines
20 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 CallInvoker
| gRPC for .NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CallInvoker
| 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.Core.CallInvoker">
<h1 id="Grpc_Core_CallInvoker" data-uid="Grpc.Core.CallInvoker" class="text-break">Class CallInvoker
</h1>
<div class="markdown level0 summary"><p>Abstraction of client-side RPC invocation.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">CallInvoker</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
<h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
<h5 id="Grpc_Core_CallInvoker_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class CallInvoker : object</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Grpc_Core_CallInvoker_AsyncClientStreamingCall_" data-uid="Grpc.Core.CallInvoker.AsyncClientStreamingCall*"></a>
<h4 id="Grpc_Core_CallInvoker_AsyncClientStreamingCall__2_Grpc_Core_Method___0___1__System_String_Grpc_Core_CallOptions_" data-uid="Grpc.Core.CallInvoker.AsyncClientStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">AsyncClientStreamingCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, String, CallOptions)</h4>
<div class="markdown level1 summary"><p>Invokes a client streaming call asynchronously.
In client streaming scenario, client sends a stream of requests and server responds with a single response.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract AsyncClientStreamingCall&lt;TRequest, TResponse&gt; AsyncClientStreamingCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options)
where TRequest : class where TResponse : class</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><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td></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.Core.AsyncClientStreamingCall-2.html">AsyncClientStreamingCall</a>&lt;TRequest, TResponse&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TRequest</span></td>
<td></td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvoker_AsyncDuplexStreamingCall_" data-uid="Grpc.Core.CallInvoker.AsyncDuplexStreamingCall*"></a>
<h4 id="Grpc_Core_CallInvoker_AsyncDuplexStreamingCall__2_Grpc_Core_Method___0___1__System_String_Grpc_Core_CallOptions_" data-uid="Grpc.Core.CallInvoker.AsyncDuplexStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">AsyncDuplexStreamingCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, String, CallOptions)</h4>
<div class="markdown level1 summary"><p>Invokes a duplex streaming call asynchronously.
In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
The response stream is completely independent and both side can be sending messages at the same time.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract AsyncDuplexStreamingCall&lt;TRequest, TResponse&gt; AsyncDuplexStreamingCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options)
where TRequest : class where TResponse : class</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><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td></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.Core.AsyncDuplexStreamingCall-2.html">AsyncDuplexStreamingCall</a>&lt;TRequest, TResponse&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TRequest</span></td>
<td></td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvoker_AsyncServerStreamingCall_" data-uid="Grpc.Core.CallInvoker.AsyncServerStreamingCall*"></a>
<h4 id="Grpc_Core_CallInvoker_AsyncServerStreamingCall__2_Grpc_Core_Method___0___1__System_String_Grpc_Core_CallOptions___0_" data-uid="Grpc.Core.CallInvoker.AsyncServerStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">AsyncServerStreamingCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, String, CallOptions, TRequest)</h4>
<div class="markdown level1 summary"><p>Invokes a server streaming call asynchronously.
In server streaming scenario, client sends on request and server responds with a stream of responses.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract AsyncServerStreamingCall&lt;TResponse&gt; AsyncServerStreamingCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options, TRequest request)
where TRequest : class where TResponse : class</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><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">TRequest</span></td>
<td><span class="parametername">request</span></td>
<td></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.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall</a>&lt;TResponse&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TRequest</span></td>
<td></td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvoker_AsyncUnaryCall_" data-uid="Grpc.Core.CallInvoker.AsyncUnaryCall*"></a>
<h4 id="Grpc_Core_CallInvoker_AsyncUnaryCall__2_Grpc_Core_Method___0___1__System_String_Grpc_Core_CallOptions___0_" data-uid="Grpc.Core.CallInvoker.AsyncUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">AsyncUnaryCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, String, CallOptions, TRequest)</h4>
<div class="markdown level1 summary"><p>Invokes a simple remote call asynchronously.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract AsyncUnaryCall&lt;TResponse&gt; AsyncUnaryCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options, TRequest request)
where TRequest : class where TResponse : class</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><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">TRequest</span></td>
<td><span class="parametername">request</span></td>
<td></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.Core.AsyncUnaryCall-1.html">AsyncUnaryCall</a>&lt;TResponse&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TRequest</span></td>
<td></td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Grpc_Core_CallInvoker_BlockingUnaryCall_" data-uid="Grpc.Core.CallInvoker.BlockingUnaryCall*"></a>
<h4 id="Grpc_Core_CallInvoker_BlockingUnaryCall__2_Grpc_Core_Method___0___1__System_String_Grpc_Core_CallOptions___0_" data-uid="Grpc.Core.CallInvoker.BlockingUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">BlockingUnaryCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt;, String, CallOptions, TRequest)</h4>
<div class="markdown level1 summary"><p>Invokes a simple remote call in a blocking fashion.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract TResponse BlockingUnaryCall&lt;TRequest, TResponse&gt;(Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options, TRequest request)
where TRequest : class where TResponse : class</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><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
<td><span class="parametername">method</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">host</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
<td><span class="parametername">options</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">TRequest</span></td>
<td><span class="parametername">request</span></td>
<td></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><span class="xref">TResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">TRequest</span></td>
<td></td>
</tr>
<tr>
<td><span class="parametername">TResponse</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="Grpc.Core.Interceptors.CallInvokerExtensions.html#Grpc_Core_Interceptors_CallInvokerExtensions_Intercept_Grpc_Core_CallInvoker_Grpc_Core_Interceptors_Interceptor_">CallInvokerExtensions.Intercept(CallInvoker, Interceptor)</a>
</div>
<div>
<a class="xref" href="Grpc.Core.Interceptors.CallInvokerExtensions.html#Grpc_Core_Interceptors_CallInvokerExtensions_Intercept_Grpc_Core_CallInvoker_Grpc_Core_Interceptors_Interceptor___">CallInvokerExtensions.Intercept(CallInvoker, Interceptor[])</a>
</div>
<div>
<a class="xref" href="Grpc.Core.Interceptors.CallInvokerExtensions.html#Grpc_Core_Interceptors_CallInvokerExtensions_Intercept_Grpc_Core_CallInvoker_Func_Grpc_Core_Metadata_Grpc_Core_Metadata__">CallInvokerExtensions.Intercept(CallInvoker, Func&lt;Metadata, Metadata&gt;)</a>
</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>