Grpc.Core.Interceptors.ClientInterceptorContext-2.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  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>Struct ClientInterceptorContext&lt;TRequest, TResponse&gt;
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Struct ClientInterceptorContext&lt;TRequest, TResponse&gt;
  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.Core.Interceptors.ClientInterceptorContext`2">
  73. <h1 id="Grpc_Core_Interceptors_ClientInterceptorContext_2" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2" class="text-break">Struct ClientInterceptorContext&lt;TRequest, TResponse&gt;
  74. </h1>
  75. <div class="markdown level0 summary"><p>Carries along the context associated with intercepted invocations on the client side.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.Interceptors.html">Grpc.Core.Interceptors</a></h6>
  79. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  80. <h5 id="Grpc_Core_Interceptors_ClientInterceptorContext_2_syntax">Syntax</h5>
  81. <div class="codewrapper">
  82. <pre><code class="lang-csharp hljs">public struct ClientInterceptorContext&lt;TRequest, TResponse&gt;
  83. where TRequest : class where TResponse : class</code></pre>
  84. </div>
  85. <h5 class="typeParameters">Type Parameters</h5>
  86. <table class="table table-bordered table-striped table-condensed">
  87. <thead>
  88. <tr>
  89. <th>Name</th>
  90. <th>Description</th>
  91. </tr>
  92. </thead>
  93. <tbody>
  94. <tr>
  95. <td><span class="parametername">TRequest</span></td>
  96. <td></td>
  97. </tr>
  98. <tr>
  99. <td><span class="parametername">TResponse</span></td>
  100. <td></td>
  101. </tr>
  102. </tbody>
  103. </table>
  104. <h3 id="constructors">Constructors
  105. </h3>
  106. <a id="Grpc_Core_Interceptors_ClientInterceptorContext_2__ctor_" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.#ctor*"></a>
  107. <h4 id="Grpc_Core_Interceptors_ClientInterceptorContext_2__ctor_Grpc_Core_Method__0__1__System_String_Grpc_Core_CallOptions_" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.#ctor(Grpc.Core.Method{`0,`1},System.String,Grpc.Core.CallOptions)">ClientInterceptorContext(Method&lt;TRequest, TResponse&gt;, String, CallOptions)</h4>
  108. <div class="markdown level1 summary"><p>Creates a new instance of <a class="xref" href="Grpc.Core.Interceptors.ClientInterceptorContext-2.html">ClientInterceptorContext&lt;TRequest, TResponse&gt;</a>
  109. with the specified method, host, and call options.</p>
  110. </div>
  111. <div class="markdown level1 conceptual"></div>
  112. <h5 class="decalaration">Declaration</h5>
  113. <div class="codewrapper">
  114. <pre><code class="lang-csharp hljs">public ClientInterceptorContext(Method&lt;TRequest, TResponse&gt; method, string host, CallOptions options)</code></pre>
  115. </div>
  116. <h5 class="parameters">Parameters</h5>
  117. <table class="table table-bordered table-striped table-condensed">
  118. <thead>
  119. <tr>
  120. <th>Type</th>
  121. <th>Name</th>
  122. <th>Description</th>
  123. </tr>
  124. </thead>
  125. <tbody>
  126. <tr>
  127. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  128. <td><span class="parametername">method</span></td>
  129. <td><p>A <a class="xref" href="Grpc.Core.Method-2.html">Method&lt;TRequest, TResponse&gt;</a> object representing the method to be invoked.</p>
  130. </td>
  131. </tr>
  132. <tr>
  133. <td><span class="xref">System.String</span></td>
  134. <td><span class="parametername">host</span></td>
  135. <td><p>The host to dispatch the current call to.</p>
  136. </td>
  137. </tr>
  138. <tr>
  139. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  140. <td><span class="parametername">options</span></td>
  141. <td><p>A <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> instance containing the call options of the current call.</p>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <h3 id="properties">Properties
  147. </h3>
  148. <a id="Grpc_Core_Interceptors_ClientInterceptorContext_2_Host_" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.Host*"></a>
  149. <h4 id="Grpc_Core_Interceptors_ClientInterceptorContext_2_Host" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.Host">Host</h4>
  150. <div class="markdown level1 summary"><p>Gets the host that the currect invocation will be dispatched to.</p>
  151. </div>
  152. <div class="markdown level1 conceptual"></div>
  153. <h5 class="decalaration">Declaration</h5>
  154. <div class="codewrapper">
  155. <pre><code class="lang-csharp hljs">public string Host { get; }</code></pre>
  156. </div>
  157. <h5 class="propertyValue">Property Value</h5>
  158. <table class="table table-bordered table-striped table-condensed">
  159. <thead>
  160. <tr>
  161. <th>Type</th>
  162. <th>Description</th>
  163. </tr>
  164. </thead>
  165. <tbody>
  166. <tr>
  167. <td><span class="xref">System.String</span></td>
  168. <td></td>
  169. </tr>
  170. </tbody>
  171. </table>
  172. <a id="Grpc_Core_Interceptors_ClientInterceptorContext_2_Method_" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.Method*"></a>
  173. <h4 id="Grpc_Core_Interceptors_ClientInterceptorContext_2_Method" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.Method">Method</h4>
  174. <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Grpc.Core.Method-2.html">Method&lt;TRequest, TResponse&gt;</a> instance
  175. representing the method to be invoked.</p>
  176. </div>
  177. <div class="markdown level1 conceptual"></div>
  178. <h5 class="decalaration">Declaration</h5>
  179. <div class="codewrapper">
  180. <pre><code class="lang-csharp hljs">public Method&lt;TRequest, TResponse&gt; Method { get; }</code></pre>
  181. </div>
  182. <h5 class="propertyValue">Property Value</h5>
  183. <table class="table table-bordered table-striped table-condensed">
  184. <thead>
  185. <tr>
  186. <th>Type</th>
  187. <th>Description</th>
  188. </tr>
  189. </thead>
  190. <tbody>
  191. <tr>
  192. <td><a class="xref" href="Grpc.Core.Method-2.html">Method</a>&lt;TRequest, TResponse&gt;</td>
  193. <td></td>
  194. </tr>
  195. </tbody>
  196. </table>
  197. <a id="Grpc_Core_Interceptors_ClientInterceptorContext_2_Options_" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.Options*"></a>
  198. <h4 id="Grpc_Core_Interceptors_ClientInterceptorContext_2_Options" data-uid="Grpc.Core.Interceptors.ClientInterceptorContext`2.Options">Options</h4>
  199. <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> structure representing the
  200. call options associated with the current invocation.</p>
  201. </div>
  202. <div class="markdown level1 conceptual"></div>
  203. <h5 class="decalaration">Declaration</h5>
  204. <div class="codewrapper">
  205. <pre><code class="lang-csharp hljs">public CallOptions Options { get; }</code></pre>
  206. </div>
  207. <h5 class="propertyValue">Property Value</h5>
  208. <table class="table table-bordered table-striped table-condensed">
  209. <thead>
  210. <tr>
  211. <th>Type</th>
  212. <th>Description</th>
  213. </tr>
  214. </thead>
  215. <tbody>
  216. <tr>
  217. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  218. <td></td>
  219. </tr>
  220. </tbody>
  221. </table>
  222. </article>
  223. </div>
  224. <div class="hidden-sm col-md-2" role="complementary">
  225. <div class="sideaffix">
  226. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  227. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  228. </nav>
  229. </div>
  230. </div>
  231. </div>
  232. </div>
  233. <footer>
  234. <div class="grad-bottom"></div>
  235. <div class="footer">
  236. <div class="container">
  237. <span class="pull-right">
  238. <a href="#top">Back to top</a>
  239. </span>
  240. <span>Generated by <strong>DocFX</strong></span>
  241. </div>
  242. </div>
  243. </footer>
  244. </div>
  245. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  246. <script type="text/javascript" src="../styles/docfx.js"></script>
  247. <script type="text/javascript" src="../styles/main.js"></script>
  248. </body>
  249. </html>