Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc / 68f4e0f6abc6bb99ff334542d5b5003edc3e651e / . / doc / ref / core.internal / html / structgrpc__lb__policy__vtable.html
blob: 9d74dbfacec9fad5b415f1336d18e77fd57f33fb [file] [log] [blame]
<!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: grpc_lb_policy_vtable Struct 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
&#160;<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&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">grpc_lb_policy_vtable Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="lb__policy_8h_source.html">lb_policy.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a239ed7b3beddcfa318cc402f6d9f977c"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#a239ed7b3beddcfa318cc402f6d9f977c">destroy</a> )(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr>
<tr class="separator:a239ed7b3beddcfa318cc402f6d9f977c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51c5b68411493024b3ffde40681c79e6"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#a51c5b68411493024b3ffde40681c79e6">shutdown</a> )(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr>
<tr class="separator:a51c5b68411493024b3ffde40681c79e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abccc94e7f91ee59b360ee425493d9e6f"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#abccc94e7f91ee59b360ee425493d9e6f">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:abccc94e7f91ee59b360ee425493d9e6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">implement grpc_lb_policy_pick <a href="#abccc94e7f91ee59b360ee425493d9e6f">More...</a><br/></td></tr>
<tr class="separator:abccc94e7f91ee59b360ee425493d9e6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49613233281018e00cf8dcd060c9a301"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#a49613233281018e00cf8dcd060c9a301">exit_idle</a> )(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr>
<tr class="memdesc:a49613233281018e00cf8dcd060c9a301"><td class="mdescLeft">&#160;</td><td class="mdescRight">try to enter a READY connectivity state <a href="#a49613233281018e00cf8dcd060c9a301">More...</a><br/></td></tr>
<tr class="separator:a49613233281018e00cf8dcd060c9a301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a12509ba4569fb4c87b4d325e0f89d3"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#a0a12509ba4569fb4c87b4d325e0f89d3">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="memdesc:a0a12509ba4569fb4c87b4d325e0f89d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">broadcast a transport op to all subchannels <a href="#a0a12509ba4569fb4c87b4d325e0f89d3">More...</a><br/></td></tr>
<tr class="separator:a0a12509ba4569fb4c87b4d325e0f89d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1251501a613435c27688a15b1f76e25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#af1251501a613435c27688a15b1f76e25">check_connectivity</a> )(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td></tr>
<tr class="memdesc:af1251501a613435c27688a15b1f76e25"><td class="mdescLeft">&#160;</td><td class="mdescRight">check the current connectivity of the lb_policy <a href="#af1251501a613435c27688a15b1f76e25">More...</a><br/></td></tr>
<tr class="separator:af1251501a613435c27688a15b1f76e25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a655f1dd76748cdfa93f911861c1ec0ed"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__lb__policy__vtable.html#a655f1dd76748cdfa93f911861c1ec0ed">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="memdesc:a655f1dd76748cdfa93f911861c1ec0ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">call notify when the connectivity state of a channel changes from *state. <a href="#a655f1dd76748cdfa93f911861c1ec0ed">More...</a><br/></td></tr>
<tr class="separator:a655f1dd76748cdfa93f911861c1ec0ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a0a12509ba4569fb4c87b4d325e0f89d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_lb_policy_vtable::broadcast)(<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>
</table>
</div><div class="memdoc">
<p>broadcast a transport op to all subchannels </p>
</div>
</div>
<a class="anchor" id="af1251501a613435c27688a15b1f76e25"></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_vtable::check_connectivity)(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td>
</tr>
</table>
</div><div class="memdoc">
<p>check the current connectivity of the lb_policy </p>
</div>
</div>
<a class="anchor" id="a239ed7b3beddcfa318cc402f6d9f977c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_lb_policy_vtable::destroy)(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a49613233281018e00cf8dcd060c9a301"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_lb_policy_vtable::exit_idle)(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td>
</tr>
</table>
</div><div class="memdoc">
<p>try to enter a READY connectivity state </p>
</div>
</div>
<a class="anchor" id="a655f1dd76748cdfa93f911861c1ec0ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_lb_policy_vtable::notify_on_state_change)(<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>
</table>
</div><div class="memdoc">
<p>call notify when the connectivity state of a channel changes from *state. </p>
<p>Updates *state with the new state of the policy </p>
</div>
</div>
<a class="anchor" id="abccc94e7f91ee59b360ee425493d9e6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_lb_policy_vtable::pick)(<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>
</table>
</div><div class="memdoc">
<p>implement grpc_lb_policy_pick </p>
</div>
</div>
<a class="anchor" id="a51c5b68411493024b3ffde40681c79e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_lb_policy_vtable::shutdown)(<a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> *policy)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/core/client_config/<a class="el" href="lb__policy_8h_source.html">lb_policy.h</a></li>
</ul>
</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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>