Initial Doxygen import for core, c++

author: Craig Tiller <ctiller@google.com> 2015-08-05 08:18:21 -0700
committer: Craig Tiller <ctiller@google.com> 2015-08-05 08:18:21 -0700
commit: 68f4e0f6abc6bb99ff334542d5b5003edc3e651e (patch)
tree: 320e1f4aa189f06af9dbccce9f709c9c36c3bb6c /doc/ref/core.internal/html/channel__connectivity_8c.html
parent: 3bbacf1b5ece50a8f9a945c88e2f81d3f8594e47 (diff)
1 files changed, 232 insertions, 0 deletions
diff --git a/doc/ref/core.internal/html/channel__connectivity_8c.html b/doc/ref/core.internal/html/channel__connectivity_8c.html
new file mode 100644
index 0000000000..d80b0b00eb
--- /dev/null
+++ b/doc/ref/core.internal/html/channel__connectivity_8c.html
@@ -0,0 +1,232 @@
+<!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_connectivity.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
+   &#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><a href="annotated.html"><span>Data&#160;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&#160;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">&#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 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> &#124;
+<a href="#enum-members">Enumerations</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">channel_connectivity.c File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &quot;<a class="el" href="channel_8h_source.html">src/core/surface/channel.h</a>&quot;</code><br/>
+<code>#include &lt;<a class="el" href="alloc_8h_source.html">grpc/support/alloc.h</a>&gt;</code><br/>
+<code>#include &lt;<a class="el" href="log_8h_source.html">grpc/support/log.h</a>&gt;</code><br/>
+<code>#include &quot;<a class="el" href="client__channel_8h_source.html">src/core/channel/client_channel.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="alarm_8h_source.html">src/core/iomgr/alarm.h</a>&quot;</code><br/>
+<code>#include &quot;<a class="el" href="completion__queue_8h_source.html">src/core/surface/completion_queue.h</a>&quot;</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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstate__watcher.html">state_watcher</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
+Enumerations</h2></td></tr>
+<tr class="memitem:a71937a2ee2a4befe88e84d4966f8845c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__connectivity_8c.html#a71937a2ee2a4befe88e84d4966f8845c">callback_phase</a> { <a class="el" href="channel__connectivity_8c.html#a71937a2ee2a4befe88e84d4966f8845ca757971c0bc5a1972d5f1b1be2c0e2087">WAITING</a>, 
+<a class="el" href="channel__connectivity_8c.html#a71937a2ee2a4befe88e84d4966f8845cab5a94c295540046002de0f889519c275">CALLING_BACK</a>, 
+<a class="el" href="channel__connectivity_8c.html#a71937a2ee2a4befe88e84d4966f8845ca4ed55db80fc1cf98cb8fc633fd59d68d">CALLING_BACK_AND_FINISHED</a>, 
+<a class="el" href="channel__connectivity_8c.html#a71937a2ee2a4befe88e84d4966f8845ca7cf5434be93040e9946cc788465d3b3a">CALLED_BACK</a>
+ }</td></tr>
+<tr class="separator:a71937a2ee2a4befe88e84d4966f8845c"><td class="memSeparator" colspan="2">&#160;</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:a9623d8e4df1d17eb26b67d905f1d7cb3"><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="channel__connectivity_8c.html#a9623d8e4df1d17eb26b67d905f1d7cb3">grpc_channel_check_connectivity_state</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel, int try_to_connect)</td></tr>
+<tr class="memdesc:a9623d8e4df1d17eb26b67d905f1d7cb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check the connectivity state of a channel.  <a href="#a9623d8e4df1d17eb26b67d905f1d7cb3">More...</a><br/></td></tr>
+<tr class="separator:a9623d8e4df1d17eb26b67d905f1d7cb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a29aa98ca6ce9f7e5116e43b0c414e96b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__connectivity_8c.html#a29aa98ca6ce9f7e5116e43b0c414e96b">grpc_channel_watch_connectivity_state</a> (<a class="el" href="structgrpc__channel.html">grpc_channel</a> *channel, <a class="el" href="grpc_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> last_observed_state, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> deadline, <a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cq, void *tag)</td></tr>
+<tr class="memdesc:a29aa98ca6ce9f7e5116e43b0c414e96b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Watch for a change in connectivity state.  <a href="#a29aa98ca6ce9f7e5116e43b0c414e96b">More...</a><br/></td></tr>
+<tr class="separator:a29aa98ca6ce9f7e5116e43b0c414e96b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Enumeration Type Documentation</h2>
+<a class="anchor" id="a71937a2ee2a4befe88e84d4966f8845c"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="channel__connectivity_8c.html#a71937a2ee2a4befe88e84d4966f8845c">callback_phase</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<table class="fieldtable">
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a71937a2ee2a4befe88e84d4966f8845ca757971c0bc5a1972d5f1b1be2c0e2087"></a>WAITING</em>&#160;</td><td class="fielddoc">
+</td></tr>
+<tr><td class="fieldname"><em><a class="anchor" id="a71937a2ee2a4befe88e84d4966f8845cab5a94c295540046002de0f889519c275"></a>CALLING_BACK</em>&#160;</td><td class="fielddoc">
+</td></tr>
+<tr><td class="fieldname"><em><a class="anchor" id="a71937a2ee2a4befe88e84d4966f8845ca4ed55db80fc1cf98cb8fc633fd59d68d"></a>CALLING_BACK_AND_FINISHED</em>&#160;</td><td class="fielddoc">
+</td></tr>
+<tr><td class="fieldname"><em><a class="anchor" id="a71937a2ee2a4befe88e84d4966f8845ca7cf5434be93040e9946cc788465d3b3a"></a>CALLED_BACK</em>&#160;</td><td class="fielddoc">
+</td></tr>
+</table>
+
+</div>
+</div>
+<h2 class="groupheader">Function Documentation</h2>
+<a class="anchor" id="a9623d8e4df1d17eb26b67d905f1d7cb3"></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_channel_check_connectivity_state </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> *&#160;</td>
+          <td class="paramname"><em>channel</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">int&#160;</td>
+          <td class="paramname"><em>try_to_connect</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Check the connectivity state of a channel. </p>
+
+</div>
+</div>
+<a class="anchor" id="a29aa98ca6ce9f7e5116e43b0c414e96b"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void grpc_channel_watch_connectivity_state </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="structgrpc__channel.html">grpc_channel</a> *&#160;</td>
+          <td class="paramname"><em>channel</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>&#160;</td>
+          <td class="paramname"><em>last_observed_state</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
+          <td class="paramname"><em>deadline</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> *&#160;</td>
+          <td class="paramname"><em>cq</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">void *&#160;</td>
+          <td class="paramname"><em>tag</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Watch for a change in connectivity state. </p>
+<p>Once the channel connectivity state is different from last_observed_state, tag will be enqueued on cq with success=1. If deadline expires BEFORE the state is changed, tag will be enqueued on cq with success=0. </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 &#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>
author	Craig Tiller <ctiller@google.com>	2015-08-05 08:18:21 -0700
committer	Craig Tiller <ctiller@google.com>	2015-08-05 08:18:21 -0700
commit	68f4e0f6abc6bb99ff334542d5b5003edc3e651e (patch)
tree	320e1f4aa189f06af9dbccce9f709c9c36c3bb6c /doc/ref/core.internal/html/channel__connectivity_8c.html
parent	3bbacf1b5ece50a8f9a945c88e2f81d3f8594e47 (diff)