Grpc.AspNetCore.Server.InterceptorCollection.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class InterceptorCollection
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class InterceptorCollection
  11. | gRPC for .NET ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.AspNetCore.Server.InterceptorCollection">
  73. <h1 id="Grpc_AspNetCore_Server_InterceptorCollection" data-uid="Grpc.AspNetCore.Server.InterceptorCollection" class="text-break">Class InterceptorCollection
  74. </h1>
  75. <div class="markdown level0 summary"><p>Represents the pipeline of interceptors to be invoked when processing a gRPC call.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">Collection</span>&lt;<a class="xref" href="Grpc.AspNetCore.Server.InterceptorRegistration.html">InterceptorRegistration</a>&gt;</div>
  81. <div class="level1"><span class="xref">InterceptorCollection</span></div>
  82. </div>
  83. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.AspNetCore.Server.html">Grpc.AspNetCore.Server</a></h6>
  84. <h6><strong>Assembly</strong>: Grpc.AspNetCore.Server.dll</h6>
  85. <h5 id="Grpc_AspNetCore_Server_InterceptorCollection_syntax">Syntax</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">public class InterceptorCollection : Collection&lt;InterceptorRegistration&gt;</code></pre>
  88. </div>
  89. <h3 id="methods">Methods
  90. </h3>
  91. <a id="Grpc_AspNetCore_Server_InterceptorCollection_Add_" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add*"></a>
  92. <h4 id="Grpc_AspNetCore_Server_InterceptorCollection_Add_Type_System_Object___" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add(Type,System.Object[])">Add(Type, Object[])</h4>
  93. <div class="markdown level1 summary"><p>Add an interceptor to the end of the pipeline.</p>
  94. </div>
  95. <div class="markdown level1 conceptual"></div>
  96. <h5 class="decalaration">Declaration</h5>
  97. <div class="codewrapper">
  98. <pre><code class="lang-csharp hljs">public void Add(Type interceptorType, params object[] args)</code></pre>
  99. </div>
  100. <h5 class="parameters">Parameters</h5>
  101. <table class="table table-bordered table-striped table-condensed">
  102. <thead>
  103. <tr>
  104. <th>Type</th>
  105. <th>Name</th>
  106. <th>Description</th>
  107. </tr>
  108. </thead>
  109. <tbody>
  110. <tr>
  111. <td><span class="xref">Type</span></td>
  112. <td><span class="parametername">interceptorType</span></td>
  113. <td><p>The interceptor type.</p>
  114. </td>
  115. </tr>
  116. <tr>
  117. <td><span class="xref">System.Object</span>[]</td>
  118. <td><span class="parametername">args</span></td>
  119. <td><p>The list of arguments to pass to the interceptor constructor when creating an instance.</p>
  120. </td>
  121. </tr>
  122. </tbody>
  123. </table>
  124. <a id="Grpc_AspNetCore_Server_InterceptorCollection_Add_" data-uid="Grpc.AspNetCore.Server.InterceptorCollection.Add*"></a>
  125. <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>
  126. <div class="markdown level1 summary"><p>Add an interceptor to the end of the pipeline.</p>
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public void Add&lt;TInterceptor&gt;(params object[] args)
  132. where TInterceptor : Interceptor</code></pre>
  133. </div>
  134. <h5 class="parameters">Parameters</h5>
  135. <table class="table table-bordered table-striped table-condensed">
  136. <thead>
  137. <tr>
  138. <th>Type</th>
  139. <th>Name</th>
  140. <th>Description</th>
  141. </tr>
  142. </thead>
  143. <tbody>
  144. <tr>
  145. <td><span class="xref">System.Object</span>[]</td>
  146. <td><span class="parametername">args</span></td>
  147. <td><p>The list of arguments to pass to the interceptor constructor when creating an instance.</p>
  148. </td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <h5 class="typeParameters">Type Parameters</h5>
  153. <table class="table table-bordered table-striped table-condensed">
  154. <thead>
  155. <tr>
  156. <th>Name</th>
  157. <th>Description</th>
  158. </tr>
  159. </thead>
  160. <tbody>
  161. <tr>
  162. <td><span class="parametername">TInterceptor</span></td>
  163. <td><p>The interceptor type.</p>
  164. </td>
  165. </tr>
  166. </tbody>
  167. </table>
  168. </article>
  169. </div>
  170. <div class="hidden-sm col-md-2" role="complementary">
  171. <div class="sideaffix">
  172. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  173. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  174. </nav>
  175. </div>
  176. </div>
  177. </div>
  178. </div>
  179. <footer>
  180. <div class="grad-bottom"></div>
  181. <div class="footer">
  182. <div class="container">
  183. <span class="pull-right">
  184. <a href="#top">Back to top</a>
  185. </span>
  186. <span>Generated by <strong>DocFX</strong></span>
  187. </div>
  188. </div>
  189. </footer>
  190. </div>
  191. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  192. <script type="text/javascript" src="../styles/docfx.js"></script>
  193. <script type="text/javascript" src="../styles/main.js"></script>
  194. </body>
  195. </html>