classgrpc_1_1_client_context.html 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996
  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.13.1-pre1</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="#nested-classes">Data Structures</a> &#124;
  90. <a href="#pub-methods">Public Member Functions</a> &#124;
  91. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  92. <a href="#friends">Friends</a> </div>
  93. <div class="headertitle">
  94. <div class="title">grpc::ClientContext Class Reference</div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <p><code>#include &lt;<a class="el" href="impl_2codegen_2client__context_8h_source.html">client_context.h</a>&gt;</code></p>
  98. <table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  100. Data Structures</h2></td></tr>
  101. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context_1_1_global_callbacks.html">GlobalCallbacks</a></td></tr>
  102. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Global Callbacks. <a href="classgrpc_1_1_client_context_1_1_global_callbacks.html#details">More...</a><br/></td></tr>
  103. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  106. Public Member Functions</h2></td></tr>
  107. <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>
  108. <tr class="separator:acabbcf3c160a0628da8a9274b10f54b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:aeb77ea760faf8f96e775812806c0a3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <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>
  113. <tr class="separator:a69a026f073ef5934697568d689440bd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a3dd6ec0742cbc84e5a83acab009c5f38"><td class="memItemLeft" align="right" valign="top">const std::multimap<br class="typebreak"/>
  115. &lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <br class="typebreak"/>
  116. <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>
  117. <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>
  118. <tr class="separator:a3dd6ec0742cbc84e5a83acab009c5f38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a06cd5278c2d242bdd6a8f62fd6c87a93"><td class="memItemLeft" align="right" valign="top">const std::multimap<br class="typebreak"/>
  120. &lt; <a class="el" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>, <br class="typebreak"/>
  121. <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>
  122. <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>
  123. <tr class="separator:a06cd5278c2d242bdd6a8f62fd6c87a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  125. <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>
  126. <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>
  127. <tr class="separator:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <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>
  130. <tr class="separator:af29e0113f661e1fbbecc20c268a3be6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <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>
  133. <tr class="separator:a5057cab6d547678dded90c024efab652"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <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>
  135. <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>
  136. <tr class="separator:a43bb17bbd6ab49face3793e8883c5682"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a02f279bf74e26d7c32d0b18dc73dccea"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; const <br class="typebreak"/>
  138. <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>
  139. <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>
  140. <tr class="separator:a02f279bf74e26d7c32d0b18dc73dccea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a768356886d37231b3f0853b3c38e48a9"><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#a768356886d37231b3f0853b3c38e48a9">set_credentials</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;creds)</td></tr>
  142. <tr class="memdesc:a768356886d37231b3f0853b3c38e48a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set credentials for the client call. <a href="#a768356886d37231b3f0853b3c38e48a9">More...</a><br/></td></tr>
  143. <tr class="separator:a768356886d37231b3f0853b3c38e48a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <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>
  146. <tr class="separator:a91691d52182f45043ce9698424d26a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <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>
  149. <tr class="separator:a67a71b32afe1d71189aa3a24146ec61d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <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>
  152. <tr class="separator:a905d667d96613e022cd83c13dbedb4c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <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>
  154. <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>
  155. <tr class="separator:a48672c1e42084d2cd6975746b84658dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a958acd964fe9feb32bca775c96ad5117"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <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>
  160. <tr class="separator:abd0f6715c30287b75288015eee628984"><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="pub-static-methods"></a>
  163. Static Public Member Functions</h2></td></tr>
  164. <tr class="memitem:a88cbf7ae863d5fcb382c9e22160f4707"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr<br class="typebreak"/>
  165. &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>
  166. <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>
  167. <tr class="separator:a88cbf7ae863d5fcb382c9e22160f4707"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ad329c9fdd77093361518ef8ace1ee1f0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ad329c9fdd77093361518ef8ace1ee1f0">SetGlobalCallbacks</a> (<a class="el" href="classgrpc_1_1_client_context_1_1_global_callbacks.html">GlobalCallbacks</a> *callbacks)</td></tr>
  169. <tr class="separator:ad329c9fdd77093361518ef8ace1ee1f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. </table><table class="memberdecls">
  171. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  172. Friends</h2></td></tr>
  173. <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>
  174. <tr class="separator:ac4ab4e2d21681704cee0f6e741cc813c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <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>
  176. <tr class="separator:aa7c3f046b48d55b5a82cbee3fd84faa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <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>
  178. <tr class="separator:a94ad025954d211da7d27efa58cb2ea91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <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>
  180. <tr class="separator:ac47342240f21ce36f47485e4ab41a10d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  182. <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>
  183. <tr class="separator:ade499098cc91745c1c87147d7a7fb7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  185. <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>
  186. <tr class="separator:a4498fada67d531d99a8642f47d746544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  188. <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>
  189. <tr class="separator:a6d5659aa24edba057895be774e2752ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:af5343062a44a5633b144751e59969237"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  191. <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>
  192. <tr class="separator:af5343062a44a5633b144751e59969237"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:af3547958eadfaeb18692865bd73999ad"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  194. <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>
  195. <tr class="separator:af3547958eadfaeb18692865bd73999ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:a5c0c96957129933bfe94a299c764eaa7"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  197. <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>
  198. <tr class="separator:a5c0c96957129933bfe94a299c764eaa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:a4b00162a9bd86e07669f2af67f85c73a"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  200. <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>
  201. <tr class="separator:a4b00162a9bd86e07669f2af67f85c73a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a4aac0a120f3498d1151460ef89ce8446"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  203. <tr class="memitem:a4aac0a120f3498d1151460ef89ce8446"><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#a4aac0a120f3498d1151460ef89ce8446">BlockingUnaryCall</a> (<a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</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>
  204. <tr class="separator:a4aac0a120f3498d1151460ef89ce8446"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. </table>
  206. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  207. <a class="anchor" id="acabbcf3c160a0628da8a9274b10f54b9"></a>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">grpc::ClientContext::ClientContext </td>
  213. <td>(</td>
  214. <td class="paramname"></td><td>)</td>
  215. <td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. </div>
  220. </div>
  221. <a class="anchor" id="aeb77ea760faf8f96e775812806c0a3d9"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">grpc::ClientContext::~ClientContext </td>
  227. <td>(</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. </div>
  234. </div>
  235. <h2 class="groupheader">Member Function Documentation</h2>
  236. <a class="anchor" id="a69a026f073ef5934697568d689440bd4"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">void grpc::ClientContext::AddMetadata </td>
  242. <td>(</td>
  243. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  244. <td class="paramname"><em>meta_key</em>, </td>
  245. </tr>
  246. <tr>
  247. <td class="paramkey"></td>
  248. <td></td>
  249. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  250. <td class="paramname"><em>meta_value</em>&#160;</td>
  251. </tr>
  252. <tr>
  253. <td></td>
  254. <td>)</td>
  255. <td></td><td></td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <p>Add the (<em>meta_key</em>, <em>meta_value</em>) pair to the metadata associated with a client call. </p>
  260. <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>
  261. <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before invoking the rpc.</dd></dl>
  262. <dl class="params"><dt>Parameters</dt><dd>
  263. <table class="params">
  264. <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>
  265. <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>
  266. </table>
  267. </dd>
  268. </dl>
  269. </div>
  270. </div>
  271. <a class="anchor" id="a02f279bf74e26d7c32d0b18dc73dccea"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <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>
  277. <td>(</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td> const</td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Return the authentication context for this client call. </p>
  284. <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>
  285. </div>
  286. </div>
  287. <a class="anchor" id="a958acd964fe9feb32bca775c96ad5117"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="mlabels">
  291. <tr>
  292. <td class="mlabels-left">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">struct census_context* grpc::ClientContext::census_context </td>
  296. <td>(</td>
  297. <td class="paramname"></td><td>)</td>
  298. <td> const</td>
  299. </tr>
  300. </table>
  301. </td>
  302. <td class="mlabels-right">
  303. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. </div>
  308. </div>
  309. <a class="anchor" id="a91691d52182f45043ce9698424d26a56"></a>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="mlabels">
  313. <tr>
  314. <td class="mlabels-left">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">grpc_compression_algorithm grpc::ClientContext::compression_algorithm </td>
  318. <td>(</td>
  319. <td class="paramname"></td><td>)</td>
  320. <td> const</td>
  321. </tr>
  322. </table>
  323. </td>
  324. <td class="mlabels-right">
  325. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>Return the compression algorithm to be used by the client call. </p>
  330. </div>
  331. </div>
  332. <a class="anchor" id="af29e0113f661e1fbbecc20c268a3be6e"></a>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="mlabels">
  336. <tr>
  337. <td class="mlabels-left">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">std::chrono::system_clock::time_point grpc::ClientContext::deadline </td>
  341. <td>(</td>
  342. <td class="paramname"></td><td>)</td>
  343. <td></td>
  344. </tr>
  345. </table>
  346. </td>
  347. <td class="mlabels-right">
  348. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>Return the deadline for the client call. </p>
  353. </div>
  354. </div>
  355. <a class="anchor" id="a88cbf7ae863d5fcb382c9e22160f4707"></a>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="mlabels">
  359. <tr>
  360. <td class="mlabels-left">
  361. <table class="memname">
  362. <tr>
  363. <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>
  364. <td>(</td>
  365. <td class="paramtype">const <a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> &amp;&#160;</td>
  366. <td class="paramname"><em>server_context</em>, </td>
  367. </tr>
  368. <tr>
  369. <td class="paramkey"></td>
  370. <td></td>
  371. <td class="paramtype"><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>&#160;</td>
  372. <td class="paramname"><em>options</em> = <code><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>()</code>&#160;</td>
  373. </tr>
  374. <tr>
  375. <td></td>
  376. <td>)</td>
  377. <td></td><td></td>
  378. </tr>
  379. </table>
  380. </td>
  381. <td class="mlabels-right">
  382. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <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>
  387. <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>
  388. <dl class="params"><dt>Parameters</dt><dd>
  389. <table class="params">
  390. <tr><td class="paramname">server_context</td><td>The source server context to use as the basis for constructing the client context. </td></tr>
  391. <tr><td class="paramname">options</td><td>The options controlling what to copy from the <em>server_context</em>.</td></tr>
  392. </table>
  393. </dd>
  394. </dl>
  395. <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>
  396. </div>
  397. </div>
  398. <a class="anchor" id="a3dd6ec0742cbc84e5a83acab009c5f38"></a>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <table class="mlabels">
  402. <tr>
  403. <td class="mlabels-left">
  404. <table class="memname">
  405. <tr>
  406. <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>
  407. <td>(</td>
  408. <td class="paramname"></td><td>)</td>
  409. <td></td>
  410. </tr>
  411. </table>
  412. </td>
  413. <td class="mlabels-right">
  414. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Return a collection of initial metadata key-value pairs. </p>
  419. <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
  420. <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>
  421. <dl class="section return"><dt>Returns</dt><dd>A multimap of initial metadata key-value pairs from the server. </dd></dl>
  422. </div>
  423. </div>
  424. <a class="anchor" id="a06cd5278c2d242bdd6a8f62fd6c87a93"></a>
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="mlabels">
  428. <tr>
  429. <td class="mlabels-left">
  430. <table class="memname">
  431. <tr>
  432. <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>
  433. <td>(</td>
  434. <td class="paramname"></td><td>)</td>
  435. <td></td>
  436. </tr>
  437. </table>
  438. </td>
  439. <td class="mlabels-right">
  440. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  441. </tr>
  442. </table>
  443. </div><div class="memdoc">
  444. <p>Return a collection of trailing metadata key-value pairs. </p>
  445. <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
  446. <dl class="section warning"><dt>Warning</dt><dd>This method is only callable once the stream has finished.</dd></dl>
  447. <dl class="section return"><dt>Returns</dt><dd>A multimap of metadata trailing key-value pairs from the server. </dd></dl>
  448. </div>
  449. </div>
  450. <a class="anchor" id="a905d667d96613e022cd83c13dbedb4c3"></a>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="memname">
  454. <tr>
  455. <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::ClientContext::peer </td>
  456. <td>(</td>
  457. <td class="paramname"></td><td>)</td>
  458. <td> const</td>
  459. </tr>
  460. </table>
  461. </div><div class="memdoc">
  462. <p>Return the peer uri in a string. </p>
  463. <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>
  464. <dl class="section return"><dt>Returns</dt><dd>The call's peer URI. </dd></dl>
  465. </div>
  466. </div>
  467. <a class="anchor" id="a5057cab6d547678dded90c024efab652"></a>
  468. <div class="memitem">
  469. <div class="memproto">
  470. <table class="mlabels">
  471. <tr>
  472. <td class="mlabels-left">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">gpr_timespec grpc::ClientContext::raw_deadline </td>
  476. <td>(</td>
  477. <td class="paramname"></td><td>)</td>
  478. <td></td>
  479. </tr>
  480. </table>
  481. </td>
  482. <td class="mlabels-right">
  483. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. <p>Return a <em>gpr_timespec</em> representation of the client call's deadline. </p>
  488. </div>
  489. </div>
  490. <a class="anchor" id="a43bb17bbd6ab49face3793e8883c5682"></a>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="mlabels">
  494. <tr>
  495. <td class="mlabels-left">
  496. <table class="memname">
  497. <tr>
  498. <td class="memname">void grpc::ClientContext::set_authority </td>
  499. <td>(</td>
  500. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  501. <td class="paramname"><em>authority</em></td><td>)</td>
  502. <td></td>
  503. </tr>
  504. </table>
  505. </td>
  506. <td class="mlabels-right">
  507. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <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>
  512. </div>
  513. </div>
  514. <a class="anchor" id="a48672c1e42084d2cd6975746b84658dd"></a>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="mlabels">
  518. <tr>
  519. <td class="mlabels-left">
  520. <table class="memname">
  521. <tr>
  522. <td class="memname">void grpc::ClientContext::set_census_context </td>
  523. <td>(</td>
  524. <td class="paramtype">struct <a class="el" href="classgrpc_1_1_client_context.html#a958acd964fe9feb32bca775c96ad5117">census_context</a> *&#160;</td>
  525. <td class="paramname"><em>ccp</em></td><td>)</td>
  526. <td></td>
  527. </tr>
  528. </table>
  529. </td>
  530. <td class="mlabels-right">
  531. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. <p>Get and set census context. </p>
  536. </div>
  537. </div>
  538. <a class="anchor" id="a67a71b32afe1d71189aa3a24146ec61d"></a>
  539. <div class="memitem">
  540. <div class="memproto">
  541. <table class="memname">
  542. <tr>
  543. <td class="memname">void grpc::ClientContext::set_compression_algorithm </td>
  544. <td>(</td>
  545. <td class="paramtype">grpc_compression_algorithm&#160;</td>
  546. <td class="paramname"><em>algorithm</em></td><td>)</td>
  547. <td></td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Set <em>algorithm</em> to be the compression algorithm used for the client call. </p>
  552. <dl class="params"><dt>Parameters</dt><dd>
  553. <table class="params">
  554. <tr><td class="paramname">algorith</td><td>The compression algorithm used for the client call. </td></tr>
  555. </table>
  556. </dd>
  557. </dl>
  558. </div>
  559. </div>
  560. <a class="anchor" id="a768356886d37231b3f0853b3c38e48a9"></a>
  561. <div class="memitem">
  562. <div class="memproto">
  563. <table class="mlabels">
  564. <tr>
  565. <td class="mlabels-left">
  566. <table class="memname">
  567. <tr>
  568. <td class="memname">void grpc::ClientContext::set_credentials </td>
  569. <td>(</td>
  570. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;&#160;</td>
  571. <td class="paramname"><em>creds</em></td><td>)</td>
  572. <td></td>
  573. </tr>
  574. </table>
  575. </td>
  576. <td class="mlabels-right">
  577. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  578. </tr>
  579. </table>
  580. </div><div class="memdoc">
  581. <p>Set credentials for the client call. </p>
  582. <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>
  583. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.grpc.io/docs/guides/auth.html">http://www.grpc.io/docs/guides/auth.html</a> </dd></dl>
  584. </div>
  585. </div>
  586. <a class="anchor" id="ad4e16866fee3f6ee5a10efb5be6f4da6"></a>
  587. <div class="memitem">
  588. <div class="memproto">
  589. <div class="memtemplate">
  590. template&lt;typename T &gt; </div>
  591. <table class="mlabels">
  592. <tr>
  593. <td class="mlabels-left">
  594. <table class="memname">
  595. <tr>
  596. <td class="memname">void grpc::ClientContext::set_deadline </td>
  597. <td>(</td>
  598. <td class="paramtype">const T &amp;&#160;</td>
  599. <td class="paramname"><em>deadline</em></td><td>)</td>
  600. <td></td>
  601. </tr>
  602. </table>
  603. </td>
  604. <td class="mlabels-right">
  605. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  606. </tr>
  607. </table>
  608. </div><div class="memdoc">
  609. <p>Set the deadline for the client call. </p>
  610. <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before invoking the rpc.</dd></dl>
  611. <dl class="params"><dt>Parameters</dt><dd>
  612. <table class="params">
  613. <tr><td class="paramname">deadline</td><td>the deadline for the client call. Units are determined by the type used. </td></tr>
  614. </table>
  615. </dd>
  616. </dl>
  617. </div>
  618. </div>
  619. <a class="anchor" id="ad329c9fdd77093361518ef8ace1ee1f0"></a>
  620. <div class="memitem">
  621. <div class="memproto">
  622. <table class="mlabels">
  623. <tr>
  624. <td class="mlabels-left">
  625. <table class="memname">
  626. <tr>
  627. <td class="memname">static void grpc::ClientContext::SetGlobalCallbacks </td>
  628. <td>(</td>
  629. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context_1_1_global_callbacks.html">GlobalCallbacks</a> *&#160;</td>
  630. <td class="paramname"><em>callbacks</em></td><td>)</td>
  631. <td></td>
  632. </tr>
  633. </table>
  634. </td>
  635. <td class="mlabels-right">
  636. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  637. </tr>
  638. </table>
  639. </div><div class="memdoc">
  640. </div>
  641. </div>
  642. <a class="anchor" id="abd0f6715c30287b75288015eee628984"></a>
  643. <div class="memitem">
  644. <div class="memproto">
  645. <table class="memname">
  646. <tr>
  647. <td class="memname">void grpc::ClientContext::TryCancel </td>
  648. <td>(</td>
  649. <td class="paramname"></td><td>)</td>
  650. <td></td>
  651. </tr>
  652. </table>
  653. </div><div class="memdoc">
  654. <p>Send a best-effort out-of-band cancel. </p>
  655. <p>The call could be in any stage. e.g. if it is already finished, it may still return success.</p>
  656. <p>There is no guarantee the call will be cancelled. </p>
  657. </div>
  658. </div>
  659. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  660. <a class="anchor" id="af5343062a44a5633b144751e59969237"></a>
  661. <div class="memitem">
  662. <div class="memproto">
  663. <div class="memtemplate">
  664. template&lt;class R &gt; </div>
  665. <table class="mlabels">
  666. <tr>
  667. <td class="mlabels-left">
  668. <table class="memname">
  669. <tr>
  670. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_reader.html">grpc::ClientAsyncReader</a></td>
  671. </tr>
  672. </table>
  673. </td>
  674. <td class="mlabels-right">
  675. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  676. </tr>
  677. </table>
  678. </div><div class="memdoc">
  679. </div>
  680. </div>
  681. <a class="anchor" id="a5c0c96957129933bfe94a299c764eaa7"></a>
  682. <div class="memitem">
  683. <div class="memproto">
  684. <div class="memtemplate">
  685. template&lt;class W , class R &gt; </div>
  686. <table class="mlabels">
  687. <tr>
  688. <td class="mlabels-left">
  689. <table class="memname">
  690. <tr>
  691. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a></td>
  692. </tr>
  693. </table>
  694. </td>
  695. <td class="mlabels-right">
  696. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  697. </tr>
  698. </table>
  699. </div><div class="memdoc">
  700. </div>
  701. </div>
  702. <a class="anchor" id="a4b00162a9bd86e07669f2af67f85c73a"></a>
  703. <div class="memitem">
  704. <div class="memproto">
  705. <div class="memtemplate">
  706. template&lt;class R &gt; </div>
  707. <table class="mlabels">
  708. <tr>
  709. <td class="mlabels-left">
  710. <table class="memname">
  711. <tr>
  712. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a></td>
  713. </tr>
  714. </table>
  715. </td>
  716. <td class="mlabels-right">
  717. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  718. </tr>
  719. </table>
  720. </div><div class="memdoc">
  721. </div>
  722. </div>
  723. <a class="anchor" id="af3547958eadfaeb18692865bd73999ad"></a>
  724. <div class="memitem">
  725. <div class="memproto">
  726. <div class="memtemplate">
  727. template&lt;class W &gt; </div>
  728. <table class="mlabels">
  729. <tr>
  730. <td class="mlabels-left">
  731. <table class="memname">
  732. <tr>
  733. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a></td>
  734. </tr>
  735. </table>
  736. </td>
  737. <td class="mlabels-right">
  738. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  739. </tr>
  740. </table>
  741. </div><div class="memdoc">
  742. </div>
  743. </div>
  744. <a class="anchor" id="ade499098cc91745c1c87147d7a7fb7bf"></a>
  745. <div class="memitem">
  746. <div class="memproto">
  747. <div class="memtemplate">
  748. template&lt;class R &gt; </div>
  749. <table class="mlabels">
  750. <tr>
  751. <td class="mlabels-left">
  752. <table class="memname">
  753. <tr>
  754. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
  755. </tr>
  756. </table>
  757. </td>
  758. <td class="mlabels-right">
  759. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  760. </tr>
  761. </table>
  762. </div><div class="memdoc">
  763. </div>
  764. </div>
  765. <a class="anchor" id="a6d5659aa24edba057895be774e2752ec"></a>
  766. <div class="memitem">
  767. <div class="memproto">
  768. <div class="memtemplate">
  769. template&lt;class W , class R &gt; </div>
  770. <table class="mlabels">
  771. <tr>
  772. <td class="mlabels-left">
  773. <table class="memname">
  774. <tr>
  775. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
  776. </tr>
  777. </table>
  778. </td>
  779. <td class="mlabels-right">
  780. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  781. </tr>
  782. </table>
  783. </div><div class="memdoc">
  784. </div>
  785. </div>
  786. <a class="anchor" id="a4498fada67d531d99a8642f47d746544"></a>
  787. <div class="memitem">
  788. <div class="memproto">
  789. <div class="memtemplate">
  790. template&lt;class W &gt; </div>
  791. <table class="mlabels">
  792. <tr>
  793. <td class="mlabels-left">
  794. <table class="memname">
  795. <tr>
  796. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
  797. </tr>
  798. </table>
  799. </td>
  800. <td class="mlabels-right">
  801. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  802. </tr>
  803. </table>
  804. </div><div class="memdoc">
  805. </div>
  806. </div>
  807. <a class="anchor" id="ac4ab4e2d21681704cee0f6e741cc813c"></a>
  808. <div class="memitem">
  809. <div class="memproto">
  810. <table class="mlabels">
  811. <tr>
  812. <td class="mlabels-left">
  813. <table class="memname">
  814. <tr>
  815. <td class="memname">friend class ::grpc::testing::InteropClientContextInspector</td>
  816. </tr>
  817. </table>
  818. </td>
  819. <td class="mlabels-right">
  820. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  821. </tr>
  822. </table>
  823. </div><div class="memdoc">
  824. </div>
  825. </div>
  826. <a class="anchor" id="a4aac0a120f3498d1151460ef89ce8446"></a>
  827. <div class="memitem">
  828. <div class="memproto">
  829. <div class="memtemplate">
  830. template&lt;class InputMessage , class OutputMessage &gt; </div>
  831. <table class="mlabels">
  832. <tr>
  833. <td class="mlabels-left">
  834. <table class="memname">
  835. <tr>
  836. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">Status</a> BlockingUnaryCall </td>
  837. <td>(</td>
  838. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *&#160;</td>
  839. <td class="paramname"><em>channel</em>, </td>
  840. </tr>
  841. <tr>
  842. <td class="paramkey"></td>
  843. <td></td>
  844. <td class="paramtype">const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;&#160;</td>
  845. <td class="paramname"><em>method</em>, </td>
  846. </tr>
  847. <tr>
  848. <td class="paramkey"></td>
  849. <td></td>
  850. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *&#160;</td>
  851. <td class="paramname"><em>context</em>, </td>
  852. </tr>
  853. <tr>
  854. <td class="paramkey"></td>
  855. <td></td>
  856. <td class="paramtype">const InputMessage &amp;&#160;</td>
  857. <td class="paramname"><em>request</em>, </td>
  858. </tr>
  859. <tr>
  860. <td class="paramkey"></td>
  861. <td></td>
  862. <td class="paramtype">OutputMessage *&#160;</td>
  863. <td class="paramname"><em>result</em>&#160;</td>
  864. </tr>
  865. <tr>
  866. <td></td>
  867. <td>)</td>
  868. <td></td><td></td>
  869. </tr>
  870. </table>
  871. </td>
  872. <td class="mlabels-right">
  873. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  874. </tr>
  875. </table>
  876. </div><div class="memdoc">
  877. </div>
  878. </div>
  879. <a class="anchor" id="aa7c3f046b48d55b5a82cbee3fd84faa2"></a>
  880. <div class="memitem">
  881. <div class="memproto">
  882. <table class="mlabels">
  883. <tr>
  884. <td class="mlabels-left">
  885. <table class="memname">
  886. <tr>
  887. <td class="memname">friend class <a class="el" href="classgrpc_1_1_call_op_client_recv_status.html">CallOpClientRecvStatus</a></td>
  888. </tr>
  889. </table>
  890. </td>
  891. <td class="mlabels-right">
  892. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  893. </tr>
  894. </table>
  895. </div><div class="memdoc">
  896. </div>
  897. </div>
  898. <a class="anchor" id="a94ad025954d211da7d27efa58cb2ea91"></a>
  899. <div class="memitem">
  900. <div class="memproto">
  901. <table class="mlabels">
  902. <tr>
  903. <td class="mlabels-left">
  904. <table class="memname">
  905. <tr>
  906. <td class="memname">friend class <a class="el" href="classgrpc_1_1_call_op_recv_initial_metadata.html">CallOpRecvInitialMetadata</a></td>
  907. </tr>
  908. </table>
  909. </td>
  910. <td class="mlabels-right">
  911. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  912. </tr>
  913. </table>
  914. </div><div class="memdoc">
  915. </div>
  916. </div>
  917. <a class="anchor" id="ac47342240f21ce36f47485e4ab41a10d"></a>
  918. <div class="memitem">
  919. <div class="memproto">
  920. <table class="mlabels">
  921. <tr>
  922. <td class="mlabels-left">
  923. <table class="memname">
  924. <tr>
  925. <td class="memname">friend class <a class="el" href="classgrpc_1_1_channel.html">Channel</a></td>
  926. </tr>
  927. </table>
  928. </td>
  929. <td class="mlabels-right">
  930. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  931. </tr>
  932. </table>
  933. </div><div class="memdoc">
  934. </div>
  935. </div>
  936. <hr/>The documentation for this class was generated from the following file:<ul>
  937. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2client__context_8h_source.html">client_context.h</a></li>
  938. </ul>
  939. </div><!-- contents -->
  940. <!-- start footer part -->
  941. <hr class="footer"/><address class="footer"><small>
  942. Generated on Tue Mar 8 2016 15:59:03 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  943. <img class="footer" src="doxygen.png" alt="doxygen"/>
  944. </a> 1.8.6
  945. </small></address>
  946. </body>
  947. </html>