906 lines
40 KiB
HTML
906 lines
40 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 Interceptor
|
|
| gRPC C# </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class Interceptor
|
|
| gRPC C# ">
|
|
<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.Interceptors.Interceptor">
|
|
|
|
|
|
<h1 id="Grpc_Core_Interceptors_Interceptor" data-uid="Grpc.Core.Interceptors.Interceptor" class="text-break">Class Interceptor
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Serves as the base class for gRPC interceptors.</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">Interceptor</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.Interceptors.html">Grpc.Core.Interceptors</a></h6>
|
|
<h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
|
|
<h5 id="Grpc_Core_Interceptors_Interceptor_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract class Interceptor</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<a id="Grpc_Core_Interceptors_Interceptor_AsyncClientStreamingCall_" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncClientStreamingCall*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_AsyncClientStreamingCall__2_Grpc_Core_Interceptors_ClientInterceptorContext___0___1__Grpc_Core_Interceptors_Interceptor_AsyncClientStreamingCallContinuation___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncClientStreamingCall``2(Grpc.Core.Interceptors.ClientInterceptorContext{``0,``1},Grpc.Core.Interceptors.Interceptor.AsyncClientStreamingCallContinuation{``0,``1})">AsyncClientStreamingCall<TRequest, TResponse>(ClientInterceptorContext<TRequest, TResponse>, Interceptor.AsyncClientStreamingCallContinuation<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Intercepts an asynchronous invocation of a client streaming call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncClientStreamingCall<TRequest, TResponse> AsyncClientStreamingCall<TRequest, TResponse>(ClientInterceptorContext<TRequest, TResponse> context, Interceptor.AsyncClientStreamingCallContinuation<TRequest, TResponse> continuation)
|
|
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.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>The <a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext<TRequest, TResponse></a>
|
|
associated with the current invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.Interceptor.AsyncClientStreamingCallContinuation-2.html">Interceptor.AsyncClientStreamingCallContinuation</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>The callback that continues the invocation process.
|
|
This can be invoked zero or more times by the interceptor.
|
|
The interceptor can invoke the continuation passing the given
|
|
context argument, or substitute as it sees fit.</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.Core.AsyncClientStreamingCall-2.html">AsyncClientStreamingCall</a><TRequest, TResponse></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.AsyncClientStreamingCall-2.html">AsyncClientStreamingCall<TRequest, TResponse></a>
|
|
representing an asynchronous client-streaming invocation.
|
|
The interceptor can simply return the return value of the
|
|
continuation delegate passed to it intact, or construct its
|
|
own substitute as it sees fit.</p>
|
|
</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_Interceptors_Interceptor_AsyncDuplexStreamingCall_" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncDuplexStreamingCall*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_AsyncDuplexStreamingCall__2_Grpc_Core_Interceptors_ClientInterceptorContext___0___1__Grpc_Core_Interceptors_Interceptor_AsyncDuplexStreamingCallContinuation___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncDuplexStreamingCall``2(Grpc.Core.Interceptors.ClientInterceptorContext{``0,``1},Grpc.Core.Interceptors.Interceptor.AsyncDuplexStreamingCallContinuation{``0,``1})">AsyncDuplexStreamingCall<TRequest, TResponse>(ClientInterceptorContext<TRequest, TResponse>, Interceptor.AsyncDuplexStreamingCallContinuation<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Intercepts an asynchronous invocation of a duplex streaming call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncDuplexStreamingCall<TRequest, TResponse> AsyncDuplexStreamingCall<TRequest, TResponse>(ClientInterceptorContext<TRequest, TResponse> context, Interceptor.AsyncDuplexStreamingCallContinuation<TRequest, TResponse> continuation)
|
|
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.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>The <a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext<TRequest, TResponse></a>
|
|
associated with the current invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.Interceptor.AsyncDuplexStreamingCallContinuation-2.html">Interceptor.AsyncDuplexStreamingCallContinuation</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>The callback that continues the invocation process.
|
|
This can be invoked zero or more times by the interceptor.
|
|
The interceptor can invoke the continuation passing the given
|
|
context argument, or substitute as it sees fit.</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.Core.AsyncDuplexStreamingCall-2.html">AsyncDuplexStreamingCall</a><TRequest, TResponse></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.AsyncDuplexStreamingCall-2.html">AsyncDuplexStreamingCall<TRequest, TResponse></a>
|
|
representing an asynchronous duplex-streaming invocation.
|
|
The interceptor can simply return the return value of the
|
|
continuation delegate passed to it intact, or construct its
|
|
own substitute as it sees fit.</p>
|
|
</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_Interceptors_Interceptor_AsyncServerStreamingCall_" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncServerStreamingCall*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_AsyncServerStreamingCall__2___0_Grpc_Core_Interceptors_ClientInterceptorContext___0___1__Grpc_Core_Interceptors_Interceptor_AsyncServerStreamingCallContinuation___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncServerStreamingCall``2(``0,Grpc.Core.Interceptors.ClientInterceptorContext{``0,``1},Grpc.Core.Interceptors.Interceptor.AsyncServerStreamingCallContinuation{``0,``1})">AsyncServerStreamingCall<TRequest, TResponse>(TRequest, ClientInterceptorContext<TRequest, TResponse>, Interceptor.AsyncServerStreamingCallContinuation<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Intercepts an asynchronous invocation of a streaming remote call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncServerStreamingCall<TResponse> AsyncServerStreamingCall<TRequest, TResponse>(TRequest request, ClientInterceptorContext<TRequest, TResponse> context, Interceptor.AsyncServerStreamingCallContinuation<TRequest, TResponse> continuation)
|
|
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><span class="xref">TRequest</span></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request message of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>The <a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext<TRequest, TResponse></a>
|
|
associated with the current invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.Interceptor.AsyncServerStreamingCallContinuation-2.html">Interceptor.AsyncServerStreamingCallContinuation</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>The callback that continues the invocation process.
|
|
This can be invoked zero or more times by the interceptor.
|
|
The interceptor can invoke the continuation passing the given
|
|
request value and context arguments, or substitute them as it sees fit.</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.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall</a><TResponse></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.AsyncServerStreamingCall-1.html">AsyncServerStreamingCall<TResponse></a>
|
|
representing an asynchronous server-streaming invocation.
|
|
The interceptor can simply return the return value of the
|
|
continuation delegate passed to it intact, or construct its
|
|
own substitute as it sees fit.</p>
|
|
</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_Interceptors_Interceptor_AsyncUnaryCall_" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncUnaryCall*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_AsyncUnaryCall__2___0_Grpc_Core_Interceptors_ClientInterceptorContext___0___1__Grpc_Core_Interceptors_Interceptor_AsyncUnaryCallContinuation___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.AsyncUnaryCall``2(``0,Grpc.Core.Interceptors.ClientInterceptorContext{``0,``1},Grpc.Core.Interceptors.Interceptor.AsyncUnaryCallContinuation{``0,``1})">AsyncUnaryCall<TRequest, TResponse>(TRequest, ClientInterceptorContext<TRequest, TResponse>, Interceptor.AsyncUnaryCallContinuation<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Intercepts an asynchronous invocation of a simple remote call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>(TRequest request, ClientInterceptorContext<TRequest, TResponse> context, Interceptor.AsyncUnaryCallContinuation<TRequest, TResponse> continuation)
|
|
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><span class="xref">TRequest</span></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request message of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>The <a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext<TRequest, TResponse></a>
|
|
associated with the current invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.Interceptor.AsyncUnaryCallContinuation-2.html">Interceptor.AsyncUnaryCallContinuation</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>The callback that continues the invocation process.
|
|
This can be invoked zero or more times by the interceptor.
|
|
The interceptor can invoke the continuation passing the given
|
|
request value and context arguments, or substitute them as it sees fit.</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.Core.AsyncUnaryCall-1.html">AsyncUnaryCall</a><TResponse></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.AsyncUnaryCall-1.html">AsyncUnaryCall<TResponse></a>
|
|
representing an asynchronous unary invocation.
|
|
The interceptor can simply return the return value of the
|
|
continuation delegate passed to it intact, or construct its
|
|
own substitute as it sees fit.</p>
|
|
</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_Interceptors_Interceptor_BlockingUnaryCall_" data-uid="Grpc.Core.Interceptors.Interceptor.BlockingUnaryCall*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_BlockingUnaryCall__2___0_Grpc_Core_Interceptors_ClientInterceptorContext___0___1__Grpc_Core_Interceptors_Interceptor_BlockingUnaryCallContinuation___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.BlockingUnaryCall``2(``0,Grpc.Core.Interceptors.ClientInterceptorContext{``0,``1},Grpc.Core.Interceptors.Interceptor.BlockingUnaryCallContinuation{``0,``1})">BlockingUnaryCall<TRequest, TResponse>(TRequest, ClientInterceptorContext<TRequest, TResponse>, Interceptor.BlockingUnaryCallContinuation<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Intercepts a blocking invocation of a simple remote call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual TResponse BlockingUnaryCall<TRequest, TResponse>(TRequest request, ClientInterceptorContext<TRequest, TResponse> context, Interceptor.BlockingUnaryCallContinuation<TRequest, TResponse> continuation)
|
|
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><span class="xref">TRequest</span></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request message of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>The <a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext<TRequest, TResponse></a>
|
|
associated with the current invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Interceptors.Interceptor.BlockingUnaryCallContinuation-2.html">Interceptor.BlockingUnaryCallContinuation</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>The callback that continues the invocation process.
|
|
This can be invoked zero or more times by the interceptor.
|
|
The interceptor can invoke the continuation passing the given
|
|
request value and context arguments, or substitute them as it sees fit.</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><span class="xref">TResponse</span></td>
|
|
<td><p>The response message of the current invocation.
|
|
The interceptor can simply return the return value of the
|
|
continuation delegate passed to it intact, or an arbitrary
|
|
value as it sees fit.</p>
|
|
</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_Interceptors_Interceptor_ClientStreamingServerHandler_" data-uid="Grpc.Core.Interceptors.Interceptor.ClientStreamingServerHandler*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_ClientStreamingServerHandler__2_Grpc_Core_IAsyncStreamReader___0__Grpc_Core_ServerCallContext_Grpc_Core_ClientStreamingServerMethod___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.ClientStreamingServerHandler``2(Grpc.Core.IAsyncStreamReader{``0},Grpc.Core.ServerCallContext,Grpc.Core.ClientStreamingServerMethod{``0,``1})">ClientStreamingServerHandler<TRequest, TResponse>(IAsyncStreamReader<TRequest>, ServerCallContext, ClientStreamingServerMethod<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Server-side handler for intercepting client streaming call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual Task<TResponse> ClientStreamingServerHandler<TRequest, TResponse>(IAsyncStreamReader<TRequest> requestStream, ServerCallContext context, ClientStreamingServerMethod<TRequest, TResponse> continuation)
|
|
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.IAsyncStreamReader-1.html">IAsyncStreamReader</a><TRequest></td>
|
|
<td><span class="parametername">requestStream</span></td>
|
|
<td><p>The request stream of the incoming invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a> representing
|
|
the context of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ClientStreamingServerMethod-2.html">ClientStreamingServerMethod</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>A delegate that asynchronously proceeds with the invocation, calling
|
|
the next interceptor in the chain, or the service request handler,
|
|
in case of the last interceptor and return the response value of
|
|
the RPC. The interceptor can choose to call it zero or more times
|
|
at its discretion.</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><span class="xref">System.Threading.Tasks.Task</span><TResponse></td>
|
|
<td><p>A future representing the response value of the RPC. The interceptor
|
|
can simply return the return value from the continuation intact,
|
|
or an arbitrary response value as it sees fit. The interceptor has
|
|
the ability to wrap or substitute the request stream when calling
|
|
the continuation.</p>
|
|
</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><p>Request message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResponse</span></td>
|
|
<td><p>Response message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Core_Interceptors_Interceptor_DuplexStreamingServerHandler_" data-uid="Grpc.Core.Interceptors.Interceptor.DuplexStreamingServerHandler*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_DuplexStreamingServerHandler__2_Grpc_Core_IAsyncStreamReader___0__Grpc_Core_IServerStreamWriter___1__Grpc_Core_ServerCallContext_Grpc_Core_DuplexStreamingServerMethod___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.DuplexStreamingServerHandler``2(Grpc.Core.IAsyncStreamReader{``0},Grpc.Core.IServerStreamWriter{``1},Grpc.Core.ServerCallContext,Grpc.Core.DuplexStreamingServerMethod{``0,``1})">DuplexStreamingServerHandler<TRequest, TResponse>(IAsyncStreamReader<TRequest>, IServerStreamWriter<TResponse>, ServerCallContext, DuplexStreamingServerMethod<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Server-side handler for intercepting bidirectional streaming calls.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual Task DuplexStreamingServerHandler<TRequest, TResponse>(IAsyncStreamReader<TRequest> requestStream, IServerStreamWriter<TResponse> responseStream, ServerCallContext context, DuplexStreamingServerMethod<TRequest, TResponse> continuation)
|
|
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.IAsyncStreamReader-1.html">IAsyncStreamReader</a><TRequest></td>
|
|
<td><span class="parametername">requestStream</span></td>
|
|
<td><p>The request stream of the incoming invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.IServerStreamWriter-1.html">IServerStreamWriter</a><TResponse></td>
|
|
<td><span class="parametername">responseStream</span></td>
|
|
<td><p>The response stream of the incoming invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a> representing
|
|
the context of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.DuplexStreamingServerMethod-2.html">DuplexStreamingServerMethod</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>A delegate that asynchronously proceeds with the invocation, calling
|
|
the next interceptor in the chain, or the service request handler,
|
|
in case of the last interceptor and the interceptor can choose to
|
|
call it zero or more times at its discretion. The interceptor has
|
|
the ability to wrap or substitute the request and response streams
|
|
when calling the continuation.</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><span class="xref">System.Threading.Tasks.Task</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><p>Request message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResponse</span></td>
|
|
<td><p>Response message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Core_Interceptors_Interceptor_ServerStreamingServerHandler_" data-uid="Grpc.Core.Interceptors.Interceptor.ServerStreamingServerHandler*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_ServerStreamingServerHandler__2___0_Grpc_Core_IServerStreamWriter___1__Grpc_Core_ServerCallContext_Grpc_Core_ServerStreamingServerMethod___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.ServerStreamingServerHandler``2(``0,Grpc.Core.IServerStreamWriter{``1},Grpc.Core.ServerCallContext,Grpc.Core.ServerStreamingServerMethod{``0,``1})">ServerStreamingServerHandler<TRequest, TResponse>(TRequest, IServerStreamWriter<TResponse>, ServerCallContext, ServerStreamingServerMethod<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Server-side handler for intercepting server streaming call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual Task ServerStreamingServerHandler<TRequest, TResponse>(TRequest request, IServerStreamWriter<TResponse> responseStream, ServerCallContext context, ServerStreamingServerMethod<TRequest, TResponse> continuation)
|
|
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><span class="xref">TRequest</span></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request value of the incoming invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.IServerStreamWriter-1.html">IServerStreamWriter</a><TResponse></td>
|
|
<td><span class="parametername">responseStream</span></td>
|
|
<td><p>The response stream of the incoming invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a> representing
|
|
the context of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ServerStreamingServerMethod-2.html">ServerStreamingServerMethod</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>A delegate that asynchronously proceeds with the invocation, calling
|
|
the next interceptor in the chain, or the service request handler,
|
|
in case of the last interceptor and the interceptor can choose to
|
|
call it zero or more times at its discretion. The interceptor has
|
|
the ability to wrap or substitute the request value and the response stream
|
|
when calling the continuation.</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><span class="xref">System.Threading.Tasks.Task</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><p>Request message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResponse</span></td>
|
|
<td><p>Response message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Core_Interceptors_Interceptor_UnaryServerHandler_" data-uid="Grpc.Core.Interceptors.Interceptor.UnaryServerHandler*"></a>
|
|
<h4 id="Grpc_Core_Interceptors_Interceptor_UnaryServerHandler__2___0_Grpc_Core_ServerCallContext_Grpc_Core_UnaryServerMethod___0___1__" data-uid="Grpc.Core.Interceptors.Interceptor.UnaryServerHandler``2(``0,Grpc.Core.ServerCallContext,Grpc.Core.UnaryServerMethod{``0,``1})">UnaryServerHandler<TRequest, TResponse>(TRequest, ServerCallContext, UnaryServerMethod<TRequest, TResponse>)</h4>
|
|
<div class="markdown level1 summary"><p>Server-side handler for intercepting and incoming unary call.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public virtual Task<TResponse> UnaryServerHandler<TRequest, TResponse>(TRequest request, ServerCallContext context, UnaryServerMethod<TRequest, TResponse> continuation)
|
|
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><span class="xref">TRequest</span></td>
|
|
<td><span class="parametername">request</span></td>
|
|
<td><p>The request value of the incoming invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a></td>
|
|
<td><span class="parametername">context</span></td>
|
|
<td><p>An instance of <a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a> representing
|
|
the context of the invocation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.UnaryServerMethod-2.html">UnaryServerMethod</a><TRequest, TResponse></td>
|
|
<td><span class="parametername">continuation</span></td>
|
|
<td><p>A delegate that asynchronously proceeds with the invocation, calling
|
|
the next interceptor in the chain, or the service request handler,
|
|
in case of the last interceptor and return the response value of
|
|
the RPC. The interceptor can choose to call it zero or more times
|
|
at its discretion.</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><span class="xref">System.Threading.Tasks.Task</span><TResponse></td>
|
|
<td><p>A future representing the response value of the RPC. The interceptor
|
|
can simply return the return value from the continuation intact,
|
|
or an arbitrary response value as it sees fit.</p>
|
|
</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><p>Request message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="parametername">TResponse</span></td>
|
|
<td><p>Response message type for this method.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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>
|