diff options
Diffstat (limited to 'doc/ref/core.internal/html/channel_8c.html')
| -rw-r--r-- | doc/ref/core.internal/html/channel_8c.html | 639 |
1 files changed, 639 insertions, 0 deletions
diff --git a/doc/ref/core.internal/html/channel_8c.html b/doc/ref/core.internal/html/channel_8c.html new file mode 100644 index 0000000000..1be01c2300 --- /dev/null +++ b/doc/ref/core.internal/html/channel_8c.html @@ -0,0 +1,639 @@ +<!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.6"/> +<title>GRPC Core: src/core/surface/channel.c File 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">GRPC Core +  <span id="projectnumber">0.10.0.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_ea54cbef5e3ffa125df07262bbfc9627.html">surface</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Data Structures</a> | +<a href="#define-members">Macros</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">channel.c File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include "<a class="el" href="channel_8h_source.html">src/core/surface/channel.h</a>"</code><br/> +<code>#include <stdlib.h></code><br/> +<code>#include <<a class="el" href="string_8h_source.html">string.h</a>></code><br/> +<code>#include <<a class="el" href="alloc_8h_source.html">grpc/support/alloc.h</a>></code><br/> +<code>#include <<a class="el" href="log_8h_source.html">grpc/support/log.h</a>></code><br/> +<code>#include <<a class="el" href="string__util_8h_source.html">grpc/support/string_util.h</a>></code><br/> +<code>#include "<a class="el" href="iomgr_8h_source.html">src/core/iomgr/iomgr.h</a>"</code><br/> +<code>#include "<a class="el" href="call_8h_source.html">src/core/surface/call.h</a>"</code><br/> +<code>#include "<a class="el" href="init_8h_source.html">src/core/surface/init.h</a>"</code><br/> +</div><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structregistered__call.html">registered_call</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__channel.html">grpc_channel</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:a30ddfda40b473a077ff7c70a7687ddb1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a30ddfda40b473a077ff7c70a7687ddb1">NUM_CACHED_STATUS_ELEMS</a>   3</td></tr> +<tr class="memdesc:a30ddfda40b473a077ff7c70a7687ddb1"><td class="mdescLeft"> </td><td class="mdescRight">Cache grpc-status: X mdelems for X = 0..NUM_CACHED_STATUS_ELEMS. <a href="#a30ddfda40b473a077ff7c70a7687ddb1">More...</a><br/></td></tr> +<tr class="separator:a30ddfda40b473a077ff7c70a7687ddb1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a66dde7aaec84b22bf4ddfa999a2201ed"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a66dde7aaec84b22bf4ddfa999a2201ed">CHANNEL_STACK_FROM_CHANNEL</a>(c)   ((<a class="el" href="structgrpc__channel__stack.html">grpc_channel_stack</a> *)((c) + 1))</td></tr> +<tr class="separator:a66dde7aaec84b22bf4ddfa999a2201ed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae9cf519e646bc07f4b32920f39fba049"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#ae9cf519e646bc07f4b32920f39fba049">CHANNEL_FROM_CHANNEL_STACK</a>(channel_stack)   (((<a class="el" href="structgrpc__channel.html">grpc_channel</a> *)(channel_stack)) - 1)</td></tr> +<tr class="separator:ae9cf519e646bc07f4b32920f39fba049"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a79c20e305865805bbe3e21adc8da9e72"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a79c20e305865805bbe3e21adc8da9e72">CHANNEL_FROM_TOP_ELEM</a>(top_elem)   <a class="el" href="channel_8c.html#ae9cf519e646bc07f4b32920f39fba049">CHANNEL_FROM_CHANNEL_STACK</a>(<a class="el" href="channel__stack_8c.html#a5fd8b3503ac2f8193509e2ce02ef9406">grpc_channel_stack_from_top_element</a>(top_elem))</td></tr> +<tr class="separator:a79c20e305865805bbe3e21adc8da9e72"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac48c5c1b1a6288d82d88bad6aa306d56"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#ac48c5c1b1a6288d82d88bad6aa306d56">DEFAULT_MAX_MESSAGE_LENGTH</a>   (100 * 1024 * 1024)</td></tr> +<tr class="separator:ac48c5c1b1a6288d82d88bad6aa306d56"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a52a88ba75481c926895932b8b05951c2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structregistered__call.html">registered_call</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a52a88ba75481c926895932b8b05951c2">registered_call</a></td></tr> +<tr class="separator:a52a88ba75481c926895932b8b05951c2"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a32e56f0a0ab55d90624b92cbbf7bd384"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a32e56f0a0ab55d90624b92cbbf7bd384">grpc_channel_create_from_filters</a> (const char *target, const <a class="el" href="structgrpc__channel__filter.html">grpc_channel_filter</a> **filters, size_t num_filters, const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *args, <a class="el" href="structgrpc__mdctx.html">grpc_mdctx</a> *mdctx, int is_client)</td></tr> +<tr class="separator:a32e56f0a0ab55d90624b92cbbf7bd384"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a108ef86bc0e5ebcb05f744315e2a6499"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a108ef86bc0e5ebcb05f744315e2a6499">grpc_channel_get_target</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="memdesc:a108ef86bc0e5ebcb05f744315e2a6499"><td class="mdescLeft"> </td><td class="mdescRight">Return a newly allocated string representing the target a channel was created for. <a href="#a108ef86bc0e5ebcb05f744315e2a6499">More...</a><br/></td></tr> +<tr class="separator:a108ef86bc0e5ebcb05f744315e2a6499"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa6b80c5019007f758b1bf414e323db05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__call.html">grpc_call</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#aa6b80c5019007f758b1bf414e323db05">grpc_channel_create_call</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel, <a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cq, const char *method, const char *host, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> deadline)</td></tr> +<tr class="memdesc:aa6b80c5019007f758b1bf414e323db05"><td class="mdescLeft"> </td><td class="mdescRight">Create a call given a <a class="el" href="structgrpc__channel.html">grpc_channel</a>, in order to call 'method'. <a href="#aa6b80c5019007f758b1bf414e323db05">More...</a><br/></td></tr> +<tr class="separator:aa6b80c5019007f758b1bf414e323db05"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af00855f27d8b7c6b232982446371c04d"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#af00855f27d8b7c6b232982446371c04d">grpc_channel_register_call</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel, const char *method, const char *host)</td></tr> +<tr class="memdesc:af00855f27d8b7c6b232982446371c04d"><td class="mdescLeft"> </td><td class="mdescRight">Pre-register a method/host pair on a channel. <a href="#af00855f27d8b7c6b232982446371c04d">More...</a><br/></td></tr> +<tr class="separator:af00855f27d8b7c6b232982446371c04d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a38aa45cdbc3d9a9529bcb6ee8b2c68aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__call.html">grpc_call</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a38aa45cdbc3d9a9529bcb6ee8b2c68aa">grpc_channel_create_registered_call</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel, <a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *completion_queue, void *registered_call_handle, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> deadline)</td></tr> +<tr class="memdesc:a38aa45cdbc3d9a9529bcb6ee8b2c68aa"><td class="mdescLeft"> </td><td class="mdescRight">Create a call given a handle returned from grpc_channel_register_call. <a href="#a38aa45cdbc3d9a9529bcb6ee8b2c68aa">More...</a><br/></td></tr> +<tr class="separator:a38aa45cdbc3d9a9529bcb6ee8b2c68aa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7e9137c2c6f7cc3c1cdc27fbc5f23b41"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a7e9137c2c6f7cc3c1cdc27fbc5f23b41">grpc_channel_internal_ref</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *c)</td></tr> +<tr class="separator:a7e9137c2c6f7cc3c1cdc27fbc5f23b41"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7fe6e3f3337487d8b584cb8d51bdfa6b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a7fe6e3f3337487d8b584cb8d51bdfa6b">grpc_channel_internal_unref</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="separator:a7fe6e3f3337487d8b584cb8d51bdfa6b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a16e4b95581ad12e8e0af2af8d41b71b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a16e4b95581ad12e8e0af2af8d41b71b3">grpc_channel_destroy</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="memdesc:a16e4b95581ad12e8e0af2af8d41b71b3"><td class="mdescLeft"> </td><td class="mdescRight">Close and destroy a grpc channel. <a href="#a16e4b95581ad12e8e0af2af8d41b71b3">More...</a><br/></td></tr> +<tr class="separator:a16e4b95581ad12e8e0af2af8d41b71b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a264b543c86559165c42b1c41cb4c9045"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__stack.html">grpc_channel_stack</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a264b543c86559165c42b1c41cb4c9045">grpc_channel_get_channel_stack</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="memdesc:a264b543c86559165c42b1c41cb4c9045"><td class="mdescLeft"> </td><td class="mdescRight">Get a (borrowed) pointer to this channels underlying channel stack. <a href="#a264b543c86559165c42b1c41cb4c9045">More...</a><br/></td></tr> +<tr class="separator:a264b543c86559165c42b1c41cb4c9045"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6b9ee58f86b3e3026767b37bbc3efa80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__mdctx.html">grpc_mdctx</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a6b9ee58f86b3e3026767b37bbc3efa80">grpc_channel_get_metadata_context</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="memdesc:a6b9ee58f86b3e3026767b37bbc3efa80"><td class="mdescLeft"> </td><td class="mdescRight">Get a (borrowed) pointer to the channel wide metadata context. <a href="#a6b9ee58f86b3e3026767b37bbc3efa80">More...</a><br/></td></tr> +<tr class="separator:a6b9ee58f86b3e3026767b37bbc3efa80"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2192de2d31a54523311ce241f933e048"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__mdstr.html">grpc_mdstr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a2192de2d31a54523311ce241f933e048">grpc_channel_get_status_string</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="separator:a2192de2d31a54523311ce241f933e048"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aee69f0f30f9cdcdd3961b1d253fa29af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__mdstr.html">grpc_mdstr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#aee69f0f30f9cdcdd3961b1d253fa29af">grpc_channel_get_compression_algorithm_string</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="separator:aee69f0f30f9cdcdd3961b1d253fa29af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a49c14becac82008119b5e9fd9d554983"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__mdelem.html">grpc_mdelem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a49c14becac82008119b5e9fd9d554983">grpc_channel_get_reffed_status_elem</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel, int i)</td></tr> +<tr class="memdesc:a49c14becac82008119b5e9fd9d554983"><td class="mdescLeft"> </td><td class="mdescRight">Get a <a class="el" href="structgrpc__mdelem.html">grpc_mdelem</a> of grpc-status: X where X is the numeric value of status_code. <a href="#a49c14becac82008119b5e9fd9d554983">More...</a><br/></td></tr> +<tr class="separator:a49c14becac82008119b5e9fd9d554983"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3008e3086b47f6170180c32ef88c83db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__mdstr.html">grpc_mdstr</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a3008e3086b47f6170180c32ef88c83db">grpc_channel_get_message_string</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="separator:a3008e3086b47f6170180c32ef88c83db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1f91159c2a0d259aa7f854ba4204cafd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8c.html#a1f91159c2a0d259aa7f854ba4204cafd">grpc_channel_get_max_message_length</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel)</td></tr> +<tr class="separator:a1f91159c2a0d259aa7f854ba4204cafd"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="ae9cf519e646bc07f4b32920f39fba049"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define CHANNEL_FROM_CHANNEL_STACK</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">channel_stack</td><td>)</td> + <td>   (((<a class="el" href="structgrpc__channel.html">grpc_channel</a> *)(channel_stack)) - 1)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a79c20e305865805bbe3e21adc8da9e72"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define CHANNEL_FROM_TOP_ELEM</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">top_elem</td><td>)</td> + <td>   <a class="el" href="channel_8c.html#ae9cf519e646bc07f4b32920f39fba049">CHANNEL_FROM_CHANNEL_STACK</a>(<a class="el" href="channel__stack_8c.html#a5fd8b3503ac2f8193509e2ce02ef9406">grpc_channel_stack_from_top_element</a>(top_elem))</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a66dde7aaec84b22bf4ddfa999a2201ed"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define CHANNEL_STACK_FROM_CHANNEL</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">c</td><td>)</td> + <td>   ((<a class="el" href="structgrpc__channel__stack.html">grpc_channel_stack</a> *)((c) + 1))</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ac48c5c1b1a6288d82d88bad6aa306d56"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define DEFAULT_MAX_MESSAGE_LENGTH   (100 * 1024 * 1024)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a30ddfda40b473a077ff7c70a7687ddb1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define NUM_CACHED_STATUS_ELEMS   3</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Cache grpc-status: X mdelems for X = 0..NUM_CACHED_STATUS_ELEMS. </p> +<p>Avoids needing to take a metadata context lock for sending status if the status code is <= NUM_CACHED_STATUS_ELEMS. Sized to allow the most commonly used codes to fit in (OK, Cancelled, Unknown). </p> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="a52a88ba75481c926895932b8b05951c2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="structregistered__call.html">registered_call</a> <a class="el" href="structregistered__call.html">registered_call</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="aa6b80c5019007f758b1bf414e323db05"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__call.html">grpc_call</a>* grpc_channel_create_call </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> * </td> + <td class="paramname"><em>completion_queue</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>method</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>host</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a> </td> + <td class="paramname"><em>deadline</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a call given a <a class="el" href="structgrpc__channel.html">grpc_channel</a>, in order to call 'method'. </p> +<p>All completions are sent to 'completion_queue'. 'method' and 'host' need only live through the invocation of this function. </p> + +</div> +</div> +<a class="anchor" id="a32e56f0a0ab55d90624b92cbbf7bd384"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__channel.html">grpc_channel</a>* grpc_channel_create_from_filters </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>target</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structgrpc__channel__filter.html">grpc_channel_filter</a> ** </td> + <td class="paramname"><em>filters</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>num_filters</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> * </td> + <td class="paramname"><em>args</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structgrpc__mdctx.html">grpc_mdctx</a> * </td> + <td class="paramname"><em>mdctx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>is_client</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a38aa45cdbc3d9a9529bcb6ee8b2c68aa"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__call.html">grpc_call</a>* grpc_channel_create_registered_call </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> * </td> + <td class="paramname"><em>completion_queue</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>registered_call_handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a> </td> + <td class="paramname"><em>deadline</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a call given a handle returned from grpc_channel_register_call. </p> + +</div> +</div> +<a class="anchor" id="a16e4b95581ad12e8e0af2af8d41b71b3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void grpc_channel_destroy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Close and destroy a grpc channel. </p> + +</div> +</div> +<a class="anchor" id="a264b543c86559165c42b1c41cb4c9045"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__channel__stack.html">grpc_channel_stack</a>* grpc_channel_get_channel_stack </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get a (borrowed) pointer to this channels underlying channel stack. </p> + +</div> +</div> +<a class="anchor" id="aee69f0f30f9cdcdd3961b1d253fa29af"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__mdstr.html">grpc_mdstr</a>* grpc_channel_get_compression_algorithm_string </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a1f91159c2a0d259aa7f854ba4204cafd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a> grpc_channel_get_max_message_length </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a3008e3086b47f6170180c32ef88c83db"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__mdstr.html">grpc_mdstr</a>* grpc_channel_get_message_string </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a6b9ee58f86b3e3026767b37bbc3efa80"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__mdctx.html">grpc_mdctx</a>* grpc_channel_get_metadata_context </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get a (borrowed) pointer to the channel wide metadata context. </p> + +</div> +</div> +<a class="anchor" id="a49c14becac82008119b5e9fd9d554983"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__mdelem.html">grpc_mdelem</a>* grpc_channel_get_reffed_status_elem </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>status_code</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get a <a class="el" href="structgrpc__mdelem.html">grpc_mdelem</a> of grpc-status: X where X is the numeric value of status_code. </p> +<p>The returned elem is owned by the caller. </p> + +</div> +</div> +<a class="anchor" id="a2192de2d31a54523311ce241f933e048"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgrpc__mdstr.html">grpc_mdstr</a>* grpc_channel_get_status_string </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a108ef86bc0e5ebcb05f744315e2a6499"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* grpc_channel_get_target </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return a newly allocated string representing the target a channel was created for. </p> + +</div> +</div> +<a class="anchor" id="a7e9137c2c6f7cc3c1cdc27fbc5f23b41"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void grpc_channel_internal_ref </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>c</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a7fe6e3f3337487d8b584cb8d51bdfa6b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void grpc_channel_internal_unref </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="af00855f27d8b7c6b232982446371c04d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* grpc_channel_register_call </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> * </td> + <td class="paramname"><em>channel</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>method</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>host</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Pre-register a method/host pair on a channel. </p> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Wed Aug 5 2015 08:17:07 for GRPC Core by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |