grpc/csharp-dotnet/api/Grpc.AspNetCore.Server.Inte...

211 lines
8.3 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 InterceptorCollection
| gRPC for .NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class InterceptorCollection
| 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.AspNetCore.Server.InterceptorCollection">
<h1 id="Grpc_AspNetCore_Server_InterceptorCollection" data-uid="Grpc.AspNetCore.Server.InterceptorCollection" class="text-break">Class InterceptorCollection
</h1>
<div class="markdown level0 summary"><p>Represents the pipeline of interceptors to be invoked when processing a gRPC call.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">Collection</span>&lt;<a class="xref" href="Grpc.AspNetCore.Server.InterceptorRegistration.html">InterceptorRegistration</a>&gt;</div>
<div class="level1"><span class="xref">InterceptorCollection</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.AspNetCore.Server.html">Grpc.AspNetCore.Server</a></h6>
<h6><strong>Assembly</strong>: Grpc.AspNetCore.Server.dll</h6>
<h5 id="Grpc_AspNetCore_Server_InterceptorCollection_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class InterceptorCollection : Collection&lt;InterceptorRegistration&gt;</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Grpc_AspNetCore_Server_InterceptorCollection_Add_" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add*"></a>
<h4 id="Grpc_AspNetCore_Server_InterceptorCollection_Add_Type_System_Object___" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add(Type,System.Object[])">Add(Type, Object[])</h4>
<div class="markdown level1 summary"><p>Add an interceptor to the end of the pipeline.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Add(Type interceptorType, params object[] args)</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">Type</span></td>
<td><span class="parametername">interceptorType</span></td>
<td><p>The interceptor type.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Object</span>[]</td>
<td><span class="parametername">args</span></td>
<td><p>The list of arguments to pass to the interceptor constructor when creating an instance.</p>
</td>
</tr>
</tbody>
</table>
<a id="Grpc_AspNetCore_Server_InterceptorCollection_Add_" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add*"></a>
<h4 id="Grpc_AspNetCore_Server_InterceptorCollection_Add__1_System_Object___" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add``1(System.Object[])">Add&lt;TInterceptor&gt;(Object[])</h4>
<div class="markdown level1 summary"><p>Add an interceptor to the end of the pipeline.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Add&lt;TInterceptor&gt;(params object[] args)
where TInterceptor : Interceptor</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.Object</span>[]</td>
<td><span class="parametername">args</span></td>
<td><p>The list of arguments to pass to the interceptor constructor when creating an instance.</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">TInterceptor</span></td>
<td><p>The interceptor type.</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>