1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc::ClientContext Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.36.1</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ClientContext Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>A <a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a> allows the person implementing a service client to:
- <a href="classgrpc_1_1_client_context.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2client__context_8h_source.html">client_context.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context_1_1_global_callbacks.html">GlobalCallbacks</a></td></tr>
- <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Global Callbacks. <a href="classgrpc_1_1_client_context_1_1_global_callbacks.html#details">More...</a><br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:acabbcf3c160a0628da8a9274b10f54b9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#acabbcf3c160a0628da8a9274b10f54b9">ClientContext</a> ()</td></tr>
- <tr class="separator:acabbcf3c160a0628da8a9274b10f54b9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aeb77ea760faf8f96e775812806c0a3d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aeb77ea760faf8f96e775812806c0a3d9">~ClientContext</a> ()</td></tr>
- <tr class="separator:aeb77ea760faf8f96e775812806c0a3d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a816af6cf0b2999da00e32a5027e23da4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a816af6cf0b2999da00e32a5027e23da4">AddMetadata</a> (const std::string &meta_key, const std::string &meta_value)</td></tr>
- <tr class="memdesc:a816af6cf0b2999da00e32a5027e23da4"><td class="mdescLeft"> </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="classgrpc_1_1_client_context.html#a816af6cf0b2999da00e32a5027e23da4">More...</a><br /></td></tr>
- <tr class="separator:a816af6cf0b2999da00e32a5027e23da4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a068592f22fe0866293c8d1e5ac22ed20"><td class="memItemLeft" align="right" valign="top">const std::multimap< <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> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a068592f22fe0866293c8d1e5ac22ed20">GetServerInitialMetadata</a> () const</td></tr>
- <tr class="memdesc:a068592f22fe0866293c8d1e5ac22ed20"><td class="mdescLeft"> </td><td class="mdescRight">Return a collection of initial metadata key-value pairs. <a href="classgrpc_1_1_client_context.html#a068592f22fe0866293c8d1e5ac22ed20">More...</a><br /></td></tr>
- <tr class="separator:a068592f22fe0866293c8d1e5ac22ed20"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a572f9fb786e1dfc3129a04183d9f1882"><td class="memItemLeft" align="right" valign="top">const std::multimap< <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> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a572f9fb786e1dfc3129a04183d9f1882">GetServerTrailingMetadata</a> () const</td></tr>
- <tr class="memdesc:a572f9fb786e1dfc3129a04183d9f1882"><td class="mdescLeft"> </td><td class="mdescRight">Return a collection of trailing metadata key-value pairs. <a href="classgrpc_1_1_client_context.html#a572f9fb786e1dfc3129a04183d9f1882">More...</a><br /></td></tr>
- <tr class="separator:a572f9fb786e1dfc3129a04183d9f1882"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ad4e16866fee3f6ee5a10efb5be6f4da6">set_deadline</a> (const T &<a class="el" href="classgrpc_1_1_client_context.html#a85710b2b34a48b0f83d509c33d0a44b5">deadline</a>)</td></tr>
- <tr class="memdesc:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="mdescLeft"> </td><td class="mdescRight">Set the deadline for the client call. <a href="classgrpc_1_1_client_context.html#ad4e16866fee3f6ee5a10efb5be6f4da6">More...</a><br /></td></tr>
- <tr class="separator:ad4e16866fee3f6ee5a10efb5be6f4da6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afac227b0dca4705b50b0b393226d8c48"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#afac227b0dca4705b50b0b393226d8c48">set_idempotent</a> (bool idempotent)</td></tr>
- <tr class="memdesc:afac227b0dca4705b50b0b393226d8c48"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL: Indicate that this request is idempotent. <a href="classgrpc_1_1_client_context.html#afac227b0dca4705b50b0b393226d8c48">More...</a><br /></td></tr>
- <tr class="separator:afac227b0dca4705b50b0b393226d8c48"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09c0b94c1542706eb5a518dab8425ebc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a09c0b94c1542706eb5a518dab8425ebc">set_cacheable</a> (bool cacheable)</td></tr>
- <tr class="memdesc:a09c0b94c1542706eb5a518dab8425ebc"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL: Set this request to be cacheable. <a href="classgrpc_1_1_client_context.html#a09c0b94c1542706eb5a518dab8425ebc">More...</a><br /></td></tr>
- <tr class="separator:a09c0b94c1542706eb5a518dab8425ebc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa342af7349c88727e8bd4c765a000ae5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aa342af7349c88727e8bd4c765a000ae5">set_wait_for_ready</a> (bool wait_for_ready)</td></tr>
- <tr class="memdesc:aa342af7349c88727e8bd4c765a000ae5"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL: Trigger wait-for-ready or not on this request. <a href="classgrpc_1_1_client_context.html#aa342af7349c88727e8bd4c765a000ae5">More...</a><br /></td></tr>
- <tr class="separator:aa342af7349c88727e8bd4c765a000ae5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1f20b0a60ed36d86bd1c5bee115b2a35"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:a1f20b0a60ed36d86bd1c5bee115b2a35"><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED: Use <a class="el" href="classgrpc_1_1_client_context.html#aa342af7349c88727e8bd4c765a000ae5" title="EXPERIMENTAL: Trigger wait-for-ready or not on this request.">set_wait_for_ready()</a> instead. <a href="classgrpc_1_1_client_context.html#a1f20b0a60ed36d86bd1c5bee115b2a35">More...</a><br /></td></tr>
- <tr class="separator:a1f20b0a60ed36d86bd1c5bee115b2a35"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85710b2b34a48b0f83d509c33d0a44b5"><td class="memItemLeft" align="right" valign="top">std::chrono::system_clock::time_point </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a85710b2b34a48b0f83d509c33d0a44b5">deadline</a> () const</td></tr>
- <tr class="memdesc:a85710b2b34a48b0f83d509c33d0a44b5"><td class="mdescLeft"> </td><td class="mdescRight">Return the deadline for the client call. <a href="classgrpc_1_1_client_context.html#a85710b2b34a48b0f83d509c33d0a44b5">More...</a><br /></td></tr>
- <tr class="separator:a85710b2b34a48b0f83d509c33d0a44b5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f53a0182bf8f99de7607d6f06dbc466"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__timespec.html">gpr_timespec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a3f53a0182bf8f99de7607d6f06dbc466">raw_deadline</a> () const</td></tr>
- <tr class="memdesc:a3f53a0182bf8f99de7607d6f06dbc466"><td class="mdescLeft"> </td><td class="mdescRight">Return a <em><a class="el" href="structgpr__timespec.html" title="Analogous to struct timespec.">gpr_timespec</a></em> representation of the client call's deadline. <a href="classgrpc_1_1_client_context.html#a3f53a0182bf8f99de7607d6f06dbc466">More...</a><br /></td></tr>
- <tr class="separator:a3f53a0182bf8f99de7607d6f06dbc466"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa5ef06597450e9e0b38180c617fd402f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aa5ef06597450e9e0b38180c617fd402f">set_authority</a> (const std::string &authority)</td></tr>
- <tr class="memdesc:aa5ef06597450e9e0b38180c617fd402f"><td class="mdescLeft"> </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="classgrpc_1_1_client_context.html#aa5ef06597450e9e0b38180c617fd402f">More...</a><br /></td></tr>
- <tr class="separator:aa5ef06597450e9e0b38180c617fd402f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8359c1be1e1cad1dbaff1436828ca8f9"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< const <a class="el" href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a8359c1be1e1cad1dbaff1436828ca8f9">auth_context</a> () const</td></tr>
- <tr class="memdesc:a8359c1be1e1cad1dbaff1436828ca8f9"><td class="mdescLeft"> </td><td class="mdescRight">Return the authentication context for the associated client call. <a href="classgrpc_1_1_client_context.html#a8359c1be1e1cad1dbaff1436828ca8f9">More...</a><br /></td></tr>
- <tr class="separator:a8359c1be1e1cad1dbaff1436828ca8f9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a06b1dfa748ef79990254787dd94f59d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a06b1dfa748ef79990254787dd94f59d7">set_credentials</a> (const std::shared_ptr< <a class="el" href="classgrpc_1_1_call_credentials.html">grpc::CallCredentials</a> > &creds)</td></tr>
- <tr class="memdesc:a06b1dfa748ef79990254787dd94f59d7"><td class="mdescLeft"> </td><td class="mdescRight">Set credentials for the client call. <a href="classgrpc_1_1_client_context.html#a06b1dfa748ef79990254787dd94f59d7">More...</a><br /></td></tr>
- <tr class="separator:a06b1dfa748ef79990254787dd94f59d7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae815b758b873dc511ea9222fdacbd3c9"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc_1_1_call_credentials.html">grpc::CallCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ae815b758b873dc511ea9222fdacbd3c9">credentials</a> ()</td></tr>
- <tr class="memdesc:ae815b758b873dc511ea9222fdacbd3c9"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL debugging API. <a href="classgrpc_1_1_client_context.html#ae815b758b873dc511ea9222fdacbd3c9">More...</a><br /></td></tr>
- <tr class="separator:ae815b758b873dc511ea9222fdacbd3c9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7fea8001ed94597e31bd23fd2c847a32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a7fea8001ed94597e31bd23fd2c847a32">compression_algorithm</a> () const</td></tr>
- <tr class="memdesc:a7fea8001ed94597e31bd23fd2c847a32"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm the client call will request be used. <a href="classgrpc_1_1_client_context.html#a7fea8001ed94597e31bd23fd2c847a32">More...</a><br /></td></tr>
- <tr class="separator:a7fea8001ed94597e31bd23fd2c847a32"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a67a71b32afe1d71189aa3a24146ec61d"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:a67a71b32afe1d71189aa3a24146ec61d"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the client call. <a href="classgrpc_1_1_client_context.html#a67a71b32afe1d71189aa3a24146ec61d">More...</a><br /></td></tr>
- <tr class="separator:a67a71b32afe1d71189aa3a24146ec61d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af79c64534c7b208594ba8e76021e2696"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#af79c64534c7b208594ba8e76021e2696">set_initial_metadata_corked</a> (bool corked)</td></tr>
- <tr class="memdesc:af79c64534c7b208594ba8e76021e2696"><td class="mdescLeft"> </td><td class="mdescRight">Flag whether the initial metadata should be <em>corked</em>. <a href="classgrpc_1_1_client_context.html#af79c64534c7b208594ba8e76021e2696">More...</a><br /></td></tr>
- <tr class="separator:af79c64534c7b208594ba8e76021e2696"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a647ce0bc967ab8b994b78cbc360109a5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a647ce0bc967ab8b994b78cbc360109a5">peer</a> () const</td></tr>
- <tr class="memdesc:a647ce0bc967ab8b994b78cbc360109a5"><td class="mdescLeft"> </td><td class="mdescRight">Return the peer uri in a string. <a href="classgrpc_1_1_client_context.html#a647ce0bc967ab8b994b78cbc360109a5">More...</a><br /></td></tr>
- <tr class="separator:a647ce0bc967ab8b994b78cbc360109a5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a48672c1e42084d2cd6975746b84658dd"><td class="memItemLeft" align="right" valign="top">void </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="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> *ccp)</td></tr>
- <tr class="memdesc:a48672c1e42084d2cd6975746b84658dd"><td class="mdescLeft"> </td><td class="mdescRight">Sets the census context. <a href="classgrpc_1_1_client_context.html#a48672c1e42084d2cd6975746b84658dd">More...</a><br /></td></tr>
- <tr class="separator:a48672c1e42084d2cd6975746b84658dd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa2eb8c436099ffcd47b3b8308e5f8517"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aa2eb8c436099ffcd47b3b8308e5f8517">census_context</a> () const</td></tr>
- <tr class="memdesc:aa2eb8c436099ffcd47b3b8308e5f8517"><td class="mdescLeft"> </td><td class="mdescRight">Returns the census context that has been set, or nullptr if not set. <a href="classgrpc_1_1_client_context.html#aa2eb8c436099ffcd47b3b8308e5f8517">More...</a><br /></td></tr>
- <tr class="separator:aa2eb8c436099ffcd47b3b8308e5f8517"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abd0f6715c30287b75288015eee628984"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#abd0f6715c30287b75288015eee628984">TryCancel</a> ()</td></tr>
- <tr class="memdesc:abd0f6715c30287b75288015eee628984"><td class="mdescLeft"> </td><td class="mdescRight">Send a best-effort out-of-band cancel on the call associated with this client context. <a href="classgrpc_1_1_client_context.html#abd0f6715c30287b75288015eee628984">More...</a><br /></td></tr>
- <tr class="separator:abd0f6715c30287b75288015eee628984"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9fba10daf95815d2e1e94fa886a00459"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a9fba10daf95815d2e1e94fa886a00459">c_call</a> ()</td></tr>
- <tr class="memdesc:a9fba10daf95815d2e1e94fa886a00459"><td class="mdescLeft"> </td><td class="mdescRight">Should be used for framework-level extensions only. <a href="classgrpc_1_1_client_context.html#a9fba10daf95815d2e1e94fa886a00459">More...</a><br /></td></tr>
- <tr class="separator:a9fba10daf95815d2e1e94fa886a00459"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7dcbca0f921fc3fee8a010a6cdfcb4cd"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a7dcbca0f921fc3fee8a010a6cdfcb4cd">debug_error_string</a> () const</td></tr>
- <tr class="memdesc:a7dcbca0f921fc3fee8a010a6cdfcb4cd"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL debugging API. <a href="classgrpc_1_1_client_context.html#a7dcbca0f921fc3fee8a010a6cdfcb4cd">More...</a><br /></td></tr>
- <tr class="separator:a7dcbca0f921fc3fee8a010a6cdfcb4cd"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a70ff062f93b75964704b7f8ef97bf7f6"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a70ff062f93b75964704b7f8ef97bf7f6">FromServerContext</a> (const <a class="el" href="classgrpc_1_1_server_context.html">grpc::ServerContext</a> &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>
- <tr class="memdesc:a70ff062f93b75964704b7f8ef97bf7f6"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> as a child of an incoming server call, according to <em>options</em> (. <a href="classgrpc_1_1_client_context.html#a70ff062f93b75964704b7f8ef97bf7f6">More...</a><br /></td></tr>
- <tr class="separator:a70ff062f93b75964704b7f8ef97bf7f6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afdb2842b91383ad93eb22ee7143ed75c"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#afdb2842b91383ad93eb22ee7143ed75c">FromCallbackServerContext</a> (const <a class="el" href="classgrpc_1_1_callback_server_context.html">grpc::CallbackServerContext</a> &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>
- <tr class="separator:afdb2842b91383ad93eb22ee7143ed75c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad329c9fdd77093361518ef8ace1ee1f0"><td class="memItemLeft" align="right" valign="top">static void </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>
- <tr class="separator:ad329c9fdd77093361518ef8ace1ee1f0"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:ac4ab4e2d21681704cee0f6e741cc813c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ac4ab4e2d21681704cee0f6e741cc813c">::grpc::testing::InteropClientContextInspector</a></td></tr>
- <tr class="separator:ac4ab4e2d21681704cee0f6e741cc813c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a506d0cd94cc911153c6ceb814a59524b"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a506d0cd94cc911153c6ceb814a59524b">::grpc::internal::CallOpClientRecvStatus</a></td></tr>
- <tr class="separator:a506d0cd94cc911153c6ceb814a59524b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b165df6c09402c7753da14140c836cf"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a3b165df6c09402c7753da14140c836cf">::grpc::internal::CallOpRecvInitialMetadata</a></td></tr>
- <tr class="separator:a3b165df6c09402c7753da14140c836cf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a82418631373400a3f110c97c937a9533"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a82418631373400a3f110c97c937a9533">::grpc::Channel</a></td></tr>
- <tr class="separator:a82418631373400a3f110c97c937a9533"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ade499098cc91745c1c87147d7a7fb7bf">::grpc::ClientReader</a></td></tr>
- <tr class="separator:ade499098cc91745c1c87147d7a7fb7bf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a4498fada67d531d99a8642f47d746544">::grpc::ClientWriter</a></td></tr>
- <tr class="separator:a4498fada67d531d99a8642f47d746544"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a6d5659aa24edba057895be774e2752ec">::grpc::ClientReaderWriter</a></td></tr>
- <tr class="separator:a6d5659aa24edba057895be774e2752ec"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af5343062a44a5633b144751e59969237"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:af5343062a44a5633b144751e59969237"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#af5343062a44a5633b144751e59969237">::grpc::ClientAsyncReader</a></td></tr>
- <tr class="separator:af5343062a44a5633b144751e59969237"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af3547958eadfaeb18692865bd73999ad"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:af3547958eadfaeb18692865bd73999ad"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#af3547958eadfaeb18692865bd73999ad">::grpc::ClientAsyncWriter</a></td></tr>
- <tr class="separator:af3547958eadfaeb18692865bd73999ad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5c0c96957129933bfe94a299c764eaa7"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a5c0c96957129933bfe94a299c764eaa7"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a5c0c96957129933bfe94a299c764eaa7">::grpc::ClientAsyncReaderWriter</a></td></tr>
- <tr class="separator:a5c0c96957129933bfe94a299c764eaa7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4b00162a9bd86e07669f2af67f85c73a"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:a4b00162a9bd86e07669f2af67f85c73a"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a4b00162a9bd86e07669f2af67f85c73a">::grpc::ClientAsyncResponseReader</a></td></tr>
- <tr class="separator:a4b00162a9bd86e07669f2af67f85c73a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1276dd3b0504721eced67f15c36ac888"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a1276dd3b0504721eced67f15c36ac888">::grpc::internal::ClientAsyncResponseReaderHelper</a></td></tr>
- <tr class="separator:a1276dd3b0504721eced67f15c36ac888"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplParams" colspan="2">template<class InputMessage , class OutputMessage > </td></tr>
- <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#ad26a823fee699f97244d581f400fe39a">::grpc::internal::BlockingUnaryCallImpl</a></td></tr>
- <tr class="separator:ad26a823fee699f97244d581f400fe39a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplParams" colspan="2">template<class InputMessage , class OutputMessage > </td></tr>
- <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a039f3a4023eccbecbb5c9925722e9ef7">::grpc::internal::CallbackUnaryCallImpl</a></td></tr>
- <tr class="separator:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7514ed9247c292d4be15b5db66903fda"><td class="memTemplParams" colspan="2">template<class Request , class Response > </td></tr>
- <tr class="memitem:a7514ed9247c292d4be15b5db66903fda"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a7514ed9247c292d4be15b5db66903fda">::grpc::internal::ClientCallbackReaderWriterImpl</a></td></tr>
- <tr class="separator:a7514ed9247c292d4be15b5db66903fda"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a06df5a0d32a3185f56dc33452a6a9a7c"><td class="memTemplParams" colspan="2">template<class Response > </td></tr>
- <tr class="memitem:a06df5a0d32a3185f56dc33452a6a9a7c"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a06df5a0d32a3185f56dc33452a6a9a7c">::grpc::internal::ClientCallbackReaderImpl</a></td></tr>
- <tr class="separator:a06df5a0d32a3185f56dc33452a6a9a7c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa29677cce876711f4c9ee1c90649c251"><td class="memTemplParams" colspan="2">template<class Request > </td></tr>
- <tr class="memitem:aa29677cce876711f4c9ee1c90649c251"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#aa29677cce876711f4c9ee1c90649c251">::grpc::internal::ClientCallbackWriterImpl</a></td></tr>
- <tr class="separator:aa29677cce876711f4c9ee1c90649c251"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4026963fc6687e2b41815eab50c84021"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a4026963fc6687e2b41815eab50c84021">::grpc::internal::ClientCallbackUnaryImpl</a></td></tr>
- <tr class="separator:a4026963fc6687e2b41815eab50c84021"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4782c3b50029a78db85ac572358100fd"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_context.html#a4782c3b50029a78db85ac572358100fd">::grpc::internal::ClientContextAccessor</a></td></tr>
- <tr class="separator:a4782c3b50029a78db85ac572358100fd"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>A <a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a> allows the person implementing a service client to: </p>
- <ul>
- <li>Add custom metadata key-value pairs that will propagated to the server side.</li>
- <li>Control call settings such as compression and authentication.</li>
- <li>Initial and trailing metadata coming from the server.</li>
- <li>Get performance metrics (ie, census).</li>
- </ul>
- <p>Context settings are only relevant to the call they are invoked with, that is to say, they aren't sticky. Some of these settings, such as the compression options, can be made persistent at channel construction time (see <em><a class="el" href="namespacegrpc.html#a4a5c8a2c77389604feaa5d38cdd7b8d3" title="Create a new custom Channel pointing to target.">grpc::CreateCustomChannel</a></em>).</p>
- <dl class="section warning"><dt>Warning</dt><dd><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a> instances should <em>not</em> be reused across rpcs. </dd>
- <dd>
- The <a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a> instance used for creating an rpc must remain alive and valid for the lifetime of the rpc. </dd></dl>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="acabbcf3c160a0628da8a9274b10f54b9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acabbcf3c160a0628da8a9274b10f54b9">◆ </a></span>ClientContext()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ClientContext::ClientContext </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aeb77ea760faf8f96e775812806c0a3d9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aeb77ea760faf8f96e775812806c0a3d9">◆ </a></span>~ClientContext()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ClientContext::~ClientContext </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a816af6cf0b2999da00e32a5027e23da4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a816af6cf0b2999da00e32a5027e23da4">◆ </a></span>AddMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::AddMetadata </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>meta_key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>meta_value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add the (<em>meta_key</em>, <em>meta_value</em>) pair to the metadata associated with a client call. </p>
- <p>These are made available at the server side by the <em><a class="el" href="classgrpc_1_1_server_context_base.html#a1424dee498921ed06e890c7134e88957" title="Return a collection of initial metadata key-value pairs sent from the client.">grpc::ServerContext::client_metadata()</a></em> method.</p>
- <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before invoking the rpc.</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- <tr><td class="paramname">meta_value</td><td>The metadata value. If its value is binary, the key name must end in "-bin".</td></tr>
- </table>
- </dd>
- </dl>
- <p>Metadata must conform to the following format: Custom-Metadata -> Binary-Header / ASCII-Header Binary-Header -> {Header-Name "-bin" } {binary value} ASCII-Header -> Header-Name ASCII-Value Header-Name -> 1*( x30-39 / x61-7A / "_" / "-" / ".") ; 0-9 a-z _ - . ASCII-Value -> 1*( x20-x7E ) ; space and printable ASCII </p>
- </div>
- </div>
- <a id="a8359c1be1e1cad1dbaff1436828ca8f9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8359c1be1e1cad1dbaff1436828ca8f9">◆ </a></span>auth_context()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<const <a class="el" href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a>> grpc::ClientContext::auth_context </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the authentication context for the associated client call. </p>
- <p>It is only valid to call this during the lifetime of the client call.</p>
- <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>
- </div>
- </div>
- <a id="a9fba10daf95815d2e1e94fa886a00459"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9fba10daf95815d2e1e94fa886a00459">◆ </a></span>c_call()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a>* grpc::ClientContext::c_call </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Should be used for framework-level extensions only. </p>
- <p>Applications never need to call this method. </p>
- </div>
- </div>
- <a id="aa2eb8c436099ffcd47b3b8308e5f8517"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa2eb8c436099ffcd47b3b8308e5f8517">◆ </a></span>census_context()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">struct <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a>* grpc::ClientContext::census_context </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the census context that has been set, or nullptr if not set. </p>
- </div>
- </div>
- <a id="a7fea8001ed94597e31bd23fd2c847a32"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7fea8001ed94597e31bd23fd2c847a32">◆ </a></span>compression_algorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc::ClientContext::compression_algorithm </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the compression algorithm the client call will request be used. </p>
- <p>Note that the gRPC runtime may decide to ignore this request, for example, due to resource constraints. </p>
- </div>
- </div>
- <a id="ae815b758b873dc511ea9222fdacbd3c9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae815b758b873dc511ea9222fdacbd3c9">◆ </a></span>credentials()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::shared_ptr<<a class="el" href="classgrpc_1_1_call_credentials.html">grpc::CallCredentials</a>> grpc::ClientContext::credentials </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>EXPERIMENTAL debugging API. </p>
- <p>Returns the credentials for the client call. This should be used only in tests and for diagnostic purposes, and should not be used by application logic. </p>
- </div>
- </div>
- <a id="a85710b2b34a48b0f83d509c33d0a44b5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a85710b2b34a48b0f83d509c33d0a44b5">◆ </a></span>deadline()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::chrono::system_clock::time_point grpc::ClientContext::deadline </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the deadline for the client call. </p>
- </div>
- </div>
- <a id="a7dcbca0f921fc3fee8a010a6cdfcb4cd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7dcbca0f921fc3fee8a010a6cdfcb4cd">◆ </a></span>debug_error_string()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">std::string grpc::ClientContext::debug_error_string </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>EXPERIMENTAL debugging API. </p>
- <p>if status is not ok() for an RPC, this will return a detailed string of the gRPC Core error that led to the failure. It should not be relied upon for anything other than gaining more debug data in failure cases. </p>
- </div>
- </div>
- <a id="afdb2842b91383ad93eb22ee7143ed75c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afdb2842b91383ad93eb22ee7143ed75c">◆ </a></span>FromCallbackServerContext()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static std::unique_ptr<<a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a>> grpc::ClientContext::FromCallbackServerContext </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgrpc_1_1_callback_server_context.html">grpc::CallbackServerContext</a> & </td>
- <td class="paramname"><em>server_context</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a> </td>
- <td class="paramname"><em>options</em> = <code><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>()</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a70ff062f93b75964704b7f8ef97bf7f6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a70ff062f93b75964704b7f8ef97bf7f6">◆ </a></span>FromServerContext()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static std::unique_ptr<<a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a>> grpc::ClientContext::FromServerContext </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgrpc_1_1_server_context.html">grpc::ServerContext</a> & </td>
- <td class="paramname"><em>server_context</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a> </td>
- <td class="paramname"><em>options</em> = <code><a class="el" href="classgrpc_1_1_propagation_options.html">PropagationOptions</a>()</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a new <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> as a child of an incoming server call, according to <em>options</em> (. </p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">server_context</td><td>The source server context to use as the basis for constructing the client context. </td></tr>
- <tr><td class="paramname">options</td><td>The options controlling what to copy from the <em>server_context</em>.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A newly constructed <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> instance based on <em>server_context</em>, with traits propagated (copied) according to <em>options</em>. </dd></dl>
- </div>
- </div>
- <a id="a068592f22fe0866293c8d1e5ac22ed20"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a068592f22fe0866293c8d1e5ac22ed20">◆ </a></span>GetServerInitialMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const std::multimap<<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>>& grpc::ClientContext::GetServerInitialMetadata </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return a collection of initial metadata key-value pairs. </p>
- <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
- <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="Block to wait for initial metadata from server.">ClientReaderInterface::WaitForInitialMetadata()</a></em>.</dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>A multimap of initial metadata key-value pairs from the server. </dd></dl>
- </div>
- </div>
- <a id="a572f9fb786e1dfc3129a04183d9f1882"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a572f9fb786e1dfc3129a04183d9f1882">◆ </a></span>GetServerTrailingMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const std::multimap<<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>>& grpc::ClientContext::GetServerTrailingMetadata </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return a collection of trailing metadata key-value pairs. </p>
- <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
- <dl class="section warning"><dt>Warning</dt><dd>This method is only callable once the stream has finished.</dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>A multimap of metadata trailing key-value pairs from the server. </dd></dl>
- </div>
- </div>
- <a id="a647ce0bc967ab8b994b78cbc360109a5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a647ce0bc967ab8b994b78cbc360109a5">◆ </a></span>peer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::string grpc::ClientContext::peer </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the peer uri in a string. </p>
- <p>It is only valid to call this during the lifetime of the client call.</p>
- <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>
- <dl class="section return"><dt>Returns</dt><dd>The call's peer URI. </dd></dl>
- </div>
- </div>
- <a id="a3f53a0182bf8f99de7607d6f06dbc466"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3f53a0182bf8f99de7607d6f06dbc466">◆ </a></span>raw_deadline()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structgpr__timespec.html">gpr_timespec</a> grpc::ClientContext::raw_deadline </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return a <em><a class="el" href="structgpr__timespec.html" title="Analogous to struct timespec.">gpr_timespec</a></em> representation of the client call's deadline. </p>
- </div>
- </div>
- <a id="aa5ef06597450e9e0b38180c617fd402f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa5ef06597450e9e0b38180c617fd402f">◆ </a></span>set_authority()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_authority </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>authority</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="a09c0b94c1542706eb5a518dab8425ebc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a09c0b94c1542706eb5a518dab8425ebc">◆ </a></span>set_cacheable()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_cacheable </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>cacheable</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>EXPERIMENTAL: Set this request to be cacheable. </p>
- <p>If set, grpc is free to use the HTTP GET verb for sending the request, with the possibility of receiving a cached response. </p>
- </div>
- </div>
- <a id="a48672c1e42084d2cd6975746b84658dd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a48672c1e42084d2cd6975746b84658dd">◆ </a></span>set_census_context()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_census_context </td>
- <td>(</td>
- <td class="paramtype">struct <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a> * </td>
- <td class="paramname"><em>ccp</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the census context. </p>
- <p>It is only valid to call this before the client call is created. A common place of setting census context is from within the DefaultConstructor method of <a class="el" href="classgrpc_1_1_client_context_1_1_global_callbacks.html" title="Global Callbacks.">GlobalCallbacks</a>. </p>
- </div>
- </div>
- <a id="a67a71b32afe1d71189aa3a24146ec61d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a67a71b32afe1d71189aa3a24146ec61d">◆ </a></span>set_compression_algorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_compression_algorithm </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td>
- <td class="paramname"><em>algorithm</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set <em>algorithm</em> to be the compression algorithm used for the client call. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">algorithm</td><td>The compression algorithm used for the client call. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a06b1dfa748ef79990254787dd94f59d7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a06b1dfa748ef79990254787dd94f59d7">◆ </a></span>set_credentials()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_credentials </td>
- <td>(</td>
- <td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc_1_1_call_credentials.html">grpc::CallCredentials</a> > & </td>
- <td class="paramname"><em>creds</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set credentials for the client call. </p>
- <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>
- <p>It is legal to call this only before initial metadata is sent.</p>
- <dl class="section see"><dt>See also</dt><dd><a href="https://grpc.io/docs/guides/auth.html">https://grpc.io/docs/guides/auth.html</a> </dd></dl>
- </div>
- </div>
- <a id="ad4e16866fee3f6ee5a10efb5be6f4da6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad4e16866fee3f6ee5a10efb5be6f4da6">◆ </a></span>set_deadline()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_deadline </td>
- <td>(</td>
- <td class="paramtype">const T & </td>
- <td class="paramname"><em>deadline</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the deadline for the client call. </p>
- <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before invoking the rpc.</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">deadline</td><td>the deadline for the client call. Units are determined by the type used. The deadline is an absolute (not relative) time. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a1f20b0a60ed36d86bd1c5bee115b2a35"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1f20b0a60ed36d86bd1c5bee115b2a35">◆ </a></span>set_fail_fast()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_fail_fast </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>fail_fast</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>DEPRECATED: Use <a class="el" href="classgrpc_1_1_client_context.html#aa342af7349c88727e8bd4c765a000ae5" title="EXPERIMENTAL: Trigger wait-for-ready or not on this request.">set_wait_for_ready()</a> instead. </p>
- </div>
- </div>
- <a id="afac227b0dca4705b50b0b393226d8c48"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afac227b0dca4705b50b0b393226d8c48">◆ </a></span>set_idempotent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_idempotent </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>idempotent</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>EXPERIMENTAL: Indicate that this request is idempotent. </p>
- <p>By default, RPCs are assumed to <em>not</em> be idempotent.</p>
- <p>If true, the gRPC library assumes that it's safe to initiate this RPC multiple times. </p>
- </div>
- </div>
- <a id="af79c64534c7b208594ba8e76021e2696"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af79c64534c7b208594ba8e76021e2696">◆ </a></span>set_initial_metadata_corked()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_initial_metadata_corked </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>corked</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Flag whether the initial metadata should be <em>corked</em>. </p>
- <p>If <em>corked</em> is true, then the initial metadata will be coalesced with the write of first message in the stream. As a result, any tag set for the initial metadata operation (starting a client-streaming or bidi-streaming RPC) will not actually be sent to the completion queue or delivered via Next.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">corked</td><td>The flag indicating whether the initial metadata is to be corked or not. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="aa342af7349c88727e8bd4c765a000ae5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa342af7349c88727e8bd4c765a000ae5">◆ </a></span>set_wait_for_ready()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::set_wait_for_ready </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>wait_for_ready</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>EXPERIMENTAL: Trigger wait-for-ready or not on this request. </p>
- <p>See <a href="https://github.com/grpc/grpc/blob/master/doc/wait-for-ready.md">https://github.com/grpc/grpc/blob/master/doc/wait-for-ready.md</a>. If set, if an RPC is made when a channel's connectivity state is TRANSIENT_FAILURE or CONNECTING, the call will not "fail fast", and the channel will wait until the channel is READY before making the call. </p>
- </div>
- </div>
- <a id="ad329c9fdd77093361518ef8ace1ee1f0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad329c9fdd77093361518ef8ace1ee1f0">◆ </a></span>SetGlobalCallbacks()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void grpc::ClientContext::SetGlobalCallbacks </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context_1_1_global_callbacks.html">GlobalCallbacks</a> * </td>
- <td class="paramname"><em>callbacks</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="abd0f6715c30287b75288015eee628984"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abd0f6715c30287b75288015eee628984">◆ </a></span>TryCancel()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientContext::TryCancel </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a best-effort out-of-band cancel on the call associated with this client context. </p>
- <p>The call could be in any stage; e.g., if it is already finished, it may still return success.</p>
- <p>There is no guarantee the call will be cancelled.</p>
- <p>Note that <a class="el" href="classgrpc_1_1_client_context.html#abd0f6715c30287b75288015eee628984" title="Send a best-effort out-of-band cancel on the call associated with this client context.">TryCancel()</a> does not change any of the tags that are pending on the completion queue. All pending tags will still be delivered (though their ok result may reflect the effect of cancellation). </p>
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="a82418631373400a3f110c97c937a9533"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a82418631373400a3f110c97c937a9533">◆ </a></span>::grpc::Channel</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_channel.html">grpc::Channel</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="af5343062a44a5633b144751e59969237"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af5343062a44a5633b144751e59969237">◆ </a></span>::grpc::ClientAsyncReader</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_reader.html">grpc::ClientAsyncReader</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a5c0c96957129933bfe94a299c764eaa7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5c0c96957129933bfe94a299c764eaa7">◆ </a></span>::grpc::ClientAsyncReaderWriter</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W , class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4b00162a9bd86e07669f2af67f85c73a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4b00162a9bd86e07669f2af67f85c73a">◆ </a></span>::grpc::ClientAsyncResponseReader</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="af3547958eadfaeb18692865bd73999ad"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af3547958eadfaeb18692865bd73999ad">◆ </a></span>::grpc::ClientAsyncWriter</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ade499098cc91745c1c87147d7a7fb7bf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ade499098cc91745c1c87147d7a7fb7bf">◆ </a></span>::grpc::ClientReader</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6d5659aa24edba057895be774e2752ec"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6d5659aa24edba057895be774e2752ec">◆ </a></span>::grpc::ClientReaderWriter</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W , class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4498fada67d531d99a8642f47d746544"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4498fada67d531d99a8642f47d746544">◆ </a></span>::grpc::ClientWriter</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ad26a823fee699f97244d581f400fe39a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad26a823fee699f97244d581f400fe39a">◆ </a></span>::grpc::internal::BlockingUnaryCallImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class InputMessage , class OutputMessage > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_blocking_unary_call_impl.html">grpc::internal::BlockingUnaryCallImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a039f3a4023eccbecbb5c9925722e9ef7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a039f3a4023eccbecbb5c9925722e9ef7">◆ </a></span>::grpc::internal::CallbackUnaryCallImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class InputMessage , class OutputMessage > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_callback_unary_call_impl.html">grpc::internal::CallbackUnaryCallImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a506d0cd94cc911153c6ceb814a59524b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a506d0cd94cc911153c6ceb814a59524b">◆ </a></span>::grpc::internal::CallOpClientRecvStatus</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_call_op_client_recv_status.html">grpc::internal::CallOpClientRecvStatus</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a3b165df6c09402c7753da14140c836cf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3b165df6c09402c7753da14140c836cf">◆ </a></span>::grpc::internal::CallOpRecvInitialMetadata</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_call_op_recv_initial_metadata.html">grpc::internal::CallOpRecvInitialMetadata</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1276dd3b0504721eced67f15c36ac888"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1276dd3b0504721eced67f15c36ac888">◆ </a></span>::grpc::internal::ClientAsyncResponseReaderHelper</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_response_reader_helper.html">grpc::internal::ClientAsyncResponseReaderHelper</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a06df5a0d32a3185f56dc33452a6a9a7c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a06df5a0d32a3185f56dc33452a6a9a7c">◆ </a></span>::grpc::internal::ClientCallbackReaderImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class Response > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_impl.html">grpc::internal::ClientCallbackReaderImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a7514ed9247c292d4be15b5db66903fda"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7514ed9247c292d4be15b5db66903fda">◆ </a></span>::grpc::internal::ClientCallbackReaderWriterImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class Request , class Response > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html">grpc::internal::ClientCallbackReaderWriterImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4026963fc6687e2b41815eab50c84021"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4026963fc6687e2b41815eab50c84021">◆ </a></span>::grpc::internal::ClientCallbackUnaryImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_unary_impl.html">grpc::internal::ClientCallbackUnaryImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa29677cce876711f4c9ee1c90649c251"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa29677cce876711f4c9ee1c90649c251">◆ </a></span>::grpc::internal::ClientCallbackWriterImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class Request > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_writer_impl.html">grpc::internal::ClientCallbackWriterImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4782c3b50029a78db85ac572358100fd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4782c3b50029a78db85ac572358100fd">◆ </a></span>::grpc::internal::ClientContextAccessor</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::grpc::internal::ClientContextAccessor</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac4ab4e2d21681704cee0f6e741cc813c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac4ab4e2d21681704cee0f6e741cc813c">◆ </a></span>::grpc::testing::InteropClientContextInspector</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::grpc::testing::InteropClientContextInspector</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2client__context_8h_source.html">client_context.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|