Grpc.Core.ServerCallContext.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846
  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 ServerCallContext
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ServerCallContext
  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.ServerCallContext">
  73. <h1 id="Grpc_Core_ServerCallContext" data-uid="Grpc.Core.ServerCallContext" class="text-break">Class ServerCallContext
  74. </h1>
  75. <div class="markdown level0 summary"><p>Context for a server-side 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">System.Object</span></div>
  81. <div class="level1"><span class="xref">ServerCallContext</span></div>
  82. </div>
  83. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  84. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  85. <h5 id="Grpc_Core_ServerCallContext_syntax">Syntax</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">public abstract class ServerCallContext : object</code></pre>
  88. </div>
  89. <h3 id="constructors">Constructors
  90. </h3>
  91. <a id="Grpc_Core_ServerCallContext__ctor_" data-uid="Grpc.Core.ServerCallContext.#ctor*"></a>
  92. <h4 id="Grpc_Core_ServerCallContext__ctor" data-uid="Grpc.Core.ServerCallContext.#ctor">ServerCallContext()</h4>
  93. <div class="markdown level1 summary"><p>Creates a new instance of <code>ServerCallContext</code>.</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">protected ServerCallContext()</code></pre>
  99. </div>
  100. <h3 id="properties">Properties
  101. </h3>
  102. <a id="Grpc_Core_ServerCallContext_AuthContext_" data-uid="Grpc.Core.ServerCallContext.AuthContext*"></a>
  103. <h4 id="Grpc_Core_ServerCallContext_AuthContext" data-uid="Grpc.Core.ServerCallContext.AuthContext">AuthContext</h4>
  104. <div class="markdown level1 summary"><p>Gets the <code>AuthContext</code> associated with this call.
  105. Note: Access to AuthContext is an experimental API that can change without any prior notice.</p>
  106. </div>
  107. <div class="markdown level1 conceptual"></div>
  108. <h5 class="decalaration">Declaration</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public AuthContext AuthContext { get; }</code></pre>
  111. </div>
  112. <h5 class="propertyValue">Property Value</h5>
  113. <table class="table table-bordered table-striped table-condensed">
  114. <thead>
  115. <tr>
  116. <th>Type</th>
  117. <th>Description</th>
  118. </tr>
  119. </thead>
  120. <tbody>
  121. <tr>
  122. <td><a class="xref" href="Grpc.Core.AuthContext.html">AuthContext</a></td>
  123. <td></td>
  124. </tr>
  125. </tbody>
  126. </table>
  127. <a id="Grpc_Core_ServerCallContext_AuthContextCore_" data-uid="Grpc.Core.ServerCallContext.AuthContextCore*"></a>
  128. <h4 id="Grpc_Core_ServerCallContext_AuthContextCore" data-uid="Grpc.Core.ServerCallContext.AuthContextCore">AuthContextCore</h4>
  129. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  130. </div>
  131. <div class="markdown level1 conceptual"></div>
  132. <h5 class="decalaration">Declaration</h5>
  133. <div class="codewrapper">
  134. <pre><code class="lang-csharp hljs">protected abstract AuthContext AuthContextCore { get; }</code></pre>
  135. </div>
  136. <h5 class="propertyValue">Property Value</h5>
  137. <table class="table table-bordered table-striped table-condensed">
  138. <thead>
  139. <tr>
  140. <th>Type</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><a class="xref" href="Grpc.Core.AuthContext.html">AuthContext</a></td>
  147. <td></td>
  148. </tr>
  149. </tbody>
  150. </table>
  151. <a id="Grpc_Core_ServerCallContext_CancellationToken_" data-uid="Grpc.Core.ServerCallContext.CancellationToken*"></a>
  152. <h4 id="Grpc_Core_ServerCallContext_CancellationToken" data-uid="Grpc.Core.ServerCallContext.CancellationToken">CancellationToken</h4>
  153. <div class="markdown level1 summary"><p>Cancellation token signals when call is cancelled.</p>
  154. </div>
  155. <div class="markdown level1 conceptual"></div>
  156. <h5 class="decalaration">Declaration</h5>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">public CancellationToken CancellationToken { get; }</code></pre>
  159. </div>
  160. <h5 class="propertyValue">Property Value</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><span class="xref">CancellationToken</span></td>
  171. <td></td>
  172. </tr>
  173. </tbody>
  174. </table>
  175. <a id="Grpc_Core_ServerCallContext_CancellationTokenCore_" data-uid="Grpc.Core.ServerCallContext.CancellationTokenCore*"></a>
  176. <h4 id="Grpc_Core_ServerCallContext_CancellationTokenCore" data-uid="Grpc.Core.ServerCallContext.CancellationTokenCore">CancellationTokenCore</h4>
  177. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  178. </div>
  179. <div class="markdown level1 conceptual"></div>
  180. <h5 class="decalaration">Declaration</h5>
  181. <div class="codewrapper">
  182. <pre><code class="lang-csharp hljs">protected abstract CancellationToken CancellationTokenCore { get; }</code></pre>
  183. </div>
  184. <h5 class="propertyValue">Property Value</h5>
  185. <table class="table table-bordered table-striped table-condensed">
  186. <thead>
  187. <tr>
  188. <th>Type</th>
  189. <th>Description</th>
  190. </tr>
  191. </thead>
  192. <tbody>
  193. <tr>
  194. <td><span class="xref">CancellationToken</span></td>
  195. <td></td>
  196. </tr>
  197. </tbody>
  198. </table>
  199. <a id="Grpc_Core_ServerCallContext_Deadline_" data-uid="Grpc.Core.ServerCallContext.Deadline*"></a>
  200. <h4 id="Grpc_Core_ServerCallContext_Deadline" data-uid="Grpc.Core.ServerCallContext.Deadline">Deadline</h4>
  201. <div class="markdown level1 summary"><p>Deadline for this RPC.</p>
  202. </div>
  203. <div class="markdown level1 conceptual"></div>
  204. <h5 class="decalaration">Declaration</h5>
  205. <div class="codewrapper">
  206. <pre><code class="lang-csharp hljs">public DateTime Deadline { get; }</code></pre>
  207. </div>
  208. <h5 class="propertyValue">Property Value</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><span class="xref">DateTime</span></td>
  219. <td></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <a id="Grpc_Core_ServerCallContext_DeadlineCore_" data-uid="Grpc.Core.ServerCallContext.DeadlineCore*"></a>
  224. <h4 id="Grpc_Core_ServerCallContext_DeadlineCore" data-uid="Grpc.Core.ServerCallContext.DeadlineCore">DeadlineCore</h4>
  225. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  226. </div>
  227. <div class="markdown level1 conceptual"></div>
  228. <h5 class="decalaration">Declaration</h5>
  229. <div class="codewrapper">
  230. <pre><code class="lang-csharp hljs">protected abstract DateTime DeadlineCore { get; }</code></pre>
  231. </div>
  232. <h5 class="propertyValue">Property Value</h5>
  233. <table class="table table-bordered table-striped table-condensed">
  234. <thead>
  235. <tr>
  236. <th>Type</th>
  237. <th>Description</th>
  238. </tr>
  239. </thead>
  240. <tbody>
  241. <tr>
  242. <td><span class="xref">DateTime</span></td>
  243. <td></td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. <a id="Grpc_Core_ServerCallContext_Host_" data-uid="Grpc.Core.ServerCallContext.Host*"></a>
  248. <h4 id="Grpc_Core_ServerCallContext_Host" data-uid="Grpc.Core.ServerCallContext.Host">Host</h4>
  249. <div class="markdown level1 summary"><p>Name of host called in this RPC.</p>
  250. </div>
  251. <div class="markdown level1 conceptual"></div>
  252. <h5 class="decalaration">Declaration</h5>
  253. <div class="codewrapper">
  254. <pre><code class="lang-csharp hljs">public string Host { get; }</code></pre>
  255. </div>
  256. <h5 class="propertyValue">Property Value</h5>
  257. <table class="table table-bordered table-striped table-condensed">
  258. <thead>
  259. <tr>
  260. <th>Type</th>
  261. <th>Description</th>
  262. </tr>
  263. </thead>
  264. <tbody>
  265. <tr>
  266. <td><span class="xref">System.String</span></td>
  267. <td></td>
  268. </tr>
  269. </tbody>
  270. </table>
  271. <a id="Grpc_Core_ServerCallContext_HostCore_" data-uid="Grpc.Core.ServerCallContext.HostCore*"></a>
  272. <h4 id="Grpc_Core_ServerCallContext_HostCore" data-uid="Grpc.Core.ServerCallContext.HostCore">HostCore</h4>
  273. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  274. </div>
  275. <div class="markdown level1 conceptual"></div>
  276. <h5 class="decalaration">Declaration</h5>
  277. <div class="codewrapper">
  278. <pre><code class="lang-csharp hljs">protected abstract string HostCore { get; }</code></pre>
  279. </div>
  280. <h5 class="propertyValue">Property Value</h5>
  281. <table class="table table-bordered table-striped table-condensed">
  282. <thead>
  283. <tr>
  284. <th>Type</th>
  285. <th>Description</th>
  286. </tr>
  287. </thead>
  288. <tbody>
  289. <tr>
  290. <td><span class="xref">System.String</span></td>
  291. <td></td>
  292. </tr>
  293. </tbody>
  294. </table>
  295. <a id="Grpc_Core_ServerCallContext_Method_" data-uid="Grpc.Core.ServerCallContext.Method*"></a>
  296. <h4 id="Grpc_Core_ServerCallContext_Method" data-uid="Grpc.Core.ServerCallContext.Method">Method</h4>
  297. <div class="markdown level1 summary"><p>Name of method called in this RPC.</p>
  298. </div>
  299. <div class="markdown level1 conceptual"></div>
  300. <h5 class="decalaration">Declaration</h5>
  301. <div class="codewrapper">
  302. <pre><code class="lang-csharp hljs">public string Method { get; }</code></pre>
  303. </div>
  304. <h5 class="propertyValue">Property Value</h5>
  305. <table class="table table-bordered table-striped table-condensed">
  306. <thead>
  307. <tr>
  308. <th>Type</th>
  309. <th>Description</th>
  310. </tr>
  311. </thead>
  312. <tbody>
  313. <tr>
  314. <td><span class="xref">System.String</span></td>
  315. <td></td>
  316. </tr>
  317. </tbody>
  318. </table>
  319. <a id="Grpc_Core_ServerCallContext_MethodCore_" data-uid="Grpc.Core.ServerCallContext.MethodCore*"></a>
  320. <h4 id="Grpc_Core_ServerCallContext_MethodCore" data-uid="Grpc.Core.ServerCallContext.MethodCore">MethodCore</h4>
  321. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  322. </div>
  323. <div class="markdown level1 conceptual"></div>
  324. <h5 class="decalaration">Declaration</h5>
  325. <div class="codewrapper">
  326. <pre><code class="lang-csharp hljs">protected abstract string MethodCore { get; }</code></pre>
  327. </div>
  328. <h5 class="propertyValue">Property Value</h5>
  329. <table class="table table-bordered table-striped table-condensed">
  330. <thead>
  331. <tr>
  332. <th>Type</th>
  333. <th>Description</th>
  334. </tr>
  335. </thead>
  336. <tbody>
  337. <tr>
  338. <td><span class="xref">System.String</span></td>
  339. <td></td>
  340. </tr>
  341. </tbody>
  342. </table>
  343. <a id="Grpc_Core_ServerCallContext_Peer_" data-uid="Grpc.Core.ServerCallContext.Peer*"></a>
  344. <h4 id="Grpc_Core_ServerCallContext_Peer" data-uid="Grpc.Core.ServerCallContext.Peer">Peer</h4>
  345. <div class="markdown level1 summary"><p>Address of the remote endpoint in URI format.</p>
  346. </div>
  347. <div class="markdown level1 conceptual"></div>
  348. <h5 class="decalaration">Declaration</h5>
  349. <div class="codewrapper">
  350. <pre><code class="lang-csharp hljs">public string Peer { get; }</code></pre>
  351. </div>
  352. <h5 class="propertyValue">Property Value</h5>
  353. <table class="table table-bordered table-striped table-condensed">
  354. <thead>
  355. <tr>
  356. <th>Type</th>
  357. <th>Description</th>
  358. </tr>
  359. </thead>
  360. <tbody>
  361. <tr>
  362. <td><span class="xref">System.String</span></td>
  363. <td></td>
  364. </tr>
  365. </tbody>
  366. </table>
  367. <a id="Grpc_Core_ServerCallContext_PeerCore_" data-uid="Grpc.Core.ServerCallContext.PeerCore*"></a>
  368. <h4 id="Grpc_Core_ServerCallContext_PeerCore" data-uid="Grpc.Core.ServerCallContext.PeerCore">PeerCore</h4>
  369. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  370. </div>
  371. <div class="markdown level1 conceptual"></div>
  372. <h5 class="decalaration">Declaration</h5>
  373. <div class="codewrapper">
  374. <pre><code class="lang-csharp hljs">protected abstract string PeerCore { get; }</code></pre>
  375. </div>
  376. <h5 class="propertyValue">Property Value</h5>
  377. <table class="table table-bordered table-striped table-condensed">
  378. <thead>
  379. <tr>
  380. <th>Type</th>
  381. <th>Description</th>
  382. </tr>
  383. </thead>
  384. <tbody>
  385. <tr>
  386. <td><span class="xref">System.String</span></td>
  387. <td></td>
  388. </tr>
  389. </tbody>
  390. </table>
  391. <a id="Grpc_Core_ServerCallContext_RequestHeaders_" data-uid="Grpc.Core.ServerCallContext.RequestHeaders*"></a>
  392. <h4 id="Grpc_Core_ServerCallContext_RequestHeaders" data-uid="Grpc.Core.ServerCallContext.RequestHeaders">RequestHeaders</h4>
  393. <div class="markdown level1 summary"><p>Initial metadata sent by client.</p>
  394. </div>
  395. <div class="markdown level1 conceptual"></div>
  396. <h5 class="decalaration">Declaration</h5>
  397. <div class="codewrapper">
  398. <pre><code class="lang-csharp hljs">public Metadata RequestHeaders { get; }</code></pre>
  399. </div>
  400. <h5 class="propertyValue">Property Value</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Description</th>
  406. </tr>
  407. </thead>
  408. <tbody>
  409. <tr>
  410. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  411. <td></td>
  412. </tr>
  413. </tbody>
  414. </table>
  415. <a id="Grpc_Core_ServerCallContext_RequestHeadersCore_" data-uid="Grpc.Core.ServerCallContext.RequestHeadersCore*"></a>
  416. <h4 id="Grpc_Core_ServerCallContext_RequestHeadersCore" data-uid="Grpc.Core.ServerCallContext.RequestHeadersCore">RequestHeadersCore</h4>
  417. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  418. </div>
  419. <div class="markdown level1 conceptual"></div>
  420. <h5 class="decalaration">Declaration</h5>
  421. <div class="codewrapper">
  422. <pre><code class="lang-csharp hljs">protected abstract Metadata RequestHeadersCore { get; }</code></pre>
  423. </div>
  424. <h5 class="propertyValue">Property Value</h5>
  425. <table class="table table-bordered table-striped table-condensed">
  426. <thead>
  427. <tr>
  428. <th>Type</th>
  429. <th>Description</th>
  430. </tr>
  431. </thead>
  432. <tbody>
  433. <tr>
  434. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  435. <td></td>
  436. </tr>
  437. </tbody>
  438. </table>
  439. <a id="Grpc_Core_ServerCallContext_ResponseTrailers_" data-uid="Grpc.Core.ServerCallContext.ResponseTrailers*"></a>
  440. <h4 id="Grpc_Core_ServerCallContext_ResponseTrailers" data-uid="Grpc.Core.ServerCallContext.ResponseTrailers">ResponseTrailers</h4>
  441. <div class="markdown level1 summary"><p>Trailers to send back to client after RPC finishes.</p>
  442. </div>
  443. <div class="markdown level1 conceptual"></div>
  444. <h5 class="decalaration">Declaration</h5>
  445. <div class="codewrapper">
  446. <pre><code class="lang-csharp hljs">public Metadata ResponseTrailers { get; }</code></pre>
  447. </div>
  448. <h5 class="propertyValue">Property Value</h5>
  449. <table class="table table-bordered table-striped table-condensed">
  450. <thead>
  451. <tr>
  452. <th>Type</th>
  453. <th>Description</th>
  454. </tr>
  455. </thead>
  456. <tbody>
  457. <tr>
  458. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  459. <td></td>
  460. </tr>
  461. </tbody>
  462. </table>
  463. <a id="Grpc_Core_ServerCallContext_ResponseTrailersCore_" data-uid="Grpc.Core.ServerCallContext.ResponseTrailersCore*"></a>
  464. <h4 id="Grpc_Core_ServerCallContext_ResponseTrailersCore" data-uid="Grpc.Core.ServerCallContext.ResponseTrailersCore">ResponseTrailersCore</h4>
  465. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  466. </div>
  467. <div class="markdown level1 conceptual"></div>
  468. <h5 class="decalaration">Declaration</h5>
  469. <div class="codewrapper">
  470. <pre><code class="lang-csharp hljs">protected abstract Metadata ResponseTrailersCore { get; }</code></pre>
  471. </div>
  472. <h5 class="propertyValue">Property Value</h5>
  473. <table class="table table-bordered table-striped table-condensed">
  474. <thead>
  475. <tr>
  476. <th>Type</th>
  477. <th>Description</th>
  478. </tr>
  479. </thead>
  480. <tbody>
  481. <tr>
  482. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  483. <td></td>
  484. </tr>
  485. </tbody>
  486. </table>
  487. <a id="Grpc_Core_ServerCallContext_Status_" data-uid="Grpc.Core.ServerCallContext.Status*"></a>
  488. <h4 id="Grpc_Core_ServerCallContext_Status" data-uid="Grpc.Core.ServerCallContext.Status">Status</h4>
  489. <div class="markdown level1 summary"><p>Status to send back to client after RPC finishes.</p>
  490. </div>
  491. <div class="markdown level1 conceptual"></div>
  492. <h5 class="decalaration">Declaration</h5>
  493. <div class="codewrapper">
  494. <pre><code class="lang-csharp hljs">public Status Status { get; set; }</code></pre>
  495. </div>
  496. <h5 class="propertyValue">Property Value</h5>
  497. <table class="table table-bordered table-striped table-condensed">
  498. <thead>
  499. <tr>
  500. <th>Type</th>
  501. <th>Description</th>
  502. </tr>
  503. </thead>
  504. <tbody>
  505. <tr>
  506. <td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
  507. <td></td>
  508. </tr>
  509. </tbody>
  510. </table>
  511. <a id="Grpc_Core_ServerCallContext_StatusCore_" data-uid="Grpc.Core.ServerCallContext.StatusCore*"></a>
  512. <h4 id="Grpc_Core_ServerCallContext_StatusCore" data-uid="Grpc.Core.ServerCallContext.StatusCore">StatusCore</h4>
  513. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  514. </div>
  515. <div class="markdown level1 conceptual"></div>
  516. <h5 class="decalaration">Declaration</h5>
  517. <div class="codewrapper">
  518. <pre><code class="lang-csharp hljs">protected abstract Status StatusCore { get; set; }</code></pre>
  519. </div>
  520. <h5 class="propertyValue">Property Value</h5>
  521. <table class="table table-bordered table-striped table-condensed">
  522. <thead>
  523. <tr>
  524. <th>Type</th>
  525. <th>Description</th>
  526. </tr>
  527. </thead>
  528. <tbody>
  529. <tr>
  530. <td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
  531. <td></td>
  532. </tr>
  533. </tbody>
  534. </table>
  535. <a id="Grpc_Core_ServerCallContext_UserState_" data-uid="Grpc.Core.ServerCallContext.UserState*"></a>
  536. <h4 id="Grpc_Core_ServerCallContext_UserState" data-uid="Grpc.Core.ServerCallContext.UserState">UserState</h4>
  537. <div class="markdown level1 summary"><p>Gets a dictionary that can be used by the various interceptors and handlers of this
  538. call to store arbitrary state.</p>
  539. </div>
  540. <div class="markdown level1 conceptual"></div>
  541. <h5 class="decalaration">Declaration</h5>
  542. <div class="codewrapper">
  543. <pre><code class="lang-csharp hljs">public IDictionary&lt;object, object&gt; UserState { get; }</code></pre>
  544. </div>
  545. <h5 class="propertyValue">Property Value</h5>
  546. <table class="table table-bordered table-striped table-condensed">
  547. <thead>
  548. <tr>
  549. <th>Type</th>
  550. <th>Description</th>
  551. </tr>
  552. </thead>
  553. <tbody>
  554. <tr>
  555. <td><span class="xref">IDictionary</span>&lt;<span class="xref">System.Object</span>, <span class="xref">System.Object</span>&gt;</td>
  556. <td></td>
  557. </tr>
  558. </tbody>
  559. </table>
  560. <a id="Grpc_Core_ServerCallContext_UserStateCore_" data-uid="Grpc.Core.ServerCallContext.UserStateCore*"></a>
  561. <h4 id="Grpc_Core_ServerCallContext_UserStateCore" data-uid="Grpc.Core.ServerCallContext.UserStateCore">UserStateCore</h4>
  562. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  563. </div>
  564. <div class="markdown level1 conceptual"></div>
  565. <h5 class="decalaration">Declaration</h5>
  566. <div class="codewrapper">
  567. <pre><code class="lang-csharp hljs">protected virtual IDictionary&lt;object, object&gt; UserStateCore { get; }</code></pre>
  568. </div>
  569. <h5 class="propertyValue">Property Value</h5>
  570. <table class="table table-bordered table-striped table-condensed">
  571. <thead>
  572. <tr>
  573. <th>Type</th>
  574. <th>Description</th>
  575. </tr>
  576. </thead>
  577. <tbody>
  578. <tr>
  579. <td><span class="xref">IDictionary</span>&lt;<span class="xref">System.Object</span>, <span class="xref">System.Object</span>&gt;</td>
  580. <td></td>
  581. </tr>
  582. </tbody>
  583. </table>
  584. <a id="Grpc_Core_ServerCallContext_WriteOptions_" data-uid="Grpc.Core.ServerCallContext.WriteOptions*"></a>
  585. <h4 id="Grpc_Core_ServerCallContext_WriteOptions" data-uid="Grpc.Core.ServerCallContext.WriteOptions">WriteOptions</h4>
  586. <div class="markdown level1 summary"><p>Allows setting write options for the following write.
  587. For streaming response calls, this property is also exposed as on IServerStreamWriter for convenience.
  588. Both properties are backed by the same underlying value.</p>
  589. </div>
  590. <div class="markdown level1 conceptual"></div>
  591. <h5 class="decalaration">Declaration</h5>
  592. <div class="codewrapper">
  593. <pre><code class="lang-csharp hljs">public WriteOptions WriteOptions { get; set; }</code></pre>
  594. </div>
  595. <h5 class="propertyValue">Property Value</h5>
  596. <table class="table table-bordered table-striped table-condensed">
  597. <thead>
  598. <tr>
  599. <th>Type</th>
  600. <th>Description</th>
  601. </tr>
  602. </thead>
  603. <tbody>
  604. <tr>
  605. <td><a class="xref" href="Grpc.Core.WriteOptions.html">WriteOptions</a></td>
  606. <td></td>
  607. </tr>
  608. </tbody>
  609. </table>
  610. <a id="Grpc_Core_ServerCallContext_WriteOptionsCore_" data-uid="Grpc.Core.ServerCallContext.WriteOptionsCore*"></a>
  611. <h4 id="Grpc_Core_ServerCallContext_WriteOptionsCore" data-uid="Grpc.Core.ServerCallContext.WriteOptionsCore">WriteOptionsCore</h4>
  612. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  613. </div>
  614. <div class="markdown level1 conceptual"></div>
  615. <h5 class="decalaration">Declaration</h5>
  616. <div class="codewrapper">
  617. <pre><code class="lang-csharp hljs">protected abstract WriteOptions WriteOptionsCore { get; set; }</code></pre>
  618. </div>
  619. <h5 class="propertyValue">Property Value</h5>
  620. <table class="table table-bordered table-striped table-condensed">
  621. <thead>
  622. <tr>
  623. <th>Type</th>
  624. <th>Description</th>
  625. </tr>
  626. </thead>
  627. <tbody>
  628. <tr>
  629. <td><a class="xref" href="Grpc.Core.WriteOptions.html">WriteOptions</a></td>
  630. <td></td>
  631. </tr>
  632. </tbody>
  633. </table>
  634. <h3 id="methods">Methods
  635. </h3>
  636. <a id="Grpc_Core_ServerCallContext_CreatePropagationToken_" data-uid="Grpc.Core.ServerCallContext.CreatePropagationToken*"></a>
  637. <h4 id="Grpc_Core_ServerCallContext_CreatePropagationToken_Grpc_Core_ContextPropagationOptions_" data-uid="Grpc.Core.ServerCallContext.CreatePropagationToken(Grpc.Core.ContextPropagationOptions)">CreatePropagationToken(ContextPropagationOptions)</h4>
  638. <div class="markdown level1 summary"><p>Creates a propagation token to be used to propagate call context to a child call.</p>
  639. </div>
  640. <div class="markdown level1 conceptual"></div>
  641. <h5 class="decalaration">Declaration</h5>
  642. <div class="codewrapper">
  643. <pre><code class="lang-csharp hljs">public ContextPropagationToken CreatePropagationToken(ContextPropagationOptions options = null)</code></pre>
  644. </div>
  645. <h5 class="parameters">Parameters</h5>
  646. <table class="table table-bordered table-striped table-condensed">
  647. <thead>
  648. <tr>
  649. <th>Type</th>
  650. <th>Name</th>
  651. <th>Description</th>
  652. </tr>
  653. </thead>
  654. <tbody>
  655. <tr>
  656. <td><a class="xref" href="Grpc.Core.ContextPropagationOptions.html">ContextPropagationOptions</a></td>
  657. <td><span class="parametername">options</span></td>
  658. <td></td>
  659. </tr>
  660. </tbody>
  661. </table>
  662. <h5 class="returns">Returns</h5>
  663. <table class="table table-bordered table-striped table-condensed">
  664. <thead>
  665. <tr>
  666. <th>Type</th>
  667. <th>Description</th>
  668. </tr>
  669. </thead>
  670. <tbody>
  671. <tr>
  672. <td><a class="xref" href="Grpc.Core.ContextPropagationToken.html">ContextPropagationToken</a></td>
  673. <td></td>
  674. </tr>
  675. </tbody>
  676. </table>
  677. <a id="Grpc_Core_ServerCallContext_CreatePropagationTokenCore_" data-uid="Grpc.Core.ServerCallContext.CreatePropagationTokenCore*"></a>
  678. <h4 id="Grpc_Core_ServerCallContext_CreatePropagationTokenCore_Grpc_Core_ContextPropagationOptions_" data-uid="Grpc.Core.ServerCallContext.CreatePropagationTokenCore(Grpc.Core.ContextPropagationOptions)">CreatePropagationTokenCore(ContextPropagationOptions)</h4>
  679. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  680. </div>
  681. <div class="markdown level1 conceptual"></div>
  682. <h5 class="decalaration">Declaration</h5>
  683. <div class="codewrapper">
  684. <pre><code class="lang-csharp hljs">protected abstract ContextPropagationToken CreatePropagationTokenCore(ContextPropagationOptions options)</code></pre>
  685. </div>
  686. <h5 class="parameters">Parameters</h5>
  687. <table class="table table-bordered table-striped table-condensed">
  688. <thead>
  689. <tr>
  690. <th>Type</th>
  691. <th>Name</th>
  692. <th>Description</th>
  693. </tr>
  694. </thead>
  695. <tbody>
  696. <tr>
  697. <td><a class="xref" href="Grpc.Core.ContextPropagationOptions.html">ContextPropagationOptions</a></td>
  698. <td><span class="parametername">options</span></td>
  699. <td></td>
  700. </tr>
  701. </tbody>
  702. </table>
  703. <h5 class="returns">Returns</h5>
  704. <table class="table table-bordered table-striped table-condensed">
  705. <thead>
  706. <tr>
  707. <th>Type</th>
  708. <th>Description</th>
  709. </tr>
  710. </thead>
  711. <tbody>
  712. <tr>
  713. <td><a class="xref" href="Grpc.Core.ContextPropagationToken.html">ContextPropagationToken</a></td>
  714. <td></td>
  715. </tr>
  716. </tbody>
  717. </table>
  718. <a id="Grpc_Core_ServerCallContext_WriteResponseHeadersAsync_" data-uid="Grpc.Core.ServerCallContext.WriteResponseHeadersAsync*"></a>
  719. <h4 id="Grpc_Core_ServerCallContext_WriteResponseHeadersAsync_Grpc_Core_Metadata_" data-uid="Grpc.Core.ServerCallContext.WriteResponseHeadersAsync(Grpc.Core.Metadata)">WriteResponseHeadersAsync(Metadata)</h4>
  720. <div class="markdown level1 summary"><p>Asynchronously sends response headers for the current call to the client. This method may only be invoked once for each call and needs to be invoked
  721. before any response messages are written. Writing the first response message implicitly sends empty response headers if <code>WriteResponseHeadersAsync</code> haven&apos;t
  722. been called yet.</p>
  723. </div>
  724. <div class="markdown level1 conceptual"></div>
  725. <h5 class="decalaration">Declaration</h5>
  726. <div class="codewrapper">
  727. <pre><code class="lang-csharp hljs">public Task WriteResponseHeadersAsync(Metadata responseHeaders)</code></pre>
  728. </div>
  729. <h5 class="parameters">Parameters</h5>
  730. <table class="table table-bordered table-striped table-condensed">
  731. <thead>
  732. <tr>
  733. <th>Type</th>
  734. <th>Name</th>
  735. <th>Description</th>
  736. </tr>
  737. </thead>
  738. <tbody>
  739. <tr>
  740. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  741. <td><span class="parametername">responseHeaders</span></td>
  742. <td><p>The response headers to send.</p>
  743. </td>
  744. </tr>
  745. </tbody>
  746. </table>
  747. <h5 class="returns">Returns</h5>
  748. <table class="table table-bordered table-striped table-condensed">
  749. <thead>
  750. <tr>
  751. <th>Type</th>
  752. <th>Description</th>
  753. </tr>
  754. </thead>
  755. <tbody>
  756. <tr>
  757. <td><span class="xref">Task</span></td>
  758. <td><p>The task that finished once response headers have been written.</p>
  759. </td>
  760. </tr>
  761. </tbody>
  762. </table>
  763. <a id="Grpc_Core_ServerCallContext_WriteResponseHeadersAsyncCore_" data-uid="Grpc.Core.ServerCallContext.WriteResponseHeadersAsyncCore*"></a>
  764. <h4 id="Grpc_Core_ServerCallContext_WriteResponseHeadersAsyncCore_Grpc_Core_Metadata_" data-uid="Grpc.Core.ServerCallContext.WriteResponseHeadersAsyncCore(Grpc.Core.Metadata)">WriteResponseHeadersAsyncCore(Metadata)</h4>
  765. <div class="markdown level1 summary"><p>Provides implementation of a non-virtual public member.</p>
  766. </div>
  767. <div class="markdown level1 conceptual"></div>
  768. <h5 class="decalaration">Declaration</h5>
  769. <div class="codewrapper">
  770. <pre><code class="lang-csharp hljs">protected abstract Task WriteResponseHeadersAsyncCore(Metadata responseHeaders)</code></pre>
  771. </div>
  772. <h5 class="parameters">Parameters</h5>
  773. <table class="table table-bordered table-striped table-condensed">
  774. <thead>
  775. <tr>
  776. <th>Type</th>
  777. <th>Name</th>
  778. <th>Description</th>
  779. </tr>
  780. </thead>
  781. <tbody>
  782. <tr>
  783. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  784. <td><span class="parametername">responseHeaders</span></td>
  785. <td></td>
  786. </tr>
  787. </tbody>
  788. </table>
  789. <h5 class="returns">Returns</h5>
  790. <table class="table table-bordered table-striped table-condensed">
  791. <thead>
  792. <tr>
  793. <th>Type</th>
  794. <th>Description</th>
  795. </tr>
  796. </thead>
  797. <tbody>
  798. <tr>
  799. <td><span class="xref">Task</span></td>
  800. <td></td>
  801. </tr>
  802. </tbody>
  803. </table>
  804. </article>
  805. </div>
  806. <div class="hidden-sm col-md-2" role="complementary">
  807. <div class="sideaffix">
  808. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  809. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  810. </nav>
  811. </div>
  812. </div>
  813. </div>
  814. </div>
  815. <footer>
  816. <div class="grad-bottom"></div>
  817. <div class="footer">
  818. <div class="container">
  819. <span class="pull-right">
  820. <a href="#top">Back to top</a>
  821. </span>
  822. <span>Generated by <strong>DocFX</strong></span>
  823. </div>
  824. </div>
  825. </footer>
  826. </div>
  827. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  828. <script type="text/javascript" src="../styles/docfx.js"></script>
  829. <script type="text/javascript" src="../styles/main.js"></script>
  830. </body>
  831. </html>