blob: e1adc31921b0b993073a33d74c569ca18ceb31a1 [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: src/core/transport/chttp2/frame.h 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_79268b13b30141157b35932967b4e740.html">transport</a></li><li class="navelem"><a class="el" href="dir_bf8522d75c0d0c872d1b1e399b1737b8.html">chttp2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">frame.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="slice_8h_source.html">grpc/support/slice.h</a>&gt;</code><br/>
</div>
<p><a href="frame_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:af475a6ee5b3fc2b9c8b835d927521bee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#af475a6ee5b3fc2b9c8b835d927521bee">GRPC_CHTTP2_FRAME_DATA</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:af475a6ee5b3fc2b9c8b835d927521bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab82e94b9ff60e4ef29301db9b4022805"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#ab82e94b9ff60e4ef29301db9b4022805">GRPC_CHTTP2_FRAME_HEADER</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ab82e94b9ff60e4ef29301db9b4022805"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8ffe7f9a02584c5eed5876f6d8e497b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#ae8ffe7f9a02584c5eed5876f6d8e497b">GRPC_CHTTP2_FRAME_CONTINUATION</a>&#160;&#160;&#160;9</td></tr>
<tr class="separator:ae8ffe7f9a02584c5eed5876f6d8e497b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e6ad3bb0bc03b02cd2791f34014c933"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a0e6ad3bb0bc03b02cd2791f34014c933">GRPC_CHTTP2_FRAME_RST_STREAM</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:a0e6ad3bb0bc03b02cd2791f34014c933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa030a067f1b4cbb8d34c28fbb43e8046"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#aa030a067f1b4cbb8d34c28fbb43e8046">GRPC_CHTTP2_FRAME_SETTINGS</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:aa030a067f1b4cbb8d34c28fbb43e8046"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a92c84ae932e1b9a79af8f099516ece"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a9a92c84ae932e1b9a79af8f099516ece">GRPC_CHTTP2_FRAME_PING</a>&#160;&#160;&#160;6</td></tr>
<tr class="separator:a9a92c84ae932e1b9a79af8f099516ece"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a624f289bc52602a8c3340ad747075130"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a624f289bc52602a8c3340ad747075130">GRPC_CHTTP2_FRAME_GOAWAY</a>&#160;&#160;&#160;7</td></tr>
<tr class="separator:a624f289bc52602a8c3340ad747075130"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9af6484a80a10f0213465fa5dc14031"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#ac9af6484a80a10f0213465fa5dc14031">GRPC_CHTTP2_FRAME_WINDOW_UPDATE</a>&#160;&#160;&#160;8</td></tr>
<tr class="separator:ac9af6484a80a10f0213465fa5dc14031"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a461cf678ffd9272c8a10f133c058124e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a461cf678ffd9272c8a10f133c058124e">GRPC_CHTTP2_MAX_PAYLOAD_LENGTH</a>&#160;&#160;&#160;((1 &lt;&lt; 14) - 1)</td></tr>
<tr class="separator:a461cf678ffd9272c8a10f133c058124e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebe712016c70bba5c7fc0cbc7f372681"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#aebe712016c70bba5c7fc0cbc7f372681">GRPC_CHTTP2_DATA_FLAG_END_STREAM</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:aebe712016c70bba5c7fc0cbc7f372681"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae399b812927e4ccfa1836814e719bec6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#ae399b812927e4ccfa1836814e719bec6">GRPC_CHTTP2_FLAG_ACK</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ae399b812927e4ccfa1836814e719bec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e28337a838f07e06987f344a01f7f0f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a9e28337a838f07e06987f344a01f7f0f">GRPC_CHTTP2_DATA_FLAG_END_HEADERS</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:a9e28337a838f07e06987f344a01f7f0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab01d61cf6f1abddae8031ebcf6e34e09"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#ab01d61cf6f1abddae8031ebcf6e34e09">GRPC_CHTTP2_DATA_FLAG_PADDED</a>&#160;&#160;&#160;8</td></tr>
<tr class="separator:ab01d61cf6f1abddae8031ebcf6e34e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fbbbbd20f7217de2249fb8597b48c36"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a8fbbbbd20f7217de2249fb8597b48c36">GRPC_CHTTP2_FLAG_HAS_PRIORITY</a>&#160;&#160;&#160;0x20</td></tr>
<tr class="separator:a8fbbbbd20f7217de2249fb8597b48c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a67486ee57e3d27c619df98c80420f421"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structgrpc__chttp2__stream__parsing.html">grpc_chttp2_stream_parsing</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a67486ee57e3d27c619df98c80420f421">grpc_chttp2_stream_parsing</a></td></tr>
<tr class="separator:a67486ee57e3d27c619df98c80420f421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a736ee44646a381e8119085a7803c20bc"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structgrpc__chttp2__transport__parsing.html">grpc_chttp2_transport_parsing</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#a736ee44646a381e8119085a7803c20bc">grpc_chttp2_transport_parsing</a></td></tr>
<tr class="separator:a736ee44646a381e8119085a7803c20bc"><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:ada474db64756bd411eeeaf3de4318e35"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frame_8h.html#ada474db64756bd411eeeaf3de4318e35">grpc_chttp2_parse_error</a> { <a class="el" href="frame_8h.html#ada474db64756bd411eeeaf3de4318e35af86b67f5595348d506db6719011a2931">GRPC_CHTTP2_PARSE_OK</a>,
<a class="el" href="frame_8h.html#ada474db64756bd411eeeaf3de4318e35a785a08cbae32b1550c8b96da011fe9a4">GRPC_CHTTP2_STREAM_ERROR</a>,
<a class="el" href="frame_8h.html#ada474db64756bd411eeeaf3de4318e35a0bff666112f9afb13b93c48ed70c99c4">GRPC_CHTTP2_CONNECTION_ERROR</a>
}</td></tr>
<tr class="separator:ada474db64756bd411eeeaf3de4318e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a9e28337a838f07e06987f344a01f7f0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_DATA_FLAG_END_HEADERS&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aebe712016c70bba5c7fc0cbc7f372681"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_DATA_FLAG_END_STREAM&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab01d61cf6f1abddae8031ebcf6e34e09"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_DATA_FLAG_PADDED&#160;&#160;&#160;8</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae399b812927e4ccfa1836814e719bec6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FLAG_ACK&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8fbbbbd20f7217de2249fb8597b48c36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FLAG_HAS_PRIORITY&#160;&#160;&#160;0x20</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae8ffe7f9a02584c5eed5876f6d8e497b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_CONTINUATION&#160;&#160;&#160;9</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af475a6ee5b3fc2b9c8b835d927521bee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_DATA&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a624f289bc52602a8c3340ad747075130"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_GOAWAY&#160;&#160;&#160;7</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab82e94b9ff60e4ef29301db9b4022805"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_HEADER&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9a92c84ae932e1b9a79af8f099516ece"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_PING&#160;&#160;&#160;6</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0e6ad3bb0bc03b02cd2791f34014c933"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_RST_STREAM&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa030a067f1b4cbb8d34c28fbb43e8046"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_SETTINGS&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac9af6484a80a10f0213465fa5dc14031"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_FRAME_WINDOW_UPDATE&#160;&#160;&#160;8</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a461cf678ffd9272c8a10f133c058124e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_MAX_PAYLOAD_LENGTH&#160;&#160;&#160;((1 &lt;&lt; 14) - 1)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a67486ee57e3d27c619df98c80420f421"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__chttp2__stream__parsing.html">grpc_chttp2_stream_parsing</a> <a class="el" href="structgrpc__chttp2__stream__parsing.html">grpc_chttp2_stream_parsing</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a736ee44646a381e8119085a7803c20bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__chttp2__transport__parsing.html">grpc_chttp2_transport_parsing</a> <a class="el" href="structgrpc__chttp2__transport__parsing.html">grpc_chttp2_transport_parsing</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ada474db64756bd411eeeaf3de4318e35"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="frame_8h.html#ada474db64756bd411eeeaf3de4318e35">grpc_chttp2_parse_error</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="ada474db64756bd411eeeaf3de4318e35af86b67f5595348d506db6719011a2931"></a>GRPC_CHTTP2_PARSE_OK</em>&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ada474db64756bd411eeeaf3de4318e35a785a08cbae32b1550c8b96da011fe9a4"></a>GRPC_CHTTP2_STREAM_ERROR</em>&#160;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ada474db64756bd411eeeaf3de4318e35a0bff666112f9afb13b93c48ed70c99c4"></a>GRPC_CHTTP2_CONNECTION_ERROR</em>&#160;</td><td class="fielddoc">
</td></tr>
</table>
</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>