diff options
Diffstat (limited to 'doc/ref/core.internal/html/lb__policy_8c.html')
| -rw-r--r-- | doc/ref/core.internal/html/lb__policy_8c.html | 343 |
1 files changed, 0 insertions, 343 deletions
diff --git a/doc/ref/core.internal/html/lb__policy_8c.html b/doc/ref/core.internal/html/lb__policy_8c.html deleted file mode 100644 index bb352ed039..0000000000 --- a/doc/ref/core.internal/html/lb__policy_8c.html +++ /dev/null @@ -1,343 +0,0 @@ -<!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/client_config/lb_policy.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.11.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_d6c86f4345f838817939dd561d8a016c.html">client_config</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">lb_policy.c File Reference</div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><code>#include "<a class="el" href="lb__policy_8h_source.html">src/core/client_config/lb_policy.h</a>"</code><br/> -</div><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:aa20fbb7fdf68dadcae6aaba3e227ac50"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#aa20fbb7fdf68dadcae6aaba3e227ac50">grpc_lb_policy_init</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy, const <a class="el" href="structgrpc__lb__policy__vtable.html">grpc_lb_policy_vtable</a> *vtable)</td></tr> -<tr class="memdesc:aa20fbb7fdf68dadcae6aaba3e227ac50"><td class="mdescLeft"> </td><td class="mdescRight">called by concrete implementations to initialize the base struct <a href="#aa20fbb7fdf68dadcae6aaba3e227ac50">More...</a><br/></td></tr> -<tr class="separator:aa20fbb7fdf68dadcae6aaba3e227ac50"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af9780ed236a96c3f57d1965d3395132f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#af9780ed236a96c3f57d1965d3395132f">grpc_lb_policy_ref</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr> -<tr class="separator:af9780ed236a96c3f57d1965d3395132f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aed69acd0dd453033a1e1437920ba8942"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#aed69acd0dd453033a1e1437920ba8942">grpc_lb_policy_unref</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr> -<tr class="separator:aed69acd0dd453033a1e1437920ba8942"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1eb8d912c3d82fa0f444fe9cf4bd6991"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#a1eb8d912c3d82fa0f444fe9cf4bd6991">grpc_lb_policy_shutdown</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr> -<tr class="memdesc:a1eb8d912c3d82fa0f444fe9cf4bd6991"><td class="mdescLeft"> </td><td class="mdescRight">Start shutting down (fail any pending picks) <a href="#a1eb8d912c3d82fa0f444fe9cf4bd6991">More...</a><br/></td></tr> -<tr class="separator:a1eb8d912c3d82fa0f444fe9cf4bd6991"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a31611c6d703434b360e90062a28e5140"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#a31611c6d703434b360e90062a28e5140">grpc_lb_policy_pick</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy, <a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset, <a class="el" href="structgrpc__metadata__batch.html">grpc_metadata_batch</a> *initial_metadata, <a class="el" href="structgrpc__subchannel.html">grpc_subchannel</a> **target, <a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> *on_complete)</td></tr> -<tr class="memdesc:a31611c6d703434b360e90062a28e5140"><td class="mdescLeft"> </td><td class="mdescRight">Given initial metadata in <em>initial_metadata</em>, find an appropriate target for this rpc, and 'return' it by calling <em>on_complete</em> after setting <em>target</em>. <a href="#a31611c6d703434b360e90062a28e5140">More...</a><br/></td></tr> -<tr class="separator:a31611c6d703434b360e90062a28e5140"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1d03d2f71dda12c97863cf387559e47a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#a1d03d2f71dda12c97863cf387559e47a">grpc_lb_policy_broadcast</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy, <a class="el" href="structgrpc__transport__op.html">grpc_transport_op</a> *op)</td></tr> -<tr class="separator:a1d03d2f71dda12c97863cf387559e47a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a163a863a51690daa93984d7b7bd0ac88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#a163a863a51690daa93984d7b7bd0ac88">grpc_lb_policy_exit_idle</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr> -<tr class="separator:a163a863a51690daa93984d7b7bd0ac88"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a246a7f5b971f672fa6a8dba8d7264790"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#a246a7f5b971f672fa6a8dba8d7264790">grpc_lb_policy_notify_on_state_change</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy, <a class="el" href="grpc_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> *state, <a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> *closure)</td></tr> -<tr class="separator:a246a7f5b971f672fa6a8dba8d7264790"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a115550f997d572ed49c8906c2cb347b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lb__policy_8c.html#a115550f997d572ed49c8906c2cb347b8">grpc_lb_policy_check_connectivity</a> (<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr> -<tr class="separator:a115550f997d572ed49c8906c2cb347b8"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="a1d03d2f71dda12c97863cf387559e47a"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_broadcast </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="structgrpc__transport__op.html">grpc_transport_op</a> * </td> - <td class="paramname"><em>op</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="a115550f997d572ed49c8906c2cb347b8"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="grpc_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> grpc_lb_policy_check_connectivity </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="a163a863a51690daa93984d7b7bd0ac88"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_exit_idle </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="aa20fbb7fdf68dadcae6aaba3e227ac50"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_init </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const <a class="el" href="structgrpc__lb__policy__vtable.html">grpc_lb_policy_vtable</a> * </td> - <td class="paramname"><em>vtable</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>called by concrete implementations to initialize the base struct </p> - -</div> -</div> -<a class="anchor" id="a246a7f5b971f672fa6a8dba8d7264790"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_notify_on_state_change </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="grpc_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> * </td> - <td class="paramname"><em>state</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> * </td> - <td class="paramname"><em>closure</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="a31611c6d703434b360e90062a28e5140"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_pick </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> * </td> - <td class="paramname"><em>pollset</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="structgrpc__metadata__batch.html">grpc_metadata_batch</a> * </td> - <td class="paramname"><em>initial_metadata</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="structgrpc__subchannel.html">grpc_subchannel</a> ** </td> - <td class="paramname"><em>target</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> * </td> - <td class="paramname"><em>on_complete</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Given initial metadata in <em>initial_metadata</em>, find an appropriate target for this rpc, and 'return' it by calling <em>on_complete</em> after setting <em>target</em>. </p> -<p>Picking can be asynchronous. Any IO should be done under <em>pollset</em>. </p> - -</div> -</div> -<a class="anchor" id="af9780ed236a96c3f57d1965d3395132f"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_ref </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<a class="anchor" id="a1eb8d912c3d82fa0f444fe9cf4bd6991"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_shutdown </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Start shutting down (fail any pending picks) </p> - -</div> -</div> -<a class="anchor" id="aed69acd0dd453033a1e1437920ba8942"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void grpc_lb_policy_unref </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> * </td> - <td class="paramname"><em>policy</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -</div><!-- contents --> -<!-- start footer part --> -<hr class="footer"/><address class="footer"><small> -Generated on Thu Sep 3 2015 09:44:13 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> |