blob: d838ab49db312c6f2ae125335658b3553e83f580 [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: pick_first_lb_policy 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">pick_first_lb_policy Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a3e8f7088400929001aa4b589a3f79f79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a3e8f7088400929001aa4b589a3f79f79">base</a></td></tr>
<tr class="memdesc:a3e8f7088400929001aa4b589a3f79f79"><td class="mdescLeft">&#160;</td><td class="mdescRight">base policy: must be first <a href="#a3e8f7088400929001aa4b589a3f79f79">More...</a><br/></td></tr>
<tr class="separator:a3e8f7088400929001aa4b589a3f79f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a359affbda6360c97745389a1c036afbf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__subchannel.html">grpc_subchannel</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a359affbda6360c97745389a1c036afbf">subchannels</a></td></tr>
<tr class="memdesc:a359affbda6360c97745389a1c036afbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">all our subchannels <a href="#a359affbda6360c97745389a1c036afbf">More...</a><br/></td></tr>
<tr class="separator:a359affbda6360c97745389a1c036afbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39415d22c1bb4ace43e7abc6331f08e1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a39415d22c1bb4ace43e7abc6331f08e1">num_subchannels</a></td></tr>
<tr class="separator:a39415d22c1bb4ace43e7abc6331f08e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54f466dc5e968d2b3a8f8fe6511d2c56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a54f466dc5e968d2b3a8f8fe6511d2c56">connectivity_changed</a></td></tr>
<tr class="separator:a54f466dc5e968d2b3a8f8fe6511d2c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bc2719af90ffde998983bdeeacfd764"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__mu.html">gpr_mu</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a5bc2719af90ffde998983bdeeacfd764">mu</a></td></tr>
<tr class="memdesc:a5bc2719af90ffde998983bdeeacfd764"><td class="mdescLeft">&#160;</td><td class="mdescRight">mutex protecting remaining members <a href="#a5bc2719af90ffde998983bdeeacfd764">More...</a><br/></td></tr>
<tr class="separator:a5bc2719af90ffde998983bdeeacfd764"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4fd8d1ef626d9c42f631317921634ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__subchannel.html">grpc_subchannel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#ad4fd8d1ef626d9c42f631317921634ef">selected</a></td></tr>
<tr class="memdesc:ad4fd8d1ef626d9c42f631317921634ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">the selected channel TODO(ctiller): this should be atomically set so we don't need to take a mutex in the common case <a href="#ad4fd8d1ef626d9c42f631317921634ef">More...</a><br/></td></tr>
<tr class="separator:ad4fd8d1ef626d9c42f631317921634ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eff3397ca43852b04a3be5b5e03a6ce"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a8eff3397ca43852b04a3be5b5e03a6ce">started_picking</a></td></tr>
<tr class="memdesc:a8eff3397ca43852b04a3be5b5e03a6ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">have we started picking? <a href="#a8eff3397ca43852b04a3be5b5e03a6ce">More...</a><br/></td></tr>
<tr class="separator:a8eff3397ca43852b04a3be5b5e03a6ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2818821a8daa60e92637357811aea7d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a2818821a8daa60e92637357811aea7d4">shutdown</a></td></tr>
<tr class="memdesc:a2818821a8daa60e92637357811aea7d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">are we shut down? <a href="#a2818821a8daa60e92637357811aea7d4">More...</a><br/></td></tr>
<tr class="separator:a2818821a8daa60e92637357811aea7d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71958e25ab870a0f4436c07fed4585da"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a71958e25ab870a0f4436c07fed4585da">checking_subchannel</a></td></tr>
<tr class="memdesc:a71958e25ab870a0f4436c07fed4585da"><td class="mdescLeft">&#160;</td><td class="mdescRight">which subchannel are we watching? <a href="#a71958e25ab870a0f4436c07fed4585da">More...</a><br/></td></tr>
<tr class="separator:a71958e25ab870a0f4436c07fed4585da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27c07323206631d5b7b021bfc2fb13d8"><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="structpick__first__lb__policy.html#a27c07323206631d5b7b021bfc2fb13d8">checking_connectivity</a></td></tr>
<tr class="memdesc:a27c07323206631d5b7b021bfc2fb13d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">what is the connectivity of that channel? <a href="#a27c07323206631d5b7b021bfc2fb13d8">More...</a><br/></td></tr>
<tr class="separator:a27c07323206631d5b7b021bfc2fb13d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a017af289ea4d9b9b392eadec3356ff56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpending__pick.html">pending_pick</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a017af289ea4d9b9b392eadec3356ff56">pending_picks</a></td></tr>
<tr class="memdesc:a017af289ea4d9b9b392eadec3356ff56"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of picks that are waiting on connectivity <a href="#a017af289ea4d9b9b392eadec3356ff56">More...</a><br/></td></tr>
<tr class="separator:a017af289ea4d9b9b392eadec3356ff56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b686da7cdddd0893e3d36c213bd274a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__connectivity__state__tracker.html">grpc_connectivity_state_tracker</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpick__first__lb__policy.html#a4b686da7cdddd0893e3d36c213bd274a">state_tracker</a></td></tr>
<tr class="memdesc:a4b686da7cdddd0893e3d36c213bd274a"><td class="mdescLeft">&#160;</td><td class="mdescRight">our connectivity state tracker <a href="#a4b686da7cdddd0893e3d36c213bd274a">More...</a><br/></td></tr>
<tr class="separator:a4b686da7cdddd0893e3d36c213bd274a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a3e8f7088400929001aa4b589a3f79f79"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__lb__policy.html">grpc_lb_policy</a> pick_first_lb_policy::base</td>
</tr>
</table>
</div><div class="memdoc">
<p>base policy: must be first </p>
</div>
</div>
<a class="anchor" id="a27c07323206631d5b7b021bfc2fb13d8"></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> pick_first_lb_policy::checking_connectivity</td>
</tr>
</table>
</div><div class="memdoc">
<p>what is the connectivity of that channel? </p>
</div>
</div>
<a class="anchor" id="a71958e25ab870a0f4436c07fed4585da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pick_first_lb_policy::checking_subchannel</td>
</tr>
</table>
</div><div class="memdoc">
<p>which subchannel are we watching? </p>
</div>
</div>
<a class="anchor" id="a54f466dc5e968d2b3a8f8fe6511d2c56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> pick_first_lb_policy::connectivity_changed</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5bc2719af90ffde998983bdeeacfd764"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgpr__mu.html">gpr_mu</a> pick_first_lb_policy::mu</td>
</tr>
</table>
</div><div class="memdoc">
<p>mutex protecting remaining members </p>
</div>
</div>
<a class="anchor" id="a39415d22c1bb4ace43e7abc6331f08e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pick_first_lb_policy::num_subchannels</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a017af289ea4d9b9b392eadec3356ff56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpending__pick.html">pending_pick</a>* pick_first_lb_policy::pending_picks</td>
</tr>
</table>
</div><div class="memdoc">
<p>list of picks that are waiting on connectivity </p>
</div>
</div>
<a class="anchor" id="ad4fd8d1ef626d9c42f631317921634ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__subchannel.html">grpc_subchannel</a>* pick_first_lb_policy::selected</td>
</tr>
</table>
</div><div class="memdoc">
<p>the selected channel TODO(ctiller): this should be atomically set so we don't need to take a mutex in the common case </p>
</div>
</div>
<a class="anchor" id="a2818821a8daa60e92637357811aea7d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pick_first_lb_policy::shutdown</td>
</tr>
</table>
</div><div class="memdoc">
<p>are we shut down? </p>
</div>
</div>
<a class="anchor" id="a8eff3397ca43852b04a3be5b5e03a6ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pick_first_lb_policy::started_picking</td>
</tr>
</table>
</div><div class="memdoc">
<p>have we started picking? </p>
</div>
</div>
<a class="anchor" id="a4b686da7cdddd0893e3d36c213bd274a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__connectivity__state__tracker.html">grpc_connectivity_state_tracker</a> pick_first_lb_policy::state_tracker</td>
</tr>
</table>
</div><div class="memdoc">
<p>our connectivity state tracker </p>
</div>
</div>
<a class="anchor" id="a359affbda6360c97745389a1c036afbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__subchannel.html">grpc_subchannel</a>** pick_first_lb_policy::subchannels</td>
</tr>
</table>
</div><div class="memdoc">
<p>all our subchannels </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/core/client_config/lb_policies/<a class="el" href="pick__first_8c.html">pick_first.c</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>