classgrpc_1_1_client_context.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC C++: grpc::ClientContext Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">0.11.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  91. <a href="#friends">Friends</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::ClientContext Class Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p><code>#include &lt;<a class="el" href="client__context_8h_source.html">client_context.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:acabbcf3c160a0628da8a9274b10f54b9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#acabbcf3c160a0628da8a9274b10f54b9">ClientContext</a> ()</td></tr>
  101. <tr class="separator:acabbcf3c160a0628da8a9274b10f54b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:aeb77ea760faf8f96e775812806c0a3d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aeb77ea760faf8f96e775812806c0a3d9">~ClientContext</a> ()</td></tr>
  103. <tr class="separator:aeb77ea760faf8f96e775812806c0a3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a69a026f073ef5934697568d689440bd4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a69a026f073ef5934697568d689440bd4">AddMetadata</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;meta_key, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;meta_value)</td></tr>
  105. <tr class="memdesc:a69a026f073ef5934697568d689440bd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the (<em>meta_key</em>, <em>meta_value</em>) pair to the metadata associated with a client call. <a href="#a69a026f073ef5934697568d689440bd4">More...</a><br/></td></tr>
  106. <tr class="separator:a69a026f073ef5934697568d689440bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a3dd6ec0742cbc84e5a83acab009c5f38"><td class="memItemLeft" align="right" valign="top">const std::multimap<br class="typebreak"/>
  108. &lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <br class="typebreak"/>
  109. <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a3dd6ec0742cbc84e5a83acab009c5f38">GetServerInitialMetadata</a> ()</td></tr>
  110. <tr class="memdesc:a3dd6ec0742cbc84e5a83acab009c5f38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a collection of initial metadata key-value pairs. <a href="#a3dd6ec0742cbc84e5a83acab009c5f38">More...</a><br/></td></tr>
  111. <tr class="separator:a3dd6ec0742cbc84e5a83acab009c5f38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a06cd5278c2d242bdd6a8f62fd6c87a93"><td class="memItemLeft" align="right" valign="top">const std::multimap<br class="typebreak"/>
  113. &lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <br class="typebreak"/>
  114. <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a06cd5278c2d242bdd6a8f62fd6c87a93">GetServerTrailingMetadata</a> ()</td></tr>
  115. <tr class="memdesc:a06cd5278c2d242bdd6a8f62fd6c87a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a collection of trailing metadata key-value pairs. <a href="#a06cd5278c2d242bdd6a8f62fd6c87a93">More...</a><br/></td></tr>
  116. <tr class="separator:a06cd5278c2d242bdd6a8f62fd6c87a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  118. <tr class="memitem:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ad4e16866fee3f6ee5a10efb5be6f4da6">set_deadline</a> (const T &amp;<a class="el" href="classgrpc_1_1_client_context.html#af29e0113f661e1fbbecc20c268a3be6e">deadline</a>)</td></tr>
  119. <tr class="memdesc:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the deadline for the client call. <a href="#ad4e16866fee3f6ee5a10efb5be6f4da6">More...</a><br/></td></tr>
  120. <tr class="separator:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:af29e0113f661e1fbbecc20c268a3be6e"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#af29e0113f661e1fbbecc20c268a3be6e">deadline</a> ()</td></tr>
  122. <tr class="memdesc:af29e0113f661e1fbbecc20c268a3be6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the deadline for the client call. <a href="#af29e0113f661e1fbbecc20c268a3be6e">More...</a><br/></td></tr>
  123. <tr class="separator:af29e0113f661e1fbbecc20c268a3be6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a5057cab6d547678dded90c024efab652"><td class="memItemLeft" align="right" valign="top">gpr_timespec&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a5057cab6d547678dded90c024efab652">raw_deadline</a> ()</td></tr>
  125. <tr class="memdesc:a5057cab6d547678dded90c024efab652"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <em>gpr_timespec</em> representation of the client call's deadline. <a href="#a5057cab6d547678dded90c024efab652">More...</a><br/></td></tr>
  126. <tr class="separator:a5057cab6d547678dded90c024efab652"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a43bb17bbd6ab49face3793e8883c5682"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a43bb17bbd6ab49face3793e8883c5682">set_authority</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;authority)</td></tr>
  128. <tr class="memdesc:a43bb17bbd6ab49face3793e8883c5682"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the per call authority header (see <a href="https://tools.ietf.org/html/rfc7540#section-8.1.2.3">https://tools.ietf.org/html/rfc7540#section-8.1.2.3</a>). <a href="#a43bb17bbd6ab49face3793e8883c5682">More...</a><br/></td></tr>
  129. <tr class="separator:a43bb17bbd6ab49face3793e8883c5682"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a02f279bf74e26d7c32d0b18dc73dccea"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; const <br class="typebreak"/>
  131. <a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a02f279bf74e26d7c32d0b18dc73dccea">auth_context</a> () const </td></tr>
  132. <tr class="memdesc:a02f279bf74e26d7c32d0b18dc73dccea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the authentication context for this client call. <a href="#a02f279bf74e26d7c32d0b18dc73dccea">More...</a><br/></td></tr>
  133. <tr class="separator:a02f279bf74e26d7c32d0b18dc73dccea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:ac09d9bcb018a58c970adbab7ecd201cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ac09d9bcb018a58c970adbab7ecd201cb">set_credentials</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_credentials.html">Credentials</a> &gt; &amp;creds)</td></tr>
  135. <tr class="memdesc:ac09d9bcb018a58c970adbab7ecd201cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set credentials for the client call. <a href="#ac09d9bcb018a58c970adbab7ecd201cb">More...</a><br/></td></tr>
  136. <tr class="separator:ac09d9bcb018a58c970adbab7ecd201cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a91691d52182f45043ce9698424d26a56"><td class="memItemLeft" align="right" valign="top">grpc_compression_algorithm&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a91691d52182f45043ce9698424d26a56">compression_algorithm</a> () const </td></tr>
  138. <tr class="memdesc:a91691d52182f45043ce9698424d26a56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the compression algorithm to be used by the client call. <a href="#a91691d52182f45043ce9698424d26a56">More...</a><br/></td></tr>
  139. <tr class="separator:a91691d52182f45043ce9698424d26a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a67a71b32afe1d71189aa3a24146ec61d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a67a71b32afe1d71189aa3a24146ec61d">set_compression_algorithm</a> (grpc_compression_algorithm algorithm)</td></tr>
  141. <tr class="memdesc:a67a71b32afe1d71189aa3a24146ec61d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the client call. <a href="#a67a71b32afe1d71189aa3a24146ec61d">More...</a><br/></td></tr>
  142. <tr class="separator:a67a71b32afe1d71189aa3a24146ec61d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a905d667d96613e022cd83c13dbedb4c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a905d667d96613e022cd83c13dbedb4c3">peer</a> () const </td></tr>
  144. <tr class="memdesc:a905d667d96613e022cd83c13dbedb4c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the peer uri in a string. <a href="#a905d667d96613e022cd83c13dbedb4c3">More...</a><br/></td></tr>
  145. <tr class="separator:a905d667d96613e022cd83c13dbedb4c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a48672c1e42084d2cd6975746b84658dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a48672c1e42084d2cd6975746b84658dd">set_census_context</a> (struct <a class="el" href="classgrpc_1_1_client_context.html#a958acd964fe9feb32bca775c96ad5117">census_context</a> *ccp)</td></tr>
  147. <tr class="memdesc:a48672c1e42084d2cd6975746b84658dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get and set census context. <a href="#a48672c1e42084d2cd6975746b84658dd">More...</a><br/></td></tr>
  148. <tr class="separator:a48672c1e42084d2cd6975746b84658dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a958acd964fe9feb32bca775c96ad5117"><td class="memItemLeft" align="right" valign="top">struct census_context *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a958acd964fe9feb32bca775c96ad5117">census_context</a> () const </td></tr>
  150. <tr class="separator:a958acd964fe9feb32bca775c96ad5117"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:abd0f6715c30287b75288015eee628984"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#abd0f6715c30287b75288015eee628984">TryCancel</a> ()</td></tr>
  152. <tr class="memdesc:abd0f6715c30287b75288015eee628984"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a best-effort out-of-band cancel. <a href="#abd0f6715c30287b75288015eee628984">More...</a><br/></td></tr>
  153. <tr class="separator:abd0f6715c30287b75288015eee628984"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table><table class="memberdecls">
  155. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  156. Static Public Member Functions</h2></td></tr>
  157. <tr class="memitem:a88cbf7ae863d5fcb382c9e22160f4707"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr<br class="typebreak"/>
  158. &lt; <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a88cbf7ae863d5fcb382c9e22160f4707">FromServerContext</a> (const <a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> &amp;server_context, <a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a> options=<a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>())</td></tr>
  159. <tr class="memdesc:a88cbf7ae863d5fcb382c9e22160f4707"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <em><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a></em> as a child of an incoming server call, according to <em>options</em> (. <a href="#a88cbf7ae863d5fcb382c9e22160f4707">More...</a><br/></td></tr>
  160. <tr class="separator:a88cbf7ae863d5fcb382c9e22160f4707"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. </table><table class="memberdecls">
  162. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  163. Friends</h2></td></tr>
  164. <tr class="memitem:ac4ab4e2d21681704cee0f6e741cc813c"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ac4ab4e2d21681704cee0f6e741cc813c">::grpc::testing::InteropClientContextInspector</a></td></tr>
  165. <tr class="separator:ac4ab4e2d21681704cee0f6e741cc813c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:aa7c3f046b48d55b5a82cbee3fd84faa2"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aa7c3f046b48d55b5a82cbee3fd84faa2">CallOpClientRecvStatus</a></td></tr>
  167. <tr class="separator:aa7c3f046b48d55b5a82cbee3fd84faa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a94ad025954d211da7d27efa58cb2ea91"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a94ad025954d211da7d27efa58cb2ea91">CallOpRecvInitialMetadata</a></td></tr>
  169. <tr class="separator:a94ad025954d211da7d27efa58cb2ea91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ac47342240f21ce36f47485e4ab41a10d"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ac47342240f21ce36f47485e4ab41a10d">Channel</a></td></tr>
  171. <tr class="separator:ac47342240f21ce36f47485e4ab41a10d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  173. <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ade499098cc91745c1c87147d7a7fb7bf">::grpc::ClientReader</a></td></tr>
  174. <tr class="separator:ade499098cc91745c1c87147d7a7fb7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  176. <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a4498fada67d531d99a8642f47d746544">::grpc::ClientWriter</a></td></tr>
  177. <tr class="separator:a4498fada67d531d99a8642f47d746544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplParams" colspan="2">template&lt;class R , class W &gt; </td></tr>
  179. <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a6d5659aa24edba057895be774e2752ec">::grpc::ClientReaderWriter</a></td></tr>
  180. <tr class="separator:a6d5659aa24edba057895be774e2752ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:af5343062a44a5633b144751e59969237"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  182. <tr class="memitem:af5343062a44a5633b144751e59969237"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#af5343062a44a5633b144751e59969237">::grpc::ClientAsyncReader</a></td></tr>
  183. <tr class="separator:af5343062a44a5633b144751e59969237"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:af3547958eadfaeb18692865bd73999ad"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  185. <tr class="memitem:af3547958eadfaeb18692865bd73999ad"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#af3547958eadfaeb18692865bd73999ad">::grpc::ClientAsyncWriter</a></td></tr>
  186. <tr class="separator:af3547958eadfaeb18692865bd73999ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a5c0c96957129933bfe94a299c764eaa7"><td class="memTemplParams" colspan="2">template&lt;class R , class W &gt; </td></tr>
  188. <tr class="memitem:a5c0c96957129933bfe94a299c764eaa7"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a5c0c96957129933bfe94a299c764eaa7">::grpc::ClientAsyncReaderWriter</a></td></tr>
  189. <tr class="separator:a5c0c96957129933bfe94a299c764eaa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a4b00162a9bd86e07669f2af67f85c73a"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  191. <tr class="memitem:a4b00162a9bd86e07669f2af67f85c73a"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a4b00162a9bd86e07669f2af67f85c73a">::grpc::ClientAsyncResponseReader</a></td></tr>
  192. <tr class="separator:a4b00162a9bd86e07669f2af67f85c73a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:ac574143322bf2bc6bd324ccb22d40756"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  194. <tr class="memitem:ac574143322bf2bc6bd324ccb22d40756"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ac574143322bf2bc6bd324ccb22d40756">BlockingUnaryCall</a> (<a class="el" href="classgrpc_1_1_channel.html">Channel</a> *channel, const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;method, <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *context, const InputMessage &amp;request, OutputMessage *result)</td></tr>
  195. <tr class="separator:ac574143322bf2bc6bd324ccb22d40756"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. </table>
  197. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  198. <a class="anchor" id="acabbcf3c160a0628da8a9274b10f54b9"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">grpc::ClientContext::ClientContext </td>
  204. <td>(</td>
  205. <td class="paramname"></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. </div>
  211. </div>
  212. <a class="anchor" id="aeb77ea760faf8f96e775812806c0a3d9"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">grpc::ClientContext::~ClientContext </td>
  218. <td>(</td>
  219. <td class="paramname"></td><td>)</td>
  220. <td></td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. </div>
  225. </div>
  226. <h2 class="groupheader">Member Function Documentation</h2>
  227. <a class="anchor" id="a69a026f073ef5934697568d689440bd4"></a>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">void grpc::ClientContext::AddMetadata </td>
  233. <td>(</td>
  234. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  235. <td class="paramname"><em>meta_key</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  241. <td class="paramname"><em>meta_value</em>&#160;</td>
  242. </tr>
  243. <tr>
  244. <td></td>
  245. <td>)</td>
  246. <td></td><td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Add the (<em>meta_key</em>, <em>meta_value</em>) pair to the metadata associated with a client call. </p>
  251. <p>These are made available at the server side by the <em><a class="el" href="classgrpc_1_1_server_context.html#a144de24bd56a8950676ba91913cc74ce">grpc::ServerContext::client_metadata()</a></em> method.</p>
  252. <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before invoking the rpc.</dd></dl>
  253. <dl class="params"><dt>Parameters</dt><dd>
  254. <table class="params">
  255. <tr><td class="paramname">meta_key</td><td>The metadata key. If <em>meta_value</em> is binary data, it must end in "-bin". </td></tr>
  256. <tr><td class="paramname">meta_value</td><td>The metadata value. If its value is binary, it must be base64-encoding (see <a href="https://tools.ietf.org/html/rfc4648#section-4">https://tools.ietf.org/html/rfc4648#section-4</a>) and <em>meta_key</em> must end in "-bin". </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. </div>
  261. </div>
  262. <a class="anchor" id="a02f279bf74e26d7c32d0b18dc73dccea"></a>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">std::shared_ptr&lt;const <a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</a>&gt; grpc::ClientContext::auth_context </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td> const</td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Return the authentication context for this client call. </p>
  275. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classgrpc_1_1_auth_context.html" title="Class encapsulating the Authentication Information. ">grpc::AuthContext</a>. </dd></dl>
  276. </div>
  277. </div>
  278. <a class="anchor" id="a958acd964fe9feb32bca775c96ad5117"></a>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="mlabels">
  282. <tr>
  283. <td class="mlabels-left">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">struct census_context* grpc::ClientContext::census_context </td>
  287. <td>(</td>
  288. <td class="paramname"></td><td>)</td>
  289. <td> const</td>
  290. </tr>
  291. </table>
  292. </td>
  293. <td class="mlabels-right">
  294. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. </div>
  299. </div>
  300. <a class="anchor" id="a91691d52182f45043ce9698424d26a56"></a>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="mlabels">
  304. <tr>
  305. <td class="mlabels-left">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">grpc_compression_algorithm grpc::ClientContext::compression_algorithm </td>
  309. <td>(</td>
  310. <td class="paramname"></td><td>)</td>
  311. <td> const</td>
  312. </tr>
  313. </table>
  314. </td>
  315. <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Return the compression algorithm to be used by the client call. </p>
  321. </div>
  322. </div>
  323. <a class="anchor" id="af29e0113f661e1fbbecc20c268a3be6e"></a>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="mlabels">
  327. <tr>
  328. <td class="mlabels-left">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">std::chrono::system_clock::time_point grpc::ClientContext::deadline </td>
  332. <td>(</td>
  333. <td class="paramname"></td><td>)</td>
  334. <td></td>
  335. </tr>
  336. </table>
  337. </td>
  338. <td class="mlabels-right">
  339. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Return the deadline for the client call. </p>
  344. </div>
  345. </div>
  346. <a class="anchor" id="a88cbf7ae863d5fcb382c9e22160f4707"></a>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="mlabels">
  350. <tr>
  351. <td class="mlabels-left">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">static std::unique_ptr&lt;<a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a>&gt; grpc::ClientContext::FromServerContext </td>
  355. <td>(</td>
  356. <td class="paramtype">const <a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> &amp;&#160;</td>
  357. <td class="paramname"><em>server_context</em>, </td>
  358. </tr>
  359. <tr>
  360. <td class="paramkey"></td>
  361. <td></td>
  362. <td class="paramtype"><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>&#160;</td>
  363. <td class="paramname"><em>options</em> = <code><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>()</code>&#160;</td>
  364. </tr>
  365. <tr>
  366. <td></td>
  367. <td>)</td>
  368. <td></td><td></td>
  369. </tr>
  370. </table>
  371. </td>
  372. <td class="mlabels-right">
  373. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Create a new <em><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a></em> as a child of an incoming server call, according to <em>options</em> (. </p>
  378. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classgrpc_1_1_propagation_options.html" title="Options for ClientContext::FromServerContext specifying which traits from the ServerContext to propag...">PropagationOptions</a>).</dd></dl>
  379. <dl class="params"><dt>Parameters</dt><dd>
  380. <table class="params">
  381. <tr><td class="paramname">server_context</td><td>The source server context to use as the basis for constructing the client context. </td></tr>
  382. <tr><td class="paramname">options</td><td>The options controlling what to copy from the <em>server_context</em>.</td></tr>
  383. </table>
  384. </dd>
  385. </dl>
  386. <dl class="section return"><dt>Returns</dt><dd>A newly constructed <em><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a></em> instance based on <em>server_context</em>, with traits propagated (copied) according to <em>options</em>. </dd></dl>
  387. </div>
  388. </div>
  389. <a class="anchor" id="a3dd6ec0742cbc84e5a83acab009c5f38"></a>
  390. <div class="memitem">
  391. <div class="memproto">
  392. <table class="mlabels">
  393. <tr>
  394. <td class="mlabels-left">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname">const std::multimap&lt;<a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&gt;&amp; grpc::ClientContext::GetServerInitialMetadata </td>
  398. <td>(</td>
  399. <td class="paramname"></td><td>)</td>
  400. <td></td>
  401. </tr>
  402. </table>
  403. </td>
  404. <td class="mlabels-right">
  405. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Return a collection of initial metadata key-value pairs. </p>
  410. <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
  411. <dl class="section warning"><dt>Warning</dt><dd>This method should only be called after initial metadata has been received. For streaming calls, see <em><a class="el" href="classgrpc_1_1_client_reader_interface.html#aee87dd6e3e8a40853207ceb53b590b19" title="Blocking wait for initial metadata from server. ">ClientReaderInterface::WaitForInitialMetadata()</a></em>.</dd></dl>
  412. <dl class="section return"><dt>Returns</dt><dd>A multimap of initial metadata key-value pairs from the server. </dd></dl>
  413. </div>
  414. </div>
  415. <a class="anchor" id="a06cd5278c2d242bdd6a8f62fd6c87a93"></a>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="mlabels">
  419. <tr>
  420. <td class="mlabels-left">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname">const std::multimap&lt;<a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>&gt;&amp; grpc::ClientContext::GetServerTrailingMetadata </td>
  424. <td>(</td>
  425. <td class="paramname"></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </td>
  430. <td class="mlabels-right">
  431. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Return a collection of trailing metadata key-value pairs. </p>
  436. <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
  437. <dl class="section warning"><dt>Warning</dt><dd>This method is only callable once the stream has finished.</dd></dl>
  438. <dl class="section return"><dt>Returns</dt><dd>A multimap of metadata trailing key-value pairs from the server. </dd></dl>
  439. </div>
  440. </div>
  441. <a class="anchor" id="a905d667d96613e022cd83c13dbedb4c3"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::ClientContext::peer </td>
  447. <td>(</td>
  448. <td class="paramname"></td><td>)</td>
  449. <td> const</td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Return the peer uri in a string. </p>
  454. <dl class="section warning"><dt>Warning</dt><dd>This value is never authenticated or subject to any security related code. It must not be used for any authentication related functionality. Instead, use auth_context.</dd></dl>
  455. <dl class="section return"><dt>Returns</dt><dd>The call's peer URI. </dd></dl>
  456. </div>
  457. </div>
  458. <a class="anchor" id="a5057cab6d547678dded90c024efab652"></a>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="mlabels">
  462. <tr>
  463. <td class="mlabels-left">
  464. <table class="memname">
  465. <tr>
  466. <td class="memname">gpr_timespec grpc::ClientContext::raw_deadline </td>
  467. <td>(</td>
  468. <td class="paramname"></td><td>)</td>
  469. <td></td>
  470. </tr>
  471. </table>
  472. </td>
  473. <td class="mlabels-right">
  474. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <p>Return a <em>gpr_timespec</em> representation of the client call's deadline. </p>
  479. </div>
  480. </div>
  481. <a class="anchor" id="a43bb17bbd6ab49face3793e8883c5682"></a>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">void grpc::ClientContext::set_authority </td>
  490. <td>(</td>
  491. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  492. <td class="paramname"><em>authority</em></td><td>)</td>
  493. <td></td>
  494. </tr>
  495. </table>
  496. </td>
  497. <td class="mlabels-right">
  498. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  499. </tr>
  500. </table>
  501. </div><div class="memdoc">
  502. <p>Set the per call authority header (see <a href="https://tools.ietf.org/html/rfc7540#section-8.1.2.3">https://tools.ietf.org/html/rfc7540#section-8.1.2.3</a>). </p>
  503. </div>
  504. </div>
  505. <a class="anchor" id="a48672c1e42084d2cd6975746b84658dd"></a>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="mlabels">
  509. <tr>
  510. <td class="mlabels-left">
  511. <table class="memname">
  512. <tr>
  513. <td class="memname">void grpc::ClientContext::set_census_context </td>
  514. <td>(</td>
  515. <td class="paramtype">struct <a class="el" href="classgrpc_1_1_client_context.html#a958acd964fe9feb32bca775c96ad5117">census_context</a> *&#160;</td>
  516. <td class="paramname"><em>ccp</em></td><td>)</td>
  517. <td></td>
  518. </tr>
  519. </table>
  520. </td>
  521. <td class="mlabels-right">
  522. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  523. </tr>
  524. </table>
  525. </div><div class="memdoc">
  526. <p>Get and set census context. </p>
  527. </div>
  528. </div>
  529. <a class="anchor" id="a67a71b32afe1d71189aa3a24146ec61d"></a>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname">void grpc::ClientContext::set_compression_algorithm </td>
  535. <td>(</td>
  536. <td class="paramtype">grpc_compression_algorithm&#160;</td>
  537. <td class="paramname"><em>algorithm</em></td><td>)</td>
  538. <td></td>
  539. </tr>
  540. </table>
  541. </div><div class="memdoc">
  542. <p>Set <em>algorithm</em> to be the compression algorithm used for the client call. </p>
  543. <dl class="params"><dt>Parameters</dt><dd>
  544. <table class="params">
  545. <tr><td class="paramname">algorith</td><td>The compression algorithm used for the client call. </td></tr>
  546. </table>
  547. </dd>
  548. </dl>
  549. </div>
  550. </div>
  551. <a class="anchor" id="ac09d9bcb018a58c970adbab7ecd201cb"></a>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <table class="mlabels">
  555. <tr>
  556. <td class="mlabels-left">
  557. <table class="memname">
  558. <tr>
  559. <td class="memname">void grpc::ClientContext::set_credentials </td>
  560. <td>(</td>
  561. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_credentials.html">Credentials</a> &gt; &amp;&#160;</td>
  562. <td class="paramname"><em>creds</em></td><td>)</td>
  563. <td></td>
  564. </tr>
  565. </table>
  566. </td>
  567. <td class="mlabels-right">
  568. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. <p>Set credentials for the client call. </p>
  573. <p>A credentials object encapsulates all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client’s identity, role, or whether it is authorized to make a particular call.</p>
  574. <dl class="section see"><dt>See Also</dt><dd><a href="https://github.com/grpc/grpc/blob/master/doc/grpc-auth-support.md">https://github.com/grpc/grpc/blob/master/doc/grpc-auth-support.md</a> </dd></dl>
  575. </div>
  576. </div>
  577. <a class="anchor" id="ad4e16866fee3f6ee5a10efb5be6f4da6"></a>
  578. <div class="memitem">
  579. <div class="memproto">
  580. <div class="memtemplate">
  581. template&lt;typename T &gt; </div>
  582. <table class="mlabels">
  583. <tr>
  584. <td class="mlabels-left">
  585. <table class="memname">
  586. <tr>
  587. <td class="memname">void grpc::ClientContext::set_deadline </td>
  588. <td>(</td>
  589. <td class="paramtype">const T &amp;&#160;</td>
  590. <td class="paramname"><em>deadline</em></td><td>)</td>
  591. <td></td>
  592. </tr>
  593. </table>
  594. </td>
  595. <td class="mlabels-right">
  596. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  597. </tr>
  598. </table>
  599. </div><div class="memdoc">
  600. <p>Set the deadline for the client call. </p>
  601. <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before invoking the rpc.</dd></dl>
  602. <dl class="params"><dt>Parameters</dt><dd>
  603. <table class="params">
  604. <tr><td class="paramname">deadline</td><td>the deadline for the client call. Units are determined by the type used. </td></tr>
  605. </table>
  606. </dd>
  607. </dl>
  608. </div>
  609. </div>
  610. <a class="anchor" id="abd0f6715c30287b75288015eee628984"></a>
  611. <div class="memitem">
  612. <div class="memproto">
  613. <table class="memname">
  614. <tr>
  615. <td class="memname">void grpc::ClientContext::TryCancel </td>
  616. <td>(</td>
  617. <td class="paramname"></td><td>)</td>
  618. <td></td>
  619. </tr>
  620. </table>
  621. </div><div class="memdoc">
  622. <p>Send a best-effort out-of-band cancel. </p>
  623. <p>The call could be in any stage. e.g. if it is already finished, it may still return success.</p>
  624. <p>There is no guarantee the call will be cancelled. </p>
  625. </div>
  626. </div>
  627. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  628. <a class="anchor" id="af5343062a44a5633b144751e59969237"></a>
  629. <div class="memitem">
  630. <div class="memproto">
  631. <div class="memtemplate">
  632. template&lt;class R &gt; </div>
  633. <table class="mlabels">
  634. <tr>
  635. <td class="mlabels-left">
  636. <table class="memname">
  637. <tr>
  638. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_reader.html">grpc::ClientAsyncReader</a></td>
  639. </tr>
  640. </table>
  641. </td>
  642. <td class="mlabels-right">
  643. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  644. </tr>
  645. </table>
  646. </div><div class="memdoc">
  647. </div>
  648. </div>
  649. <a class="anchor" id="a5c0c96957129933bfe94a299c764eaa7"></a>
  650. <div class="memitem">
  651. <div class="memproto">
  652. <div class="memtemplate">
  653. template&lt;class R , class W &gt; </div>
  654. <table class="mlabels">
  655. <tr>
  656. <td class="mlabels-left">
  657. <table class="memname">
  658. <tr>
  659. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a></td>
  660. </tr>
  661. </table>
  662. </td>
  663. <td class="mlabels-right">
  664. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  665. </tr>
  666. </table>
  667. </div><div class="memdoc">
  668. </div>
  669. </div>
  670. <a class="anchor" id="a4b00162a9bd86e07669f2af67f85c73a"></a>
  671. <div class="memitem">
  672. <div class="memproto">
  673. <div class="memtemplate">
  674. template&lt;class R &gt; </div>
  675. <table class="mlabels">
  676. <tr>
  677. <td class="mlabels-left">
  678. <table class="memname">
  679. <tr>
  680. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a></td>
  681. </tr>
  682. </table>
  683. </td>
  684. <td class="mlabels-right">
  685. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  686. </tr>
  687. </table>
  688. </div><div class="memdoc">
  689. </div>
  690. </div>
  691. <a class="anchor" id="af3547958eadfaeb18692865bd73999ad"></a>
  692. <div class="memitem">
  693. <div class="memproto">
  694. <div class="memtemplate">
  695. template&lt;class W &gt; </div>
  696. <table class="mlabels">
  697. <tr>
  698. <td class="mlabels-left">
  699. <table class="memname">
  700. <tr>
  701. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a></td>
  702. </tr>
  703. </table>
  704. </td>
  705. <td class="mlabels-right">
  706. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  707. </tr>
  708. </table>
  709. </div><div class="memdoc">
  710. </div>
  711. </div>
  712. <a class="anchor" id="ade499098cc91745c1c87147d7a7fb7bf"></a>
  713. <div class="memitem">
  714. <div class="memproto">
  715. <div class="memtemplate">
  716. template&lt;class R &gt; </div>
  717. <table class="mlabels">
  718. <tr>
  719. <td class="mlabels-left">
  720. <table class="memname">
  721. <tr>
  722. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
  723. </tr>
  724. </table>
  725. </td>
  726. <td class="mlabels-right">
  727. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  728. </tr>
  729. </table>
  730. </div><div class="memdoc">
  731. </div>
  732. </div>
  733. <a class="anchor" id="a6d5659aa24edba057895be774e2752ec"></a>
  734. <div class="memitem">
  735. <div class="memproto">
  736. <div class="memtemplate">
  737. template&lt;class R , class W &gt; </div>
  738. <table class="mlabels">
  739. <tr>
  740. <td class="mlabels-left">
  741. <table class="memname">
  742. <tr>
  743. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
  744. </tr>
  745. </table>
  746. </td>
  747. <td class="mlabels-right">
  748. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  749. </tr>
  750. </table>
  751. </div><div class="memdoc">
  752. </div>
  753. </div>
  754. <a class="anchor" id="a4498fada67d531d99a8642f47d746544"></a>
  755. <div class="memitem">
  756. <div class="memproto">
  757. <div class="memtemplate">
  758. template&lt;class W &gt; </div>
  759. <table class="mlabels">
  760. <tr>
  761. <td class="mlabels-left">
  762. <table class="memname">
  763. <tr>
  764. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
  765. </tr>
  766. </table>
  767. </td>
  768. <td class="mlabels-right">
  769. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  770. </tr>
  771. </table>
  772. </div><div class="memdoc">
  773. </div>
  774. </div>
  775. <a class="anchor" id="ac4ab4e2d21681704cee0f6e741cc813c"></a>
  776. <div class="memitem">
  777. <div class="memproto">
  778. <table class="mlabels">
  779. <tr>
  780. <td class="mlabels-left">
  781. <table class="memname">
  782. <tr>
  783. <td class="memname">friend class ::grpc::testing::InteropClientContextInspector</td>
  784. </tr>
  785. </table>
  786. </td>
  787. <td class="mlabels-right">
  788. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  789. </tr>
  790. </table>
  791. </div><div class="memdoc">
  792. </div>
  793. </div>
  794. <a class="anchor" id="ac574143322bf2bc6bd324ccb22d40756"></a>
  795. <div class="memitem">
  796. <div class="memproto">
  797. <div class="memtemplate">
  798. template&lt;class InputMessage , class OutputMessage &gt; </div>
  799. <table class="mlabels">
  800. <tr>
  801. <td class="mlabels-left">
  802. <table class="memname">
  803. <tr>
  804. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> BlockingUnaryCall </td>
  805. <td>(</td>
  806. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel.html">Channel</a> *&#160;</td>
  807. <td class="paramname"><em>channel</em>, </td>
  808. </tr>
  809. <tr>
  810. <td class="paramkey"></td>
  811. <td></td>
  812. <td class="paramtype">const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;&#160;</td>
  813. <td class="paramname"><em>method</em>, </td>
  814. </tr>
  815. <tr>
  816. <td class="paramkey"></td>
  817. <td></td>
  818. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *&#160;</td>
  819. <td class="paramname"><em>context</em>, </td>
  820. </tr>
  821. <tr>
  822. <td class="paramkey"></td>
  823. <td></td>
  824. <td class="paramtype">const InputMessage &amp;&#160;</td>
  825. <td class="paramname"><em>request</em>, </td>
  826. </tr>
  827. <tr>
  828. <td class="paramkey"></td>
  829. <td></td>
  830. <td class="paramtype">OutputMessage *&#160;</td>
  831. <td class="paramname"><em>result</em>&#160;</td>
  832. </tr>
  833. <tr>
  834. <td></td>
  835. <td>)</td>
  836. <td></td><td></td>
  837. </tr>
  838. </table>
  839. </td>
  840. <td class="mlabels-right">
  841. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  842. </tr>
  843. </table>
  844. </div><div class="memdoc">
  845. </div>
  846. </div>
  847. <a class="anchor" id="aa7c3f046b48d55b5a82cbee3fd84faa2"></a>
  848. <div class="memitem">
  849. <div class="memproto">
  850. <table class="mlabels">
  851. <tr>
  852. <td class="mlabels-left">
  853. <table class="memname">
  854. <tr>
  855. <td class="memname">friend class <a class="el" href="classgrpc_1_1_call_op_client_recv_status.html">CallOpClientRecvStatus</a></td>
  856. </tr>
  857. </table>
  858. </td>
  859. <td class="mlabels-right">
  860. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  861. </tr>
  862. </table>
  863. </div><div class="memdoc">
  864. </div>
  865. </div>
  866. <a class="anchor" id="a94ad025954d211da7d27efa58cb2ea91"></a>
  867. <div class="memitem">
  868. <div class="memproto">
  869. <table class="mlabels">
  870. <tr>
  871. <td class="mlabels-left">
  872. <table class="memname">
  873. <tr>
  874. <td class="memname">friend class <a class="el" href="classgrpc_1_1_call_op_recv_initial_metadata.html">CallOpRecvInitialMetadata</a></td>
  875. </tr>
  876. </table>
  877. </td>
  878. <td class="mlabels-right">
  879. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  880. </tr>
  881. </table>
  882. </div><div class="memdoc">
  883. </div>
  884. </div>
  885. <a class="anchor" id="ac47342240f21ce36f47485e4ab41a10d"></a>
  886. <div class="memitem">
  887. <div class="memproto">
  888. <table class="mlabels">
  889. <tr>
  890. <td class="mlabels-left">
  891. <table class="memname">
  892. <tr>
  893. <td class="memname">friend class <a class="el" href="classgrpc_1_1_channel.html">Channel</a></td>
  894. </tr>
  895. </table>
  896. </td>
  897. <td class="mlabels-right">
  898. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  899. </tr>
  900. </table>
  901. </div><div class="memdoc">
  902. </div>
  903. </div>
  904. <hr/>The documentation for this class was generated from the following file:<ul>
  905. <li>include/grpc++/<a class="el" href="client__context_8h_source.html">client_context.h</a></li>
  906. </ul>
  907. </div><!-- contents -->
  908. <!-- start footer part -->
  909. <hr class="footer"/><address class="footer"><small>
  910. Generated on Tue Oct 27 2015 21:07:30 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  911. <img class="footer" src="doxygen.png" alt="doxygen"/>
  912. </a> 1.8.6
  913. </small></address>
  914. </body>
  915. </html>