classgrpc_1_1_client_context.html 54 KB

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