1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
- <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" />
- <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </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 allows the person implementing a service handler to: ">ServerContext</a> allows the person 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:afd37847b1bdba2f82e472fed6f31cea6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#afd37847b1bdba2f82e472fed6f31cea6">~ServerContext</a> ()</td></tr>
- <tr class="separator:afd37847b1bdba2f82e472fed6f31cea6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2df58ff8964cdfad5492ef798348a611"><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#a2df58ff8964cdfad5492ef798348a611">deadline</a> () const</td></tr>
- <tr class="memdesc:a2df58ff8964cdfad5492ef798348a611"><td class="mdescLeft"> </td><td class="mdescRight">Return the deadline for the server call. <a href="#a2df58ff8964cdfad5492ef798348a611">More...</a><br /></td></tr>
- <tr class="separator:a2df58ff8964cdfad5492ef798348a611"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa08a9e9e4b371d94638b9345ff417637"><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#aa08a9e9e4b371d94638b9345ff417637">raw_deadline</a> () const</td></tr>
- <tr class="memdesc:aa08a9e9e4b371d94638b9345ff417637"><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="#aa08a9e9e4b371d94638b9345ff417637">More...</a><br /></td></tr>
- <tr class="separator:aa08a9e9e4b371d94638b9345ff417637"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae3371f0adf8521c7097eee437fc4ca4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ae3371f0adf8521c7097eee437fc4ca4f">AddInitialMetadata</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &key, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &value)</td></tr>
- <tr class="memdesc:ae3371f0adf8521c7097eee437fc4ca4f"><td class="mdescLeft"> </td><td class="mdescRight">Add the (<em>meta_key</em>, <em>meta_value</em>) pair to the initial metadata associated with a server call. <a href="#ae3371f0adf8521c7097eee437fc4ca4f">More...</a><br /></td></tr>
- <tr class="separator:ae3371f0adf8521c7097eee437fc4ca4f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac30e12c4ee3ca008522b24157f4f886c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ac30e12c4ee3ca008522b24157f4f886c">AddTrailingMetadata</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &key, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &value)</td></tr>
- <tr class="memdesc:ac30e12c4ee3ca008522b24157f4f886c"><td class="mdescLeft"> </td><td class="mdescRight">Add the (<em>meta_key</em>, <em>meta_value</em>) pair to the initial metadata associated with a server call. <a href="#ac30e12c4ee3ca008522b24157f4f886c">More...</a><br /></td></tr>
- <tr class="separator:ac30e12c4ee3ca008522b24157f4f886c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acea4ed6d22ccf89185194310935e2966"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#acea4ed6d22ccf89185194310935e2966">IsCancelled</a> () const</td></tr>
- <tr class="memdesc:acea4ed6d22ccf89185194310935e2966"><td class="mdescLeft"> </td><td class="mdescRight">IsCancelled is always safe to call when using sync API. <a href="#acea4ed6d22ccf89185194310935e2966">More...</a><br /></td></tr>
- <tr class="separator:acea4ed6d22ccf89185194310935e2966"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8569c71704f03f3b1089745228c70e3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a8569c71704f03f3b1089745228c70e3b">TryCancel</a> () const</td></tr>
- <tr class="memdesc:a8569c71704f03f3b1089745228c70e3b"><td class="mdescLeft"> </td><td class="mdescRight">Cancel the Call from the server. <a href="#a8569c71704f03f3b1089745228c70e3b">More...</a><br /></td></tr>
- <tr class="separator:a8569c71704f03f3b1089745228c70e3b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5a20c293202e1af2a61ffd5ea75d951"><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#ad5a20c293202e1af2a61ffd5ea75d951">client_metadata</a> () const</td></tr>
- <tr class="memdesc:ad5a20c293202e1af2a61ffd5ea75d951"><td class="mdescLeft"> </td><td class="mdescRight">Return a collection of initial metadata key-value pairs sent from the client. <a href="#ad5a20c293202e1af2a61ffd5ea75d951">More...</a><br /></td></tr>
- <tr class="separator:ad5a20c293202e1af2a61ffd5ea75d951"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5d25b4bd8d9c8d716188f3984502bee3"><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#a5d25b4bd8d9c8d716188f3984502bee3">compression_level</a> () const</td></tr>
- <tr class="memdesc:a5d25b4bd8d9c8d716188f3984502bee3"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm to be used by the server call. <a href="#a5d25b4bd8d9c8d716188f3984502bee3">More...</a><br /></td></tr>
- <tr class="separator:a5d25b4bd8d9c8d716188f3984502bee3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accfdf160f46aa20eda843443c3eea91d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#accfdf160f46aa20eda843443c3eea91d">set_compression_level</a> (<a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level)</td></tr>
- <tr class="memdesc:accfdf160f46aa20eda843443c3eea91d"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the server call. <a href="#accfdf160f46aa20eda843443c3eea91d">More...</a><br /></td></tr>
- <tr class="separator:accfdf160f46aa20eda843443c3eea91d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab8e42bfddefcc7ae2b39eb54dfd828d8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ab8e42bfddefcc7ae2b39eb54dfd828d8">compression_level_set</a> () const</td></tr>
- <tr class="memdesc:ab8e42bfddefcc7ae2b39eb54dfd828d8"><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="#ab8e42bfddefcc7ae2b39eb54dfd828d8">More...</a><br /></td></tr>
- <tr class="separator:ab8e42bfddefcc7ae2b39eb54dfd828d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aba3dc7ab1bf20f39b23c8121ee126bdf"><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#aba3dc7ab1bf20f39b23c8121ee126bdf">compression_algorithm</a> () const</td></tr>
- <tr class="memdesc:aba3dc7ab1bf20f39b23c8121ee126bdf"><td class="mdescLeft"> </td><td class="mdescRight">Return the compression algorithm the server call will request be used. <a href="#aba3dc7ab1bf20f39b23c8121ee126bdf">More...</a><br /></td></tr>
- <tr class="separator:aba3dc7ab1bf20f39b23c8121ee126bdf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ade949b886faed50627e5cbd35fe4ec72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ade949b886faed50627e5cbd35fe4ec72">set_compression_algorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
- <tr class="memdesc:ade949b886faed50627e5cbd35fe4ec72"><td class="mdescLeft"> </td><td class="mdescRight">Set <em>algorithm</em> to be the compression algorithm used for the server call. <a href="#ade949b886faed50627e5cbd35fe4ec72">More...</a><br /></td></tr>
- <tr class="separator:ade949b886faed50627e5cbd35fe4ec72"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afbc7d2c4cbd82ec7da26389b0ba648b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#afbc7d2c4cbd82ec7da26389b0ba648b0">SetLoadReportingCosts</a> (const std::vector< <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> > &cost_data)</td></tr>
- <tr class="memdesc:afbc7d2c4cbd82ec7da26389b0ba648b0"><td class="mdescLeft"> </td><td class="mdescRight">Set the load reporting costs in <em>cost_data</em> for the call. <a href="#afbc7d2c4cbd82ec7da26389b0ba648b0">More...</a><br /></td></tr>
- <tr class="separator:afbc7d2c4cbd82ec7da26389b0ba648b0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4fab4435aac1be0a92e246507e4167ce"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< const <a class="el" href="classgrpc_1_1_auth_context.html">AuthContext</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a4fab4435aac1be0a92e246507e4167ce">auth_context</a> () const</td></tr>
- <tr class="memdesc:a4fab4435aac1be0a92e246507e4167ce"><td class="mdescLeft"> </td><td class="mdescRight">Return the authentication context for this server call. <a href="#a4fab4435aac1be0a92e246507e4167ce">More...</a><br /></td></tr>
- <tr class="separator:a4fab4435aac1be0a92e246507e4167ce"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3cfef289aae820e074d88429ee0d41c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a3cfef289aae820e074d88429ee0d41c4">peer</a> () const</td></tr>
- <tr class="memdesc:a3cfef289aae820e074d88429ee0d41c4"><td class="mdescLeft"> </td><td class="mdescRight">Return the peer uri in a string. <a href="#a3cfef289aae820e074d88429ee0d41c4">More...</a><br /></td></tr>
- <tr class="separator:a3cfef289aae820e074d88429ee0d41c4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac81c8a0c2c7b28d8caba41ccf12d121c"><td class="memItemLeft" align="right" valign="top">const struct census_context * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ac81c8a0c2c7b28d8caba41ccf12d121c">census_context</a> () const</td></tr>
- <tr class="memdesc:ac81c8a0c2c7b28d8caba41ccf12d121c"><td class="mdescLeft"> </td><td class="mdescRight">Get the census context associated with this server call. <a href="#ac81c8a0c2c7b28d8caba41ccf12d121c">More...</a><br /></td></tr>
- <tr class="separator:ac81c8a0c2c7b28d8caba41ccf12d121c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aafcb8e430e3d81bcd3f0a88701a19fba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#aafcb8e430e3d81bcd3f0a88701a19fba">AsyncNotifyWhenDone</a> (void *tag)</td></tr>
- <tr class="memdesc:aafcb8e430e3d81bcd3f0a88701a19fba"><td class="mdescLeft"> </td><td class="mdescRight">Async only. <a href="#aafcb8e430e3d81bcd3f0a88701a19fba">More...</a><br /></td></tr>
- <tr class="separator:aafcb8e430e3d81bcd3f0a88701a19fba"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac23879ea6fee39bbe27c6b6192989d61"><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#ac23879ea6fee39bbe27c6b6192989d61">c_call</a> ()</td></tr>
- <tr class="memdesc:ac23879ea6fee39bbe27c6b6192989d61"><td class="mdescLeft"> </td><td class="mdescRight">Should be used for framework-level extensions only. <a href="#ac23879ea6fee39bbe27c6b6192989d61">More...</a><br /></td></tr>
- <tr class="separator:ac23879ea6fee39bbe27c6b6192989d61"><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:a23b6c885fa0656c25c2a46ab22e99270"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a23b6c885fa0656c25c2a46ab22e99270">::grpc::testing::InteropServerContextInspector</a></td></tr>
- <tr class="separator:a23b6c885fa0656c25c2a46ab22e99270"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1cc35b5d4492397bf75bf6c08367a58b"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a1cc35b5d4492397bf75bf6c08367a58b">::grpc::testing::ServerContextTestSpouse</a></td></tr>
- <tr class="separator:a1cc35b5d4492397bf75bf6c08367a58b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8edbec79fc5ad7456e57c0f513451e2f"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a8edbec79fc5ad7456e57c0f513451e2f">::grpc::ServerInterface</a></td></tr>
- <tr class="separator:a8edbec79fc5ad7456e57c0f513451e2f"><td class="memSeparator" colspan="2"> </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>
- <tr class="memitem:a774bb57486686958c67f29072de768ed"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a774bb57486686958c67f29072de768ed"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a774bb57486686958c67f29072de768ed">::grpc::ServerAsyncReader</a></td></tr>
- <tr class="separator:a774bb57486686958c67f29072de768ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6068d9e3369a1016e7b75350b80f4f45"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:a6068d9e3369a1016e7b75350b80f4f45"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a6068d9e3369a1016e7b75350b80f4f45">::grpc::ServerAsyncWriter</a></td></tr>
- <tr class="separator:a6068d9e3369a1016e7b75350b80f4f45"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2c679b602d120c70a6713fe742704b4e"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:a2c679b602d120c70a6713fe742704b4e"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a2c679b602d120c70a6713fe742704b4e">::grpc::ServerAsyncResponseWriter</a></td></tr>
- <tr class="separator:a2c679b602d120c70a6713fe742704b4e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85f3f3dc5b92690c676b86571be20684"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a85f3f3dc5b92690c676b86571be20684"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a85f3f3dc5b92690c676b86571be20684">::grpc::ServerAsyncReaderWriter</a></td></tr>
- <tr class="separator:a85f3f3dc5b92690c676b86571be20684"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4f20e2d049342ae00242bbc8021a44bd"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:a4f20e2d049342ae00242bbc8021a44bd"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a4f20e2d049342ae00242bbc8021a44bd">::grpc::ServerReader</a></td></tr>
- <tr class="separator:a4f20e2d049342ae00242bbc8021a44bd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2f2dfa831a62c43ad5647a45080488e3"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:a2f2dfa831a62c43ad5647a45080488e3"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a2f2dfa831a62c43ad5647a45080488e3">::grpc::ServerWriter</a></td></tr>
- <tr class="separator:a2f2dfa831a62c43ad5647a45080488e3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a81fd5fb92dd22dced55726c389f3ea29"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a81fd5fb92dd22dced55726c389f3ea29"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a81fd5fb92dd22dced55726c389f3ea29">::grpc::internal::ServerReaderWriterBody</a></td></tr>
- <tr class="separator:a81fd5fb92dd22dced55726c389f3ea29"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4e0fda6a3be8543f0d9f79f297533e9"><td class="memTemplParams" colspan="2">template<class ServiceType , class RequestType , class ResponseType > </td></tr>
- <tr class="memitem:ab4e0fda6a3be8543f0d9f79f297533e9"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ab4e0fda6a3be8543f0d9f79f297533e9">::grpc::internal::RpcMethodHandler</a></td></tr>
- <tr class="separator:ab4e0fda6a3be8543f0d9f79f297533e9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aee2bfad715a7c61f2839cdc9b5be6ef5"><td class="memTemplParams" colspan="2">template<class ServiceType , class RequestType , class ResponseType > </td></tr>
- <tr class="memitem:aee2bfad715a7c61f2839cdc9b5be6ef5"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#aee2bfad715a7c61f2839cdc9b5be6ef5">::grpc::internal::ClientStreamingHandler</a></td></tr>
- <tr class="separator:aee2bfad715a7c61f2839cdc9b5be6ef5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abba72ec6d1dbf06ecb1bf48e1c916c48"><td class="memTemplParams" colspan="2">template<class ServiceType , class RequestType , class ResponseType > </td></tr>
- <tr class="memitem:abba72ec6d1dbf06ecb1bf48e1c916c48"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#abba72ec6d1dbf06ecb1bf48e1c916c48">::grpc::internal::ServerStreamingHandler</a></td></tr>
- <tr class="separator:abba72ec6d1dbf06ecb1bf48e1c916c48"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a65ae6d263727d1e67e811969f909212b"><td class="memTemplParams" colspan="2">template<class Streamer , bool WriteNeeded> </td></tr>
- <tr class="memitem:a65ae6d263727d1e67e811969f909212b"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a65ae6d263727d1e67e811969f909212b">::grpc::internal::TemplatedBidiStreamingHandler</a></td></tr>
- <tr class="separator:a65ae6d263727d1e67e811969f909212b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a445fc31dd2f75f5686fd6bd1c6be5c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#a7a445fc31dd2f75f5686fd6bd1c6be5c">::grpc::internal::UnknownMethodHandler</a></td></tr>
- <tr class="separator:a7a445fc31dd2f75f5686fd6bd1c6be5c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5c51aa9b375ed1597b0a57f339f59d5"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_context.html#ad5c51aa9b375ed1597b0a57f339f59d5">::grpc::ClientContext</a></td></tr>
- <tr class="separator:ad5c51aa9b375ed1597b0a57f339f59d5"><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 allows the person implementing a service handler to: ">ServerContext</a> allows the person 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#aefdac3407920a99d119c946d255b100c" 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 allows the person 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="memname">
- <tr>
- <td class="memname">grpc::ServerContext::ServerContext </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="afd37847b1bdba2f82e472fed6f31cea6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afd37847b1bdba2f82e472fed6f31cea6">◆ </a></span>~ServerContext()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ServerContext::~ServerContext </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="ae3371f0adf8521c7097eee437fc4ca4f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae3371f0adf8521c7097eee437fc4ca4f">◆ </a></span>AddInitialMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContext::AddInitialMetadata </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>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 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">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>
- </div>
- </div>
- <a id="ac30e12c4ee3ca008522b24157f4f886c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac30e12c4ee3ca008522b24157f4f886c">◆ </a></span>AddTrailingMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContext::AddTrailingMetadata </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>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 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">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>
- </div>
- </div>
- <a id="aafcb8e430e3d81bcd3f0a88701a19fba"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aafcb8e430e3d81bcd3f0a88701a19fba">◆ </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::ServerContext::AsyncNotifyWhenDone </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</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>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.html#acea4ed6d22ccf89185194310935e2966" title="IsCancelled is always safe to call when using sync API. ">IsCancelled()</a> can then be called to check whether the rpc was cancelled. </p>
- </div>
- </div>
- <a id="a4fab4435aac1be0a92e246507e4167ce"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4fab4435aac1be0a92e246507e4167ce">◆ </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">AuthContext</a>> grpc::ServerContext::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 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="ac23879ea6fee39bbe27c6b6192989d61"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac23879ea6fee39bbe27c6b6192989d61">◆ </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::ServerContext::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="ac81c8a0c2c7b28d8caba41ccf12d121c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac81c8a0c2c7b28d8caba41ccf12d121c">◆ </a></span>census_context()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const struct census_context* grpc::ServerContext::census_context </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the census context associated with this server call. </p>
- </div>
- </div>
- <a id="ad5a20c293202e1af2a61ffd5ea75d951"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad5a20c293202e1af2a61ffd5ea75d951">◆ </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::ServerContext::client_metadata </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 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="aba3dc7ab1bf20f39b23c8121ee126bdf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aba3dc7ab1bf20f39b23c8121ee126bdf">◆ </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::ServerContext::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 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="a5d25b4bd8d9c8d716188f3984502bee3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5d25b4bd8d9c8d716188f3984502bee3">◆ </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::ServerContext::compression_level </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 to be used by the server call. </p>
- </div>
- </div>
- <a id="ab8e42bfddefcc7ae2b39eb54dfd828d8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab8e42bfddefcc7ae2b39eb54dfd828d8">◆ </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::ServerContext::compression_level_set </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 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="a2df58ff8964cdfad5492ef798348a611"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2df58ff8964cdfad5492ef798348a611">◆ </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::ServerContext::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 server call. </p>
- </div>
- </div>
- <a id="acea4ed6d22ccf89185194310935e2966"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acea4ed6d22ccf89185194310935e2966">◆ </a></span>IsCancelled()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool grpc::ServerContext::IsCancelled </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>IsCancelled is always safe to call when using sync API. </p>
- <p>When using async API, it is only safe to call IsCancelled after the AsyncNotifyWhenDone tag has been delivered. </p>
- </div>
- </div>
- <a id="a3cfef289aae820e074d88429ee0d41c4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3cfef289aae820e074d88429ee0d41c4">◆ </a></span>peer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::ServerContext::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>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="aa08a9e9e4b371d94638b9345ff417637"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa08a9e9e4b371d94638b9345ff417637">◆ </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::ServerContext::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 server call's deadline. </p>
- </div>
- </div>
- <a id="ade949b886faed50627e5cbd35fe4ec72"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ade949b886faed50627e5cbd35fe4ec72">◆ </a></span>set_compression_algorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContext::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 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="accfdf160f46aa20eda843443c3eea91d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#accfdf160f46aa20eda843443c3eea91d">◆ </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::ServerContext::set_compression_level </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="compression__types_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> </td>
- <td class="paramname"><em>level</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 <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="afbc7d2c4cbd82ec7da26389b0ba648b0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afbc7d2c4cbd82ec7da26389b0ba648b0">◆ </a></span>SetLoadReportingCosts()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContext::SetLoadReportingCosts </td>
- <td>(</td>
- <td class="paramtype">const std::vector< <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> > & </td>
- <td class="paramname"><em>cost_data</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the load reporting costs in <em>cost_data</em> for the call. </p>
- </div>
- </div>
- <a id="a8569c71704f03f3b1089745228c70e3b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8569c71704f03f3b1089745228c70e3b">◆ </a></span>TryCancel()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ServerContext::TryCancel </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</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.html#a8569c71704f03f3b1089745228c70e3b" 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.html#a8569c71704f03f3b1089745228c70e3b" 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.html#a8569c71704f03f3b1089745228c70e3b" 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.html#a8569c71704f03f3b1089745228c70e3b" title="Cancel the Call from the server. ">TryCancel()</a> was called.</p>
- <p>Note that <a class="el" href="classgrpc_1_1_server_context.html#a8569c71704f03f3b1089745228c70e3b" 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="ad5c51aa9b375ed1597b0a57f339f59d5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad5c51aa9b375ed1597b0a57f339f59d5">◆ </a></span>::grpc::ClientContext</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_client_context.html">grpc::ClientContext</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="aee2bfad715a7c61f2839cdc9b5be6ef5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aee2bfad715a7c61f2839cdc9b5be6ef5">◆ </a></span>::grpc::internal::ClientStreamingHandler</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class ServiceType , class RequestType , class ResponseType > </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_streaming_handler.html">grpc::internal::ClientStreamingHandler</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="ab4e0fda6a3be8543f0d9f79f297533e9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab4e0fda6a3be8543f0d9f79f297533e9">◆ </a></span>::grpc::internal::RpcMethodHandler</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class ServiceType , class RequestType , class ResponseType > </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_rpc_method_handler.html">grpc::internal::RpcMethodHandler</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="a81fd5fb92dd22dced55726c389f3ea29"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a81fd5fb92dd22dced55726c389f3ea29">◆ </a></span>::grpc::internal::ServerReaderWriterBody</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_1internal_1_1_server_reader_writer_body.html">grpc::internal::ServerReaderWriterBody</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="abba72ec6d1dbf06ecb1bf48e1c916c48"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abba72ec6d1dbf06ecb1bf48e1c916c48">◆ </a></span>::grpc::internal::ServerStreamingHandler</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class ServiceType , class RequestType , class ResponseType > </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_server_streaming_handler.html">grpc::internal::ServerStreamingHandler</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="a65ae6d263727d1e67e811969f909212b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a65ae6d263727d1e67e811969f909212b">◆ </a></span>::grpc::internal::TemplatedBidiStreamingHandler</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class Streamer , bool WriteNeeded> </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_templated_bidi_streaming_handler.html">grpc::internal::TemplatedBidiStreamingHandler</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="a7a445fc31dd2f75f5686fd6bd1c6be5c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7a445fc31dd2f75f5686fd6bd1c6be5c">◆ </a></span>::grpc::internal::UnknownMethodHandler</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_unknown_method_handler.html">grpc::internal::UnknownMethodHandler</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="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>
- <a id="a774bb57486686958c67f29072de768ed"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a774bb57486686958c67f29072de768ed">◆ </a></span>::grpc::ServerAsyncReader</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_server_async_reader.html">grpc::ServerAsyncReader</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="a85f3f3dc5b92690c676b86571be20684"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a85f3f3dc5b92690c676b86571be20684">◆ </a></span>::grpc::ServerAsyncReaderWriter</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_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</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="a2c679b602d120c70a6713fe742704b4e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2c679b602d120c70a6713fe742704b4e">◆ </a></span>::grpc::ServerAsyncResponseWriter</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_server_async_response_writer.html">grpc::ServerAsyncResponseWriter</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="a6068d9e3369a1016e7b75350b80f4f45"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6068d9e3369a1016e7b75350b80f4f45">◆ </a></span>::grpc::ServerAsyncWriter</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_server_async_writer.html">grpc::ServerAsyncWriter</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="a8edbec79fc5ad7456e57c0f513451e2f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8edbec79fc5ad7456e57c0f513451e2f">◆ </a></span>::grpc::ServerInterface</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_interface.html">grpc::ServerInterface</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="a4f20e2d049342ae00242bbc8021a44bd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4f20e2d049342ae00242bbc8021a44bd">◆ </a></span>::grpc::ServerReader</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_server_reader.html">grpc::ServerReader</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="a2f2dfa831a62c43ad5647a45080488e3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2f2dfa831a62c43ad5647a45080488e3">◆ </a></span>::grpc::ServerWriter</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_server_writer.html">grpc::ServerWriter</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="a23b6c885fa0656c25c2a46ab22e99270"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a23b6c885fa0656c25c2a46ab22e99270">◆ </a></span>::grpc::testing::InteropServerContextInspector</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::InteropServerContextInspector</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="a1cc35b5d4492397bf75bf6c08367a58b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1cc35b5d4492397bf75bf6c08367a58b">◆ </a></span>::grpc::testing::ServerContextTestSpouse</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::ServerContextTestSpouse</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 Tue May 15 2018 17:01:01 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|