Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc / 68f4e0f6abc6bb99ff334542d5b5003edc3e651e / . / doc / ref / core.internal / html / structgrpc__transport__op.html
blob: 9f10beac66569c4e9ff0934d31124f1c88185032 [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_transport_op 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_transport_op Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Transport op: a set of operations to perform on a transport as a whole.
<a href="structgrpc__transport__op.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="transport_8h_source.html">transport.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:a7a602604dff1707699650659639d3b8a"><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="structgrpc__transport__op.html#a7a602604dff1707699650659639d3b8a">on_consumed</a></td></tr>
<tr class="memdesc:a7a602604dff1707699650659639d3b8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">called when processing of this op is done <a href="#a7a602604dff1707699650659639d3b8a">More...</a><br/></td></tr>
<tr class="separator:a7a602604dff1707699650659639d3b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb87801e77b1728a01f374dcf78bb953"><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="structgrpc__transport__op.html#adb87801e77b1728a01f374dcf78bb953">on_connectivity_state_change</a></td></tr>
<tr class="memdesc:adb87801e77b1728a01f374dcf78bb953"><td class="mdescLeft">&#160;</td><td class="mdescRight">connectivity monitoring <a href="#adb87801e77b1728a01f374dcf78bb953">More...</a><br/></td></tr>
<tr class="separator:adb87801e77b1728a01f374dcf78bb953"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae68e6030500899af6788152a0a567c9d"><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__transport__op.html#ae68e6030500899af6788152a0a567c9d">connectivity_state</a></td></tr>
<tr class="separator:ae68e6030500899af6788152a0a567c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a280ecb11f206deb671cb0d9e8a20434b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#a280ecb11f206deb671cb0d9e8a20434b">disconnect</a></td></tr>
<tr class="memdesc:a280ecb11f206deb671cb0d9e8a20434b"><td class="mdescLeft">&#160;</td><td class="mdescRight">should the transport be disconnected <a href="#a280ecb11f206deb671cb0d9e8a20434b">More...</a><br/></td></tr>
<tr class="separator:a280ecb11f206deb671cb0d9e8a20434b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aceb73c54b2b677eec23a2bb1507c4704"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#aceb73c54b2b677eec23a2bb1507c4704">send_goaway</a></td></tr>
<tr class="memdesc:aceb73c54b2b677eec23a2bb1507c4704"><td class="mdescLeft">&#160;</td><td class="mdescRight">should we send a goaway? after a goaway is sent, once there are no more active calls on the transport, the transport should disconnect <a href="#aceb73c54b2b677eec23a2bb1507c4704">More...</a><br/></td></tr>
<tr class="separator:aceb73c54b2b677eec23a2bb1507c4704"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc4c019576243679b671f5cebd6000f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#a2bc4c019576243679b671f5cebd6000f">goaway_status</a></td></tr>
<tr class="memdesc:a2bc4c019576243679b671f5cebd6000f"><td class="mdescLeft">&#160;</td><td class="mdescRight">what should the goaway contain? <a href="#a2bc4c019576243679b671f5cebd6000f">More...</a><br/></td></tr>
<tr class="separator:a2bc4c019576243679b671f5cebd6000f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4862d8029894b6640d2261694e21293"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__slice.html">gpr_slice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#ad4862d8029894b6640d2261694e21293">goaway_message</a></td></tr>
<tr class="separator:ad4862d8029894b6640d2261694e21293"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc2f197291cd94543ea984eaf8a61f8"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#aabc2f197291cd94543ea984eaf8a61f8">set_accept_stream</a> )(void *user_data, <a class="el" href="structgrpc__transport.html">grpc_transport</a> *transport, const void *server_data)</td></tr>
<tr class="memdesc:aabc2f197291cd94543ea984eaf8a61f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the callback for accepting new streams; this is a permanent callback, unlike the other one-shot closures <a href="#aabc2f197291cd94543ea984eaf8a61f8">More...</a><br/></td></tr>
<tr class="separator:aabc2f197291cd94543ea984eaf8a61f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4591bfe47e9155982ad2d25a7750e17f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#a4591bfe47e9155982ad2d25a7750e17f">set_accept_stream_user_data</a></td></tr>
<tr class="separator:a4591bfe47e9155982ad2d25a7750e17f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaed4d0f2349649d83e662cd69fbe9b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#aeaed4d0f2349649d83e662cd69fbe9b2">bind_pollset</a></td></tr>
<tr class="memdesc:aeaed4d0f2349649d83e662cd69fbe9b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">add this transport to a pollset <a href="#aeaed4d0f2349649d83e662cd69fbe9b2">More...</a><br/></td></tr>
<tr class="separator:aeaed4d0f2349649d83e662cd69fbe9b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ab2143e7e598667e29f3366722c07a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__pollset__set.html">grpc_pollset_set</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__transport__op.html#a4ab2143e7e598667e29f3366722c07a3">bind_pollset_set</a></td></tr>
<tr class="memdesc:a4ab2143e7e598667e29f3366722c07a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">add this transport to a pollset_set <a href="#a4ab2143e7e598667e29f3366722c07a3">More...</a><br/></td></tr>
<tr class="separator:a4ab2143e7e598667e29f3366722c07a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abebcf932a4fa8d14006230dee06e0286"><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="structgrpc__transport__op.html#abebcf932a4fa8d14006230dee06e0286">send_ping</a></td></tr>
<tr class="memdesc:abebcf932a4fa8d14006230dee06e0286"><td class="mdescLeft">&#160;</td><td class="mdescRight">send a ping, call this back if not NULL <a href="#abebcf932a4fa8d14006230dee06e0286">More...</a><br/></td></tr>
<tr class="separator:abebcf932a4fa8d14006230dee06e0286"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Transport op: a set of operations to perform on a transport as a whole. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aeaed4d0f2349649d83e662cd69fbe9b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a>* grpc_transport_op::bind_pollset</td>
</tr>
</table>
</div><div class="memdoc">
<p>add this transport to a pollset </p>
</div>
</div>
<a class="anchor" id="a4ab2143e7e598667e29f3366722c07a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__pollset__set.html">grpc_pollset_set</a>* grpc_transport_op::bind_pollset_set</td>
</tr>
</table>
</div><div class="memdoc">
<p>add this transport to a pollset_set </p>
</div>
</div>
<a class="anchor" id="ae68e6030500899af6788152a0a567c9d"></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_transport_op::connectivity_state</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a280ecb11f206deb671cb0d9e8a20434b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_transport_op::disconnect</td>
</tr>
</table>
</div><div class="memdoc">
<p>should the transport be disconnected </p>
</div>
</div>
<a class="anchor" id="ad4862d8029894b6640d2261694e21293"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgpr__slice.html">gpr_slice</a>* grpc_transport_op::goaway_message</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2bc4c019576243679b671f5cebd6000f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> grpc_transport_op::goaway_status</td>
</tr>
</table>
</div><div class="memdoc">
<p>what should the goaway contain? </p>
</div>
</div>
<a class="anchor" id="adb87801e77b1728a01f374dcf78bb953"></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>* grpc_transport_op::on_connectivity_state_change</td>
</tr>
</table>
</div><div class="memdoc">
<p>connectivity monitoring </p>
</div>
</div>
<a class="anchor" id="a7a602604dff1707699650659639d3b8a"></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>* grpc_transport_op::on_consumed</td>
</tr>
</table>
</div><div class="memdoc">
<p>called when processing of this op is done </p>
</div>
</div>
<a class="anchor" id="aceb73c54b2b677eec23a2bb1507c4704"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_transport_op::send_goaway</td>
</tr>
</table>
</div><div class="memdoc">
<p>should we send a goaway? after a goaway is sent, once there are no more active calls on the transport, the transport should disconnect </p>
</div>
</div>
<a class="anchor" id="abebcf932a4fa8d14006230dee06e0286"></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>* grpc_transport_op::send_ping</td>
</tr>
</table>
</div><div class="memdoc">
<p>send a ping, call this back if not NULL </p>
</div>
</div>
<a class="anchor" id="aabc2f197291cd94543ea984eaf8a61f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* grpc_transport_op::set_accept_stream)(void *user_data, <a class="el" href="structgrpc__transport.html">grpc_transport</a> *transport, const void *server_data)</td>
</tr>
</table>
</div><div class="memdoc">
<p>set the callback for accepting new streams; this is a permanent callback, unlike the other one-shot closures </p>
</div>
</div>
<a class="anchor" id="a4591bfe47e9155982ad2d25a7750e17f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* grpc_transport_op::set_accept_stream_user_data</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/transport/<a class="el" href="transport_8h_source.html">transport.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>