123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707 |
- <!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::ServerContext 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_server_context.html">ServerContext</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ServerContext Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>A <a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a> or <a class="el" href="classgrpc_1_1_callback_server_context.html">CallbackServerContext</a> allows the code implementing a service handler to:
- <a href="classgrpc_1_1_server_context.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2server__context_8h_source.html">server_context.h</a>></code></p>
- <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:a10f47e15934195dcaed6b756498b8fff"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a10f47e15934195dcaed6b756498b8fff">ServerContext</a> ()</td></tr>
- <tr class="separator:a10f47e15934195dcaed6b756498b8fff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abd7e586e89cccff633e38f8f24e11cdd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#abd7e586e89cccff633e38f8f24e11cdd">AddInitialMetadata</a> (const std::string &key, const std::string &value)</td></tr>
- <tr class="memdesc:abd7e586e89cccff633e38f8f24e11cdd"><td class="mdescLeft"> </td><td class="mdescRight">Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. <a href="classgrpc_1_1_server_context.html#abd7e586e89cccff633e38f8f24e11cdd">More...</a><br /></td></tr>
- <tr class="separator:abd7e586e89cccff633e38f8f24e11cdd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea7f111233dddc155f8dcfa9c1e20184"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#aea7f111233dddc155f8dcfa9c1e20184">AddTrailingMetadata</a> (const std::string &key, const std::string &value)</td></tr>
- <tr class="memdesc:aea7f111233dddc155f8dcfa9c1e20184"><td class="mdescLeft"> </td><td class="mdescRight">Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. <a href="classgrpc_1_1_server_context.html#aea7f111233dddc155f8dcfa9c1e20184">More...</a><br /></td></tr>
- <tr class="separator:aea7f111233dddc155f8dcfa9c1e20184"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2b28535186cbe2d7b6ed1ff59980191b"><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_server_context.html#a2b28535186cbe2d7b6ed1ff59980191b">auth_context</a> () const</td></tr>
- <tr class="memdesc:a2b28535186cbe2d7b6ed1ff59980191b"><td class="mdescLeft"> </td><td class="mdescRight">Return the authentication context for this server call. <a href="classgrpc_1_1_server_context.html#a2b28535186cbe2d7b6ed1ff59980191b">More...</a><br /></td></tr>
- <tr class="separator:a2b28535186cbe2d7b6ed1ff59980191b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acfdb9c2f6ebe59c5e9248ba72a7dfc2c"><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_server_context.html#acfdb9c2f6ebe59c5e9248ba72a7dfc2c">c_call</a> ()</td></tr>
- <tr class="memdesc:acfdb9c2f6ebe59c5e9248ba72a7dfc2c"><td class="mdescLeft"> </td><td class="mdescRight">Should be used for framework-level extensions only. <a href="classgrpc_1_1_server_context.html#acfdb9c2f6ebe59c5e9248ba72a7dfc2c">More...</a><br /></td></tr>
- <tr class="separator:acfdb9c2f6ebe59c5e9248ba72a7dfc2c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab324b4924bc290138b139a89f9b654a7"><td class="memItemLeft" align="right" valign="top">const 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_server_context.html#ab324b4924bc290138b139a89f9b654a7">census_context</a> () const</td></tr>
- <tr class="memdesc:ab324b4924bc290138b139a89f9b654a7"><td class="mdescLeft"> </td><td class="mdescRight">Get the census context associated with this server call. <a href="classgrpc_1_1_server_context.html#ab324b4924bc290138b139a89f9b654a7">More...</a><br /></td></tr>
- <tr class="separator:ab324b4924bc290138b139a89f9b654a7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1424dee498921ed06e890c7134e88957"><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_server_context.html#a1424dee498921ed06e890c7134e88957">client_metadata</a> () const</td></tr>
- <tr class="memdesc:a1424dee498921ed06e890c7134e88957"><td class="mdescLeft"> </td><td class="mdescRight">Return a collection of initial metadata key-value pairs sent from the client. <a href="classgrpc_1_1_server_context.html#a1424dee498921ed06e890c7134e88957">More...</a><br /></td></tr>
- <tr class="separator:a1424dee498921ed06e890c7134e88957"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a79723d2154ae4a48da5bef8daf41a3e7"><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_server_context.html#a79723d2154ae4a48da5bef8daf41a3e7">compression_algorithm</a> () const</td></tr>
- <tr class="memdesc:a79723d2154ae4a48da5bef8daf41a3e7"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm the server call will request be used. <a href="classgrpc_1_1_server_context.html#a79723d2154ae4a48da5bef8daf41a3e7">More...</a><br /></td></tr>
- <tr class="separator:a79723d2154ae4a48da5bef8daf41a3e7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4a7cac98ae494a7fd231d049d574095"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ad4a7cac98ae494a7fd231d049d574095">compression_level</a> () const</td></tr>
- <tr class="memdesc:ad4a7cac98ae494a7fd231d049d574095"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm to be used by the server call. <a href="classgrpc_1_1_server_context.html#ad4a7cac98ae494a7fd231d049d574095">More...</a><br /></td></tr>
- <tr class="separator:ad4a7cac98ae494a7fd231d049d574095"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a942b0a431630f987d558550bf9d49dd1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a942b0a431630f987d558550bf9d49dd1">compression_level_set</a> () const</td></tr>
- <tr class="memdesc:a942b0a431630f987d558550bf9d49dd1"><td class="mdescLeft"> </td><td class="mdescRight">Return a bool indicating whether the compression level for this call has been set (either implicitly or through a previous call to <em>set_compression_level</em>. <a href="classgrpc_1_1_server_context.html#a942b0a431630f987d558550bf9d49dd1">More...</a><br /></td></tr>
- <tr class="separator:a942b0a431630f987d558550bf9d49dd1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaa0410923dcf941e78c75e7463a34390"><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_server_context.html#aaa0410923dcf941e78c75e7463a34390">deadline</a> () const</td></tr>
- <tr class="memdesc:aaa0410923dcf941e78c75e7463a34390"><td class="mdescLeft"> </td><td class="mdescRight">Return the deadline for the server call. <a href="classgrpc_1_1_server_context.html#aaa0410923dcf941e78c75e7463a34390">More...</a><br /></td></tr>
- <tr class="separator:aaa0410923dcf941e78c75e7463a34390"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2d0f087805b4b475d01b12d73508f09"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#af2d0f087805b4b475d01b12d73508f09">IsCancelled</a> () const</td></tr>
- <tr class="memdesc:af2d0f087805b4b475d01b12d73508f09"><td class="mdescLeft"> </td><td class="mdescRight">Return whether this RPC failed before the server could provide its status back to the client. <a href="classgrpc_1_1_server_context.html#af2d0f087805b4b475d01b12d73508f09">More...</a><br /></td></tr>
- <tr class="separator:af2d0f087805b4b475d01b12d73508f09"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e94cf9e11550b34ab98271202f03adc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a6e94cf9e11550b34ab98271202f03adc">peer</a> () const</td></tr>
- <tr class="memdesc:a6e94cf9e11550b34ab98271202f03adc"><td class="mdescLeft"> </td><td class="mdescRight">Return the peer uri in a string. <a href="classgrpc_1_1_server_context.html#a6e94cf9e11550b34ab98271202f03adc">More...</a><br /></td></tr>
- <tr class="separator:a6e94cf9e11550b34ab98271202f03adc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acd431c5f1d1a7288c7dceee0465b4b2f"><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_server_context.html#acd431c5f1d1a7288c7dceee0465b4b2f">raw_deadline</a> () const</td></tr>
- <tr class="memdesc:acd431c5f1d1a7288c7dceee0465b4b2f"><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 server call's deadline. <a href="classgrpc_1_1_server_context.html#acd431c5f1d1a7288c7dceee0465b4b2f">More...</a><br /></td></tr>
- <tr class="separator:acd431c5f1d1a7288c7dceee0465b4b2f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2d3750842383ac9dd0a06ed1587eb0a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a2d3750842383ac9dd0a06ed1587eb0a6">set_compression_algorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
- <tr class="memdesc:a2d3750842383ac9dd0a06ed1587eb0a6"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the server call. <a href="classgrpc_1_1_server_context.html#a2d3750842383ac9dd0a06ed1587eb0a6">More...</a><br /></td></tr>
- <tr class="separator:a2d3750842383ac9dd0a06ed1587eb0a6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a59552b35829d48e39144e0f8eb11ec4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a59552b35829d48e39144e0f8eb11ec4b">set_compression_level</a> (<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level)</td></tr>
- <tr class="memdesc:a59552b35829d48e39144e0f8eb11ec4b"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>level</em> to be the compression level used for the server call. <a href="classgrpc_1_1_server_context.html#a59552b35829d48e39144e0f8eb11ec4b">More...</a><br /></td></tr>
- <tr class="separator:a59552b35829d48e39144e0f8eb11ec4b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8aac6e1b38b734ba079d84fe72d7855d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a8aac6e1b38b734ba079d84fe72d7855d">SetLoadReportingCosts</a> (const std::vector< std::string > &cost_data)</td></tr>
- <tr class="memdesc:a8aac6e1b38b734ba079d84fe72d7855d"><td class="mdescLeft"> </td><td class="mdescRight">Set the serialized load reporting costs in <em>cost_data</em> for the call. <a href="classgrpc_1_1_server_context.html#a8aac6e1b38b734ba079d84fe72d7855d">More...</a><br /></td></tr>
- <tr class="separator:a8aac6e1b38b734ba079d84fe72d7855d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88d3a0c3d53e39f38654ce8fba968301"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a88d3a0c3d53e39f38654ce8fba968301">TryCancel</a> () const</td></tr>
- <tr class="memdesc:a88d3a0c3d53e39f38654ce8fba968301"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the Call from the server. <a href="classgrpc_1_1_server_context.html#a88d3a0c3d53e39f38654ce8fba968301">More...</a><br /></td></tr>
- <tr class="separator:a88d3a0c3d53e39f38654ce8fba968301"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad51d67a4bd5a0960b4c15783e10a72a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ad51d67a4bd5a0960b4c15783e10a72a3">AsyncNotifyWhenDone</a> (void *tag)</td></tr>
- <tr class="memdesc:ad51d67a4bd5a0960b4c15783e10a72a3"><td class="mdescLeft"> </td><td class="mdescRight">Async only. <a href="classgrpc_1_1_server_context.html#ad51d67a4bd5a0960b4c15783e10a72a3">More...</a><br /></td></tr>
- <tr class="separator:ad51d67a4bd5a0960b4c15783e10a72a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classgrpc_1_1_server_context_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_server_context_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1_server_context_base.html">grpc::ServerContextBase</a></td></tr>
- <tr class="memitem:ac4f9a5f92caeda25d64b21241e18cabb inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#ac4f9a5f92caeda25d64b21241e18cabb">~ServerContextBase</a> ()</td></tr>
- <tr class="separator:ac4f9a5f92caeda25d64b21241e18cabb inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaa0410923dcf941e78c75e7463a34390 inherit pub_methods_classgrpc_1_1_server_context_base"><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_server_context_base.html#aaa0410923dcf941e78c75e7463a34390">deadline</a> () const</td></tr>
- <tr class="memdesc:aaa0410923dcf941e78c75e7463a34390 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the deadline for the server call. <a href="classgrpc_1_1_server_context_base.html#aaa0410923dcf941e78c75e7463a34390">More...</a><br /></td></tr>
- <tr class="separator:aaa0410923dcf941e78c75e7463a34390 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acd431c5f1d1a7288c7dceee0465b4b2f inherit pub_methods_classgrpc_1_1_server_context_base"><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_server_context_base.html#acd431c5f1d1a7288c7dceee0465b4b2f">raw_deadline</a> () const</td></tr>
- <tr class="memdesc:acd431c5f1d1a7288c7dceee0465b4b2f inherit pub_methods_classgrpc_1_1_server_context_base"><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 server call's deadline. <a href="classgrpc_1_1_server_context_base.html#acd431c5f1d1a7288c7dceee0465b4b2f">More...</a><br /></td></tr>
- <tr class="separator:acd431c5f1d1a7288c7dceee0465b4b2f inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abd7e586e89cccff633e38f8f24e11cdd inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#abd7e586e89cccff633e38f8f24e11cdd">AddInitialMetadata</a> (const std::string &key, const std::string &value)</td></tr>
- <tr class="memdesc:abd7e586e89cccff633e38f8f24e11cdd inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. <a href="classgrpc_1_1_server_context_base.html#abd7e586e89cccff633e38f8f24e11cdd">More...</a><br /></td></tr>
- <tr class="separator:abd7e586e89cccff633e38f8f24e11cdd inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea7f111233dddc155f8dcfa9c1e20184 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#aea7f111233dddc155f8dcfa9c1e20184">AddTrailingMetadata</a> (const std::string &key, const std::string &value)</td></tr>
- <tr class="memdesc:aea7f111233dddc155f8dcfa9c1e20184 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. <a href="classgrpc_1_1_server_context_base.html#aea7f111233dddc155f8dcfa9c1e20184">More...</a><br /></td></tr>
- <tr class="separator:aea7f111233dddc155f8dcfa9c1e20184 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2d0f087805b4b475d01b12d73508f09 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#af2d0f087805b4b475d01b12d73508f09">IsCancelled</a> () const</td></tr>
- <tr class="memdesc:af2d0f087805b4b475d01b12d73508f09 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return whether this RPC failed before the server could provide its status back to the client. <a href="classgrpc_1_1_server_context_base.html#af2d0f087805b4b475d01b12d73508f09">More...</a><br /></td></tr>
- <tr class="separator:af2d0f087805b4b475d01b12d73508f09 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88d3a0c3d53e39f38654ce8fba968301 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301">TryCancel</a> () const</td></tr>
- <tr class="memdesc:a88d3a0c3d53e39f38654ce8fba968301 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the Call from the server. <a href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301">More...</a><br /></td></tr>
- <tr class="separator:a88d3a0c3d53e39f38654ce8fba968301 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1424dee498921ed06e890c7134e88957 inherit pub_methods_classgrpc_1_1_server_context_base"><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_server_context_base.html#a1424dee498921ed06e890c7134e88957">client_metadata</a> () const</td></tr>
- <tr class="memdesc:a1424dee498921ed06e890c7134e88957 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return a collection of initial metadata key-value pairs sent from the client. <a href="classgrpc_1_1_server_context_base.html#a1424dee498921ed06e890c7134e88957">More...</a><br /></td></tr>
- <tr class="separator:a1424dee498921ed06e890c7134e88957 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4a7cac98ae494a7fd231d049d574095 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#ad4a7cac98ae494a7fd231d049d574095">compression_level</a> () const</td></tr>
- <tr class="memdesc:ad4a7cac98ae494a7fd231d049d574095 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm to be used by the server call. <a href="classgrpc_1_1_server_context_base.html#ad4a7cac98ae494a7fd231d049d574095">More...</a><br /></td></tr>
- <tr class="separator:ad4a7cac98ae494a7fd231d049d574095 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a59552b35829d48e39144e0f8eb11ec4b inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a59552b35829d48e39144e0f8eb11ec4b">set_compression_level</a> (<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level)</td></tr>
- <tr class="memdesc:a59552b35829d48e39144e0f8eb11ec4b inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>level</em> to be the compression level used for the server call. <a href="classgrpc_1_1_server_context_base.html#a59552b35829d48e39144e0f8eb11ec4b">More...</a><br /></td></tr>
- <tr class="separator:a59552b35829d48e39144e0f8eb11ec4b inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a942b0a431630f987d558550bf9d49dd1 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a942b0a431630f987d558550bf9d49dd1">compression_level_set</a> () const</td></tr>
- <tr class="memdesc:a942b0a431630f987d558550bf9d49dd1 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return a bool indicating whether the compression level for this call has been set (either implicitly or through a previous call to <em>set_compression_level</em>. <a href="classgrpc_1_1_server_context_base.html#a942b0a431630f987d558550bf9d49dd1">More...</a><br /></td></tr>
- <tr class="separator:a942b0a431630f987d558550bf9d49dd1 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a79723d2154ae4a48da5bef8daf41a3e7 inherit pub_methods_classgrpc_1_1_server_context_base"><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_server_context_base.html#a79723d2154ae4a48da5bef8daf41a3e7">compression_algorithm</a> () const</td></tr>
- <tr class="memdesc:a79723d2154ae4a48da5bef8daf41a3e7 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm the server call will request be used. <a href="classgrpc_1_1_server_context_base.html#a79723d2154ae4a48da5bef8daf41a3e7">More...</a><br /></td></tr>
- <tr class="separator:a79723d2154ae4a48da5bef8daf41a3e7 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2d3750842383ac9dd0a06ed1587eb0a6 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a2d3750842383ac9dd0a06ed1587eb0a6">set_compression_algorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
- <tr class="memdesc:a2d3750842383ac9dd0a06ed1587eb0a6 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the server call. <a href="classgrpc_1_1_server_context_base.html#a2d3750842383ac9dd0a06ed1587eb0a6">More...</a><br /></td></tr>
- <tr class="separator:a2d3750842383ac9dd0a06ed1587eb0a6 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8aac6e1b38b734ba079d84fe72d7855d inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a8aac6e1b38b734ba079d84fe72d7855d">SetLoadReportingCosts</a> (const std::vector< std::string > &cost_data)</td></tr>
- <tr class="memdesc:a8aac6e1b38b734ba079d84fe72d7855d inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Set the serialized load reporting costs in <em>cost_data</em> for the call. <a href="classgrpc_1_1_server_context_base.html#a8aac6e1b38b734ba079d84fe72d7855d">More...</a><br /></td></tr>
- <tr class="separator:a8aac6e1b38b734ba079d84fe72d7855d inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2b28535186cbe2d7b6ed1ff59980191b inherit pub_methods_classgrpc_1_1_server_context_base"><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_server_context_base.html#a2b28535186cbe2d7b6ed1ff59980191b">auth_context</a> () const</td></tr>
- <tr class="memdesc:a2b28535186cbe2d7b6ed1ff59980191b inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the authentication context for this server call. <a href="classgrpc_1_1_server_context_base.html#a2b28535186cbe2d7b6ed1ff59980191b">More...</a><br /></td></tr>
- <tr class="separator:a2b28535186cbe2d7b6ed1ff59980191b inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e94cf9e11550b34ab98271202f03adc inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a6e94cf9e11550b34ab98271202f03adc">peer</a> () const</td></tr>
- <tr class="memdesc:a6e94cf9e11550b34ab98271202f03adc inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Return the peer uri in a string. <a href="classgrpc_1_1_server_context_base.html#a6e94cf9e11550b34ab98271202f03adc">More...</a><br /></td></tr>
- <tr class="separator:a6e94cf9e11550b34ab98271202f03adc inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab324b4924bc290138b139a89f9b654a7 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">const 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_server_context_base.html#ab324b4924bc290138b139a89f9b654a7">census_context</a> () const</td></tr>
- <tr class="memdesc:ab324b4924bc290138b139a89f9b654a7 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Get the census context associated with this server call. <a href="classgrpc_1_1_server_context_base.html#ab324b4924bc290138b139a89f9b654a7">More...</a><br /></td></tr>
- <tr class="separator:ab324b4924bc290138b139a89f9b654a7 inherit pub_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acfdb9c2f6ebe59c5e9248ba72a7dfc2c inherit pub_methods_classgrpc_1_1_server_context_base"><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_server_context_base.html#acfdb9c2f6ebe59c5e9248ba72a7dfc2c">c_call</a> ()</td></tr>
- <tr class="memdesc:acfdb9c2f6ebe59c5e9248ba72a7dfc2c inherit pub_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Should be used for framework-level extensions only. <a href="classgrpc_1_1_server_context_base.html#acfdb9c2f6ebe59c5e9248ba72a7dfc2c">More...</a><br /></td></tr>
- <tr class="separator:acfdb9c2f6ebe59c5e9248ba72a7dfc2c inherit pub_methods_classgrpc_1_1_server_context_base"><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:a8c3fa4c066981aae114e41c3f9340144"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a8c3fa4c066981aae114e41c3f9340144">::grpc::Server</a></td></tr>
- <tr class="separator:a8c3fa4c066981aae114e41c3f9340144"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pro_methods_classgrpc_1_1_server_context_base"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc_1_1_server_context_base')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgrpc_1_1_server_context_base.html">grpc::ServerContextBase</a></td></tr>
- <tr class="memitem:ad51d67a4bd5a0960b4c15783e10a72a3 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#ad51d67a4bd5a0960b4c15783e10a72a3">AsyncNotifyWhenDone</a> (void *tag)</td></tr>
- <tr class="memdesc:ad51d67a4bd5a0960b4c15783e10a72a3 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Async only. <a href="classgrpc_1_1_server_context_base.html#ad51d67a4bd5a0960b4c15783e10a72a3">More...</a><br /></td></tr>
- <tr class="separator:ad51d67a4bd5a0960b4c15783e10a72a3 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adb549554566258beb3ebaf79a20fc80c inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">::<a class="el" href="classgrpc_1_1experimental_1_1_rpc_allocator_state.html">grpc::experimental::RpcAllocatorState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#adb549554566258beb3ebaf79a20fc80c">GetRpcAllocatorState</a> ()</td></tr>
- <tr class="memdesc:adb549554566258beb3ebaf79a20fc80c inherit pro_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">NOTE: This is an API for advanced users who need custom allocators. <a href="classgrpc_1_1_server_context_base.html#adb549554566258beb3ebaf79a20fc80c">More...</a><br /></td></tr>
- <tr class="separator:adb549554566258beb3ebaf79a20fc80c inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a43b472d234c477021c8bee6d01d6d1d8 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">::<a class="el" href="classgrpc_1_1_server_unary_reactor.html">grpc::ServerUnaryReactor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a43b472d234c477021c8bee6d01d6d1d8">DefaultReactor</a> ()</td></tr>
- <tr class="memdesc:a43b472d234c477021c8bee6d01d6d1d8 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Get a library-owned default unary reactor for use in minimal reaction cases. <a href="classgrpc_1_1_server_context_base.html#a43b472d234c477021c8bee6d01d6d1d8">More...</a><br /></td></tr>
- <tr class="separator:a43b472d234c477021c8bee6d01d6d1d8 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8e50f2206f90bdcb221232310078d33a inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a8e50f2206f90bdcb221232310078d33a">ServerContextBase</a> ()</td></tr>
- <tr class="memdesc:a8e50f2206f90bdcb221232310078d33a inherit pro_methods_classgrpc_1_1_server_context_base"><td class="mdescLeft"> </td><td class="mdescRight">Constructors for use by derived classes. <a href="classgrpc_1_1_server_context_base.html#a8e50f2206f90bdcb221232310078d33a">More...</a><br /></td></tr>
- <tr class="separator:a8e50f2206f90bdcb221232310078d33a inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af67bb06438457e78121d38c30399ba9a inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#af67bb06438457e78121d38c30399ba9a">ServerContextBase</a> (<a class="el" href="structgpr__timespec.html">gpr_timespec</a> <a class="el" href="classgrpc_1_1_server_context_base.html#aaa0410923dcf941e78c75e7463a34390">deadline</a>, <a class="el" href="structgrpc__metadata__array.html">grpc_metadata_array</a> *arr)</td></tr>
- <tr class="separator:af67bb06438457e78121d38c30399ba9a inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09e9fc2c941452180d012cb049ac1b74 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#a09e9fc2c941452180d012cb049ac1b74">set_context_allocator</a> (<a class="el" href="classgrpc_1_1_context_allocator.html">ContextAllocator</a> *<a class="el" href="classgrpc_1_1_server_context_base.html#adee121869f6acd8ea8b13d0d2f290b81">context_allocator</a>)</td></tr>
- <tr class="separator:a09e9fc2c941452180d012cb049ac1b74 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adee121869f6acd8ea8b13d0d2f290b81 inherit pro_methods_classgrpc_1_1_server_context_base"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_context_allocator.html">ContextAllocator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context_base.html#adee121869f6acd8ea8b13d0d2f290b81">context_allocator</a> () const</td></tr>
- <tr class="separator:adee121869f6acd8ea8b13d0d2f290b81 inherit pro_methods_classgrpc_1_1_server_context_base"><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_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a> or <a class="el" href="classgrpc_1_1_callback_server_context.html">CallbackServerContext</a> allows the code implementing a service handler to: </p>
- <ul>
- <li>Add custom initial and trailing metadata key-value pairs that will propagated to the client side.</li>
- <li>Control call settings such as compression and authentication.</li>
- <li>Access metadata coming from the client.</li>
- <li>Get performance metrics (ie, census).</li>
- </ul>
- <p>Context settings are only relevant to the call handler they are supplied to, that is to say, they aren't sticky across multiple calls. Some of these settings, such as the compression options, can be made persistent at server construction time by specifying the appropriate <em><a class="el" href="classgrpc_1_1_channel_arguments.html" title="Options for channel creation.">ChannelArguments</a></em> to a <em><a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">grpc::ServerBuilder</a></em>, via <em><a class="el" href="classgrpc_1_1_server_builder.html#a164cbea7979b0d9826a110ae7429449b" title="Add a channel argument (an escape hatch to tuning core library parameters directly)">ServerBuilder::AddChannelArgument</a></em>.</p>
- <dl class="section warning"><dt>Warning</dt><dd><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a> instances should <em>not</em> be reused across rpcs. </dd></dl>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a10f47e15934195dcaed6b756498b8fff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a10f47e15934195dcaed6b756498b8fff">◆ </a></span>ServerContext()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ServerContext::ServerContext </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">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="abd7e586e89cccff633e38f8f24e11cdd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abd7e586e89cccff633e38f8f24e11cdd">◆ </a></span>AddInitialMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::AddInitialMetadata</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. </p>
- <p>These are made available at the client side by the <em><a class="el" href="classgrpc_1_1_client_context.html#a068592f22fe0866293c8d1e5ac22ed20" title="Return a collection of initial metadata key-value pairs.">grpc::ClientContext::GetServerInitialMetadata()</a></em> method.</p>
- <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before sending initial metadata to the client (which can happen explicitly, or implicitly when sending a a response message or status to the client).</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">key</td><td>The metadata key. If <em>value</em> is binary data, it must end in "-bin". </td></tr>
- <tr><td class="paramname">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="aea7f111233dddc155f8dcfa9c1e20184"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea7f111233dddc155f8dcfa9c1e20184">◆ </a></span>AddTrailingMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::AddTrailingMetadata</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add the (<em>key</em>, <em>value</em>) pair to the initial metadata associated with a server call. </p>
- <p>These are made available at the client side by the <em><a class="el" href="classgrpc_1_1_client_context.html#a572f9fb786e1dfc3129a04183d9f1882" title="Return a collection of trailing metadata key-value pairs.">grpc::ClientContext::GetServerTrailingMetadata()</a></em> method.</p>
- <dl class="section warning"><dt>Warning</dt><dd>This method should only be called before sending trailing metadata to the client (which happens when the call is finished and a status is sent to the client).</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">key</td><td>The metadata key. If <em>value</em> is binary data, it must end in "-bin". </td></tr>
- <tr><td class="paramname">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="ad51d67a4bd5a0960b4c15783e10a72a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad51d67a4bd5a0960b4c15783e10a72a3">◆ </a></span>AsyncNotifyWhenDone()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::AsyncNotifyWhenDone</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>Async only. </p>
- <p>Has to be called before the rpc starts. Returns the tag in completion queue when the rpc finishes. <a class="el" href="classgrpc_1_1_server_context_base.html#af2d0f087805b4b475d01b12d73508f09" title="Return whether this RPC failed before the server could provide its status back to the client.">IsCancelled()</a> can then be called to check whether the rpc was cancelled. TODO(vjpai): Fix this so that the tag is returned even if the call never starts (<a href="https://github.com/grpc/grpc/issues/10136">https://github.com/grpc/grpc/issues/10136</a>). </p>
- </div>
- </div>
- <a id="a2b28535186cbe2d7b6ed1ff59980191b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2b28535186cbe2d7b6ed1ff59980191b">◆ </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::ServerContextBase::auth_context</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 this server 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="acfdb9c2f6ebe59c5e9248ba72a7dfc2c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acfdb9c2f6ebe59c5e9248ba72a7dfc2c">◆ </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::ServerContextBase::c_call</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="ab324b4924bc290138b139a89f9b654a7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab324b4924bc290138b139a89f9b654a7">◆ </a></span>census_context()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const struct <a class="el" href="census_8h.html#a27fc8788690179599713226f1f054736">census_context</a>* grpc::ServerContextBase::census_context</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the census context associated with this server call. </p>
- </div>
- </div>
- <a id="a1424dee498921ed06e890c7134e88957"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1424dee498921ed06e890c7134e88957">◆ </a></span>client_metadata()</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::ServerContextBase::client_metadata</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 sent from the client. </p>
- <p>Note that keys may happen more than once (ie, a <em>std::multimap</em> is returned).</p>
- <p>It is safe to use this method after initial metadata has been received, Calls always begin with the client sending initial metadata, so this is safe to access as soon as the call has begun on the server side.</p>
- <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="a79723d2154ae4a48da5bef8daf41a3e7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a79723d2154ae4a48da5bef8daf41a3e7">◆ </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::ServerContextBase::compression_algorithm</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 server call will request be used. </p>
- <p>Note that the gRPC runtime may decide to ignore this request, for example, due to resource constraints, or if the server is aware the client doesn't support the requested algorithm. </p>
- </div>
- </div>
- <a id="ad4a7cac98ae494a7fd231d049d574095"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad4a7cac98ae494a7fd231d049d574095">◆ </a></span>compression_level()</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#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc::ServerContextBase::compression_level</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 to be used by the server call. </p>
- </div>
- </div>
- <a id="a942b0a431630f987d558550bf9d49dd1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a942b0a431630f987d558550bf9d49dd1">◆ </a></span>compression_level_set()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool grpc::ServerContextBase::compression_level_set</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 bool indicating whether the compression level for this call has been set (either implicitly or through a previous call to <em>set_compression_level</em>. </p>
- </div>
- </div>
- <a id="aaa0410923dcf941e78c75e7463a34390"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aaa0410923dcf941e78c75e7463a34390">◆ </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::ServerContextBase::deadline</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 server call. </p>
- </div>
- </div>
- <a id="af2d0f087805b4b475d01b12d73508f09"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af2d0f087805b4b475d01b12d73508f09">◆ </a></span>IsCancelled()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool grpc::ServerContextBase::IsCancelled</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return whether this RPC failed before the server could provide its status back to the client. </p>
- <p>This could be because of explicit API cancellation from the client-side or server-side, because of deadline exceeded, network connection reset, HTTP/2 parameter configuration (e.g., max message size, max connection age), etc. It does NOT include failure due to a non-OK status return from the server application's request handler, including <a class="el" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab" title="A CANCELLED pre-defined instance.">Status::CANCELLED</a>.</p>
- <p>IsCancelled is always safe to call when using sync or callback API. When using async API, it is only safe to call IsCancelled after the AsyncNotifyWhenDone tag has been delivered. Thread-safe. </p>
- </div>
- </div>
- <a id="a6e94cf9e11550b34ab98271202f03adc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6e94cf9e11550b34ab98271202f03adc">◆ </a></span>peer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">std::string grpc::ServerContextBase::peer</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the peer uri in a string. </p>
- <p>WARNING: 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. </p>
- </div>
- </div>
- <a id="acd431c5f1d1a7288c7dceee0465b4b2f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acd431c5f1d1a7288c7dceee0465b4b2f">◆ </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::ServerContextBase::raw_deadline</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 server call's deadline. </p>
- </div>
- </div>
- <a id="a2d3750842383ac9dd0a06ed1587eb0a6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2d3750842383ac9dd0a06ed1587eb0a6">◆ </a></span>set_compression_algorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::set_compression_algorithm</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set <em>algorithm</em> to be the compression algorithm used for the server 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 server call. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a59552b35829d48e39144e0f8eb11ec4b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a59552b35829d48e39144e0f8eb11ec4b">◆ </a></span>set_compression_level()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::set_compression_level</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 <em>level</em> to be the compression level used for the server call. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">level</td><td>The compression level used for the server call. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a8aac6e1b38b734ba079d84fe72d7855d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8aac6e1b38b734ba079d84fe72d7855d">◆ </a></span>SetLoadReportingCosts()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::SetLoadReportingCosts</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the serialized load reporting costs in <em>cost_data</em> for the call. </p>
- </div>
- </div>
- <a id="a88d3a0c3d53e39f38654ce8fba968301"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a88d3a0c3d53e39f38654ce8fba968301">◆ </a></span>TryCancel()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContextBase::TryCancel</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Cancel the Call from the server. </p>
- <p>This is a best-effort API and depending on when it is called, the RPC may still appear successful to the client. For example, if <a class="el" href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301" title="Cancel the Call from the server.">TryCancel()</a> is called on a separate thread, it might race with the server handler which might return success to the client before <a class="el" href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301" title="Cancel the Call from the server.">TryCancel()</a> was even started by the thread.</p>
- <p>It is the caller's responsibility to prevent such races and ensure that if <a class="el" href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301" title="Cancel the Call from the server.">TryCancel()</a> is called, the serverhandler must return <a class="el" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab" title="A CANCELLED pre-defined instance.">Status::CANCELLED</a>. The only exception is that if the serverhandler is already returning an error status code, it is ok to not return <a class="el" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab" title="A CANCELLED pre-defined instance.">Status::CANCELLED</a> even if <a class="el" href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301" title="Cancel the Call from the server.">TryCancel()</a> was called.</p>
- <p>For reasons such as the above, it is generally preferred to explicitly finish an RPC by returning <a class="el" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab" title="A CANCELLED pre-defined instance.">Status::CANCELLED</a> rather than using TryCancel.</p>
- <p>Note that <a class="el" href="classgrpc_1_1_server_context_base.html#a88d3a0c3d53e39f38654ce8fba968301" title="Cancel the Call from the server.">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="a8c3fa4c066981aae114e41c3f9340144"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8c3fa4c066981aae114e41c3f9340144">◆ </a></span>::grpc::Server</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_server.html">grpc::Server</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>
- <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_2server__context_8h_source.html">server_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:25 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>
|