Grpc.Core.CallOptions.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  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 CallOptions
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Struct CallOptions
  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.CallOptions">
  73. <h1 id="Grpc_Core_CallOptions" data-uid="Grpc.Core.CallOptions" class="text-break">Struct CallOptions
  74. </h1>
  75. <div class="markdown level0 summary"><p>Options for calls made by client.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  79. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  80. <h5 id="Grpc_Core_CallOptions_syntax">Syntax</h5>
  81. <div class="codewrapper">
  82. <pre><code class="lang-csharp hljs">public struct CallOptions</code></pre>
  83. </div>
  84. <h3 id="constructors">Constructors
  85. </h3>
  86. <a id="Grpc_Core_CallOptions__ctor_" data-uid="Grpc.Core.CallOptions.#ctor*"></a>
  87. <h4 id="Grpc_Core_CallOptions__ctor_Grpc_Core_Metadata_System_Nullable_DateTime__CancellationToken_Grpc_Core_WriteOptions_Grpc_Core_ContextPropagationToken_Grpc_Core_CallCredentials_" data-uid="Grpc.Core.CallOptions.#ctor(Grpc.Core.Metadata,System.Nullable{DateTime},CancellationToken,Grpc.Core.WriteOptions,Grpc.Core.ContextPropagationToken,Grpc.Core.CallCredentials)">CallOptions(Metadata, Nullable&lt;DateTime&gt;, CancellationToken, WriteOptions, ContextPropagationToken, CallCredentials)</h4>
  88. <div class="markdown level1 summary"><p>Creates a new instance of <code>CallOptions</code> struct.</p>
  89. </div>
  90. <div class="markdown level1 conceptual"></div>
  91. <h5 class="decalaration">Declaration</h5>
  92. <div class="codewrapper">
  93. <pre><code class="lang-csharp hljs">public CallOptions(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null, WriteOptions writeOptions = null, ContextPropagationToken propagationToken = null, CallCredentials credentials = null)</code></pre>
  94. </div>
  95. <h5 class="parameters">Parameters</h5>
  96. <table class="table table-bordered table-striped table-condensed">
  97. <thead>
  98. <tr>
  99. <th>Type</th>
  100. <th>Name</th>
  101. <th>Description</th>
  102. </tr>
  103. </thead>
  104. <tbody>
  105. <tr>
  106. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  107. <td><span class="parametername">headers</span></td>
  108. <td><p>Headers to be sent with the call.</p>
  109. </td>
  110. </tr>
  111. <tr>
  112. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">DateTime</span>&gt;</td>
  113. <td><span class="parametername">deadline</span></td>
  114. <td><p>Deadline for the call to finish. null means no deadline.</p>
  115. </td>
  116. </tr>
  117. <tr>
  118. <td><span class="xref">CancellationToken</span></td>
  119. <td><span class="parametername">cancellationToken</span></td>
  120. <td><p>Can be used to request cancellation of the call.</p>
  121. </td>
  122. </tr>
  123. <tr>
  124. <td><a class="xref" href="Grpc.Core.WriteOptions.html">WriteOptions</a></td>
  125. <td><span class="parametername">writeOptions</span></td>
  126. <td><p>Write options that will be used for this call.</p>
  127. </td>
  128. </tr>
  129. <tr>
  130. <td><a class="xref" href="Grpc.Core.ContextPropagationToken.html">ContextPropagationToken</a></td>
  131. <td><span class="parametername">propagationToken</span></td>
  132. <td><p>Context propagation token obtained from <a class="xref" href="Grpc.Core.ServerCallContext.html">ServerCallContext</a>.</p>
  133. </td>
  134. </tr>
  135. <tr>
  136. <td><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a></td>
  137. <td><span class="parametername">credentials</span></td>
  138. <td><p>Credentials to use for this call.</p>
  139. </td>
  140. </tr>
  141. </tbody>
  142. </table>
  143. <h3 id="properties">Properties
  144. </h3>
  145. <a id="Grpc_Core_CallOptions_CancellationToken_" data-uid="Grpc.Core.CallOptions.CancellationToken*"></a>
  146. <h4 id="Grpc_Core_CallOptions_CancellationToken" data-uid="Grpc.Core.CallOptions.CancellationToken">CancellationToken</h4>
  147. <div class="markdown level1 summary"><p>Token that can be used for cancelling the call on the client side.
  148. Cancelling the token will request cancellation
  149. of the remote call. Best effort will be made to deliver the cancellation
  150. notification to the server and interaction of the call with the server side
  151. will be terminated. Unless the call finishes before the cancellation could
  152. happen (there is an inherent race),
  153. the call will finish with <code>StatusCode.Cancelled</code> status.</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_CallOptions_Credentials_" data-uid="Grpc.Core.CallOptions.Credentials*"></a>
  176. <h4 id="Grpc_Core_CallOptions_Credentials" data-uid="Grpc.Core.CallOptions.Credentials">Credentials</h4>
  177. <div class="markdown level1 summary"><p>Credentials to use for this call.</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">public CallCredentials Credentials { 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><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a></td>
  195. <td></td>
  196. </tr>
  197. </tbody>
  198. </table>
  199. <a id="Grpc_Core_CallOptions_Deadline_" data-uid="Grpc.Core.CallOptions.Deadline*"></a>
  200. <h4 id="Grpc_Core_CallOptions_Deadline" data-uid="Grpc.Core.CallOptions.Deadline">Deadline</h4>
  201. <div class="markdown level1 summary"><p>Call deadline.</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">System.Nullable</span>&lt;<span class="xref">DateTime</span>&gt;</td>
  219. <td></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <a id="Grpc_Core_CallOptions_Headers_" data-uid="Grpc.Core.CallOptions.Headers*"></a>
  224. <h4 id="Grpc_Core_CallOptions_Headers" data-uid="Grpc.Core.CallOptions.Headers">Headers</h4>
  225. <div class="markdown level1 summary"><p>Headers to send at the beginning of the call.</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">public Metadata Headers { 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><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  243. <td></td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. <a id="Grpc_Core_CallOptions_IsWaitForReady_" data-uid="Grpc.Core.CallOptions.IsWaitForReady*"></a>
  248. <h4 id="Grpc_Core_CallOptions_IsWaitForReady" data-uid="Grpc.Core.CallOptions.IsWaitForReady">IsWaitForReady</h4>
  249. <div class="markdown level1 summary"><p>If <code>true</code> and and channel is in <code>ChannelState.TransientFailure</code>, the call will attempt waiting for the channel to recover
  250. instead of failing immediately (which is the default &quot;FailFast&quot; semantics).
  251. Note: experimental API that can change or be removed without any prior notice.</p>
  252. </div>
  253. <div class="markdown level1 conceptual"></div>
  254. <h5 class="decalaration">Declaration</h5>
  255. <div class="codewrapper">
  256. <pre><code class="lang-csharp hljs">public bool IsWaitForReady { get; }</code></pre>
  257. </div>
  258. <h5 class="propertyValue">Property Value</h5>
  259. <table class="table table-bordered table-striped table-condensed">
  260. <thead>
  261. <tr>
  262. <th>Type</th>
  263. <th>Description</th>
  264. </tr>
  265. </thead>
  266. <tbody>
  267. <tr>
  268. <td><span class="xref">System.Boolean</span></td>
  269. <td></td>
  270. </tr>
  271. </tbody>
  272. </table>
  273. <a id="Grpc_Core_CallOptions_PropagationToken_" data-uid="Grpc.Core.CallOptions.PropagationToken*"></a>
  274. <h4 id="Grpc_Core_CallOptions_PropagationToken" data-uid="Grpc.Core.CallOptions.PropagationToken">PropagationToken</h4>
  275. <div class="markdown level1 summary"><p>Token for propagating parent call context.</p>
  276. </div>
  277. <div class="markdown level1 conceptual"></div>
  278. <h5 class="decalaration">Declaration</h5>
  279. <div class="codewrapper">
  280. <pre><code class="lang-csharp hljs">public ContextPropagationToken PropagationToken { get; }</code></pre>
  281. </div>
  282. <h5 class="propertyValue">Property Value</h5>
  283. <table class="table table-bordered table-striped table-condensed">
  284. <thead>
  285. <tr>
  286. <th>Type</th>
  287. <th>Description</th>
  288. </tr>
  289. </thead>
  290. <tbody>
  291. <tr>
  292. <td><a class="xref" href="Grpc.Core.ContextPropagationToken.html">ContextPropagationToken</a></td>
  293. <td></td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <a id="Grpc_Core_CallOptions_WriteOptions_" data-uid="Grpc.Core.CallOptions.WriteOptions*"></a>
  298. <h4 id="Grpc_Core_CallOptions_WriteOptions" data-uid="Grpc.Core.CallOptions.WriteOptions">WriteOptions</h4>
  299. <div class="markdown level1 summary"><p>Write options that will be used for this call.</p>
  300. </div>
  301. <div class="markdown level1 conceptual"></div>
  302. <h5 class="decalaration">Declaration</h5>
  303. <div class="codewrapper">
  304. <pre><code class="lang-csharp hljs">public WriteOptions WriteOptions { get; }</code></pre>
  305. </div>
  306. <h5 class="propertyValue">Property Value</h5>
  307. <table class="table table-bordered table-striped table-condensed">
  308. <thead>
  309. <tr>
  310. <th>Type</th>
  311. <th>Description</th>
  312. </tr>
  313. </thead>
  314. <tbody>
  315. <tr>
  316. <td><a class="xref" href="Grpc.Core.WriteOptions.html">WriteOptions</a></td>
  317. <td></td>
  318. </tr>
  319. </tbody>
  320. </table>
  321. <h3 id="methods">Methods
  322. </h3>
  323. <a id="Grpc_Core_CallOptions_WithCancellationToken_" data-uid="Grpc.Core.CallOptions.WithCancellationToken*"></a>
  324. <h4 id="Grpc_Core_CallOptions_WithCancellationToken_CancellationToken_" data-uid="Grpc.Core.CallOptions.WithCancellationToken(CancellationToken)">WithCancellationToken(CancellationToken)</h4>
  325. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with
  326. <code>CancellationToken</code> set to the value provided. Values of all other fields are preserved.</p>
  327. </div>
  328. <div class="markdown level1 conceptual"></div>
  329. <h5 class="decalaration">Declaration</h5>
  330. <div class="codewrapper">
  331. <pre><code class="lang-csharp hljs">public CallOptions WithCancellationToken(CancellationToken cancellationToken)</code></pre>
  332. </div>
  333. <h5 class="parameters">Parameters</h5>
  334. <table class="table table-bordered table-striped table-condensed">
  335. <thead>
  336. <tr>
  337. <th>Type</th>
  338. <th>Name</th>
  339. <th>Description</th>
  340. </tr>
  341. </thead>
  342. <tbody>
  343. <tr>
  344. <td><span class="xref">CancellationToken</span></td>
  345. <td><span class="parametername">cancellationToken</span></td>
  346. <td><p>The cancellation token.</p>
  347. </td>
  348. </tr>
  349. </tbody>
  350. </table>
  351. <h5 class="returns">Returns</h5>
  352. <table class="table table-bordered table-striped table-condensed">
  353. <thead>
  354. <tr>
  355. <th>Type</th>
  356. <th>Description</th>
  357. </tr>
  358. </thead>
  359. <tbody>
  360. <tr>
  361. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  362. <td></td>
  363. </tr>
  364. </tbody>
  365. </table>
  366. <a id="Grpc_Core_CallOptions_WithCredentials_" data-uid="Grpc.Core.CallOptions.WithCredentials*"></a>
  367. <h4 id="Grpc_Core_CallOptions_WithCredentials_Grpc_Core_CallCredentials_" data-uid="Grpc.Core.CallOptions.WithCredentials(Grpc.Core.CallCredentials)">WithCredentials(CallCredentials)</h4>
  368. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with
  369. <code>Credentials</code> set to the value provided. Values of all other fields are preserved.</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">public CallOptions WithCredentials(CallCredentials credentials)</code></pre>
  375. </div>
  376. <h5 class="parameters">Parameters</h5>
  377. <table class="table table-bordered table-striped table-condensed">
  378. <thead>
  379. <tr>
  380. <th>Type</th>
  381. <th>Name</th>
  382. <th>Description</th>
  383. </tr>
  384. </thead>
  385. <tbody>
  386. <tr>
  387. <td><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a></td>
  388. <td><span class="parametername">credentials</span></td>
  389. <td><p>The call credentials.</p>
  390. </td>
  391. </tr>
  392. </tbody>
  393. </table>
  394. <h5 class="returns">Returns</h5>
  395. <table class="table table-bordered table-striped table-condensed">
  396. <thead>
  397. <tr>
  398. <th>Type</th>
  399. <th>Description</th>
  400. </tr>
  401. </thead>
  402. <tbody>
  403. <tr>
  404. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  405. <td></td>
  406. </tr>
  407. </tbody>
  408. </table>
  409. <a id="Grpc_Core_CallOptions_WithDeadline_" data-uid="Grpc.Core.CallOptions.WithDeadline*"></a>
  410. <h4 id="Grpc_Core_CallOptions_WithDeadline_DateTime_" data-uid="Grpc.Core.CallOptions.WithDeadline(DateTime)">WithDeadline(DateTime)</h4>
  411. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with
  412. <code>Deadline</code> set to the value provided. Values of all other fields are preserved.</p>
  413. </div>
  414. <div class="markdown level1 conceptual"></div>
  415. <h5 class="decalaration">Declaration</h5>
  416. <div class="codewrapper">
  417. <pre><code class="lang-csharp hljs">public CallOptions WithDeadline(DateTime deadline)</code></pre>
  418. </div>
  419. <h5 class="parameters">Parameters</h5>
  420. <table class="table table-bordered table-striped table-condensed">
  421. <thead>
  422. <tr>
  423. <th>Type</th>
  424. <th>Name</th>
  425. <th>Description</th>
  426. </tr>
  427. </thead>
  428. <tbody>
  429. <tr>
  430. <td><span class="xref">DateTime</span></td>
  431. <td><span class="parametername">deadline</span></td>
  432. <td><p>The deadline.</p>
  433. </td>
  434. </tr>
  435. </tbody>
  436. </table>
  437. <h5 class="returns">Returns</h5>
  438. <table class="table table-bordered table-striped table-condensed">
  439. <thead>
  440. <tr>
  441. <th>Type</th>
  442. <th>Description</th>
  443. </tr>
  444. </thead>
  445. <tbody>
  446. <tr>
  447. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  448. <td></td>
  449. </tr>
  450. </tbody>
  451. </table>
  452. <a id="Grpc_Core_CallOptions_WithHeaders_" data-uid="Grpc.Core.CallOptions.WithHeaders*"></a>
  453. <h4 id="Grpc_Core_CallOptions_WithHeaders_Grpc_Core_Metadata_" data-uid="Grpc.Core.CallOptions.WithHeaders(Grpc.Core.Metadata)">WithHeaders(Metadata)</h4>
  454. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with
  455. <code>Headers</code> set to the value provided. Values of all other fields are preserved.</p>
  456. </div>
  457. <div class="markdown level1 conceptual"></div>
  458. <h5 class="decalaration">Declaration</h5>
  459. <div class="codewrapper">
  460. <pre><code class="lang-csharp hljs">public CallOptions WithHeaders(Metadata headers)</code></pre>
  461. </div>
  462. <h5 class="parameters">Parameters</h5>
  463. <table class="table table-bordered table-striped table-condensed">
  464. <thead>
  465. <tr>
  466. <th>Type</th>
  467. <th>Name</th>
  468. <th>Description</th>
  469. </tr>
  470. </thead>
  471. <tbody>
  472. <tr>
  473. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  474. <td><span class="parametername">headers</span></td>
  475. <td><p>The headers.</p>
  476. </td>
  477. </tr>
  478. </tbody>
  479. </table>
  480. <h5 class="returns">Returns</h5>
  481. <table class="table table-bordered table-striped table-condensed">
  482. <thead>
  483. <tr>
  484. <th>Type</th>
  485. <th>Description</th>
  486. </tr>
  487. </thead>
  488. <tbody>
  489. <tr>
  490. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  491. <td></td>
  492. </tr>
  493. </tbody>
  494. </table>
  495. <a id="Grpc_Core_CallOptions_WithPropagationToken_" data-uid="Grpc.Core.CallOptions.WithPropagationToken*"></a>
  496. <h4 id="Grpc_Core_CallOptions_WithPropagationToken_Grpc_Core_ContextPropagationToken_" data-uid="Grpc.Core.CallOptions.WithPropagationToken(Grpc.Core.ContextPropagationToken)">WithPropagationToken(ContextPropagationToken)</h4>
  497. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with
  498. <code>PropagationToken</code> set to the value provided. Values of all other fields are preserved.</p>
  499. </div>
  500. <div class="markdown level1 conceptual"></div>
  501. <h5 class="decalaration">Declaration</h5>
  502. <div class="codewrapper">
  503. <pre><code class="lang-csharp hljs">public CallOptions WithPropagationToken(ContextPropagationToken propagationToken)</code></pre>
  504. </div>
  505. <h5 class="parameters">Parameters</h5>
  506. <table class="table table-bordered table-striped table-condensed">
  507. <thead>
  508. <tr>
  509. <th>Type</th>
  510. <th>Name</th>
  511. <th>Description</th>
  512. </tr>
  513. </thead>
  514. <tbody>
  515. <tr>
  516. <td><a class="xref" href="Grpc.Core.ContextPropagationToken.html">ContextPropagationToken</a></td>
  517. <td><span class="parametername">propagationToken</span></td>
  518. <td><p>The context propagation token.</p>
  519. </td>
  520. </tr>
  521. </tbody>
  522. </table>
  523. <h5 class="returns">Returns</h5>
  524. <table class="table table-bordered table-striped table-condensed">
  525. <thead>
  526. <tr>
  527. <th>Type</th>
  528. <th>Description</th>
  529. </tr>
  530. </thead>
  531. <tbody>
  532. <tr>
  533. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  534. <td></td>
  535. </tr>
  536. </tbody>
  537. </table>
  538. <a id="Grpc_Core_CallOptions_WithWaitForReady_" data-uid="Grpc.Core.CallOptions.WithWaitForReady*"></a>
  539. <h4 id="Grpc_Core_CallOptions_WithWaitForReady_System_Boolean_" data-uid="Grpc.Core.CallOptions.WithWaitForReady(System.Boolean)">WithWaitForReady(Boolean)</h4>
  540. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with &quot;WaitForReady&quot; semantics enabled/disabled.
  541. <a class="xref" href="Grpc.Core.CallOptions.html#Grpc_Core_CallOptions_IsWaitForReady">IsWaitForReady</a>.
  542. Note: experimental API that can change or be removed without any prior notice.</p>
  543. </div>
  544. <div class="markdown level1 conceptual"></div>
  545. <h5 class="decalaration">Declaration</h5>
  546. <div class="codewrapper">
  547. <pre><code class="lang-csharp hljs">public CallOptions WithWaitForReady(bool waitForReady = true)</code></pre>
  548. </div>
  549. <h5 class="parameters">Parameters</h5>
  550. <table class="table table-bordered table-striped table-condensed">
  551. <thead>
  552. <tr>
  553. <th>Type</th>
  554. <th>Name</th>
  555. <th>Description</th>
  556. </tr>
  557. </thead>
  558. <tbody>
  559. <tr>
  560. <td><span class="xref">System.Boolean</span></td>
  561. <td><span class="parametername">waitForReady</span></td>
  562. <td></td>
  563. </tr>
  564. </tbody>
  565. </table>
  566. <h5 class="returns">Returns</h5>
  567. <table class="table table-bordered table-striped table-condensed">
  568. <thead>
  569. <tr>
  570. <th>Type</th>
  571. <th>Description</th>
  572. </tr>
  573. </thead>
  574. <tbody>
  575. <tr>
  576. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  577. <td></td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <a id="Grpc_Core_CallOptions_WithWriteOptions_" data-uid="Grpc.Core.CallOptions.WithWriteOptions*"></a>
  582. <h4 id="Grpc_Core_CallOptions_WithWriteOptions_Grpc_Core_WriteOptions_" data-uid="Grpc.Core.CallOptions.WithWriteOptions(Grpc.Core.WriteOptions)">WithWriteOptions(WriteOptions)</h4>
  583. <div class="markdown level1 summary"><p>Returns new instance of <a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a> with
  584. <code>WriteOptions</code> set to the value provided. Values of all other fields are preserved.</p>
  585. </div>
  586. <div class="markdown level1 conceptual"></div>
  587. <h5 class="decalaration">Declaration</h5>
  588. <div class="codewrapper">
  589. <pre><code class="lang-csharp hljs">public CallOptions WithWriteOptions(WriteOptions writeOptions)</code></pre>
  590. </div>
  591. <h5 class="parameters">Parameters</h5>
  592. <table class="table table-bordered table-striped table-condensed">
  593. <thead>
  594. <tr>
  595. <th>Type</th>
  596. <th>Name</th>
  597. <th>Description</th>
  598. </tr>
  599. </thead>
  600. <tbody>
  601. <tr>
  602. <td><a class="xref" href="Grpc.Core.WriteOptions.html">WriteOptions</a></td>
  603. <td><span class="parametername">writeOptions</span></td>
  604. <td><p>The write options.</p>
  605. </td>
  606. </tr>
  607. </tbody>
  608. </table>
  609. <h5 class="returns">Returns</h5>
  610. <table class="table table-bordered table-striped table-condensed">
  611. <thead>
  612. <tr>
  613. <th>Type</th>
  614. <th>Description</th>
  615. </tr>
  616. </thead>
  617. <tbody>
  618. <tr>
  619. <td><a class="xref" href="Grpc.Core.CallOptions.html">CallOptions</a></td>
  620. <td></td>
  621. </tr>
  622. </tbody>
  623. </table>
  624. </article>
  625. </div>
  626. <div class="hidden-sm col-md-2" role="complementary">
  627. <div class="sideaffix">
  628. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  629. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  630. </nav>
  631. </div>
  632. </div>
  633. </div>
  634. </div>
  635. <footer>
  636. <div class="grad-bottom"></div>
  637. <div class="footer">
  638. <div class="container">
  639. <span class="pull-right">
  640. <a href="#top">Back to top</a>
  641. </span>
  642. <span>Generated by <strong>DocFX</strong></span>
  643. </div>
  644. </div>
  645. </footer>
  646. </div>
  647. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  648. <script type="text/javascript" src="../styles/docfx.js"></script>
  649. <script type="text/javascript" src="../styles/main.js"></script>
  650. </body>
  651. </html>