blob: 86822cb0038556ccc0b1ea9257166f1d2f562749 [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/varint.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">varint.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/>
</div>
<p><a href="varint_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:a13810a2894d0705c3f1b6fd462f567bd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a>(prefix_bits)&#160;&#160;&#160;((1 &lt;&lt; (8 - (prefix_bits))) - 1)</td></tr>
<tr class="separator:a13810a2894d0705c3f1b6fd462f567bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af09078f363c97757f6e7bfa3953cb93d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="varint_8h.html#af09078f363c97757f6e7bfa3953cb93d">GRPC_CHTTP2_VARINT_LENGTH</a>(n, prefix_bits)</td></tr>
<tr class="separator:af09078f363c97757f6e7bfa3953cb93d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f5350a7ba20095c1c903463e74b8e54"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="varint_8h.html#a6f5350a7ba20095c1c903463e74b8e54">GRPC_CHTTP2_WRITE_VARINT</a>(n, prefix_bits, prefix_or, target, length)</td></tr>
<tr class="separator:a6f5350a7ba20095c1c903463e74b8e54"><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:a2b4567fce80183246809231da7d798dc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="varint_8h.html#a2b4567fce80183246809231da7d798dc">grpc_chttp2_hpack_varint_length</a> (<a class="el" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a> tail_value)</td></tr>
<tr class="separator:a2b4567fce80183246809231da7d798dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fcc1174a3686feebdb7085e30283a66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="varint_8h.html#a7fcc1174a3686feebdb7085e30283a66">grpc_chttp2_hpack_write_varint_tail</a> (<a class="el" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a> tail_value, <a class="el" href="port__platform_8h.html#aeeb41e29e7c7a916a4e0fb6cfb9f92e0">gpr_uint8</a> *target, int tail_length)</td></tr>
<tr class="separator:a7fcc1174a3686feebdb7085e30283a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a13810a2894d0705c3f1b6fd462f567bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_MAX_IN_PREFIX</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">prefix_bits</td><td>)</td>
<td>&#160;&#160;&#160;((1 &lt;&lt; (8 - (prefix_bits))) - 1)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af09078f363c97757f6e7bfa3953cb93d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_VARINT_LENGTH</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">prefix_bits&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">((n) &lt; <a class="code" href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a>(prefix_bits) \</div>
<div class="line"> ? 1 \</div>
<div class="line"> : <a class="code" href="varint_8h.html#a2b4567fce80183246809231da7d798dc">grpc_chttp2_hpack_varint_length</a>( \</div>
<div class="line"> (n)-<a class="code" href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a>(prefix_bits)))</div>
<div class="ttc" id="varint_8h_html_a13810a2894d0705c3f1b6fd462f567bd"><div class="ttname"><a href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a></div><div class="ttdeci">#define GRPC_CHTTP2_MAX_IN_PREFIX(prefix_bits)</div><div class="ttdef"><b>Definition:</b> varint.h:52</div></div>
<div class="ttc" id="varint_8h_html_a2b4567fce80183246809231da7d798dc"><div class="ttname"><a href="varint_8h.html#a2b4567fce80183246809231da7d798dc">grpc_chttp2_hpack_varint_length</a></div><div class="ttdeci">int grpc_chttp2_hpack_varint_length(gpr_uint32 tail_value)</div><div class="ttdef"><b>Definition:</b> varint.c:36</div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a6f5350a7ba20095c1c903463e74b8e54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CHTTP2_WRITE_VARINT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">prefix_bits, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">prefix_or, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">target, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">length&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { <a class="code" href="port__platform_8h.html#aeeb41e29e7c7a916a4e0fb6cfb9f92e0">\</a></div>
<div class="line"><a class="code" href="port__platform_8h.html#aeeb41e29e7c7a916a4e0fb6cfb9f92e0"> gpr_uint8</a>* tgt = target; \</div>
<div class="line"> if ((length) == 1) { \</div>
<div class="line"> (tgt)[0] = (prefix_or) | (n); \</div>
<div class="line"> } <span class="keywordflow">else</span> { \</div>
<div class="line"> (tgt)[0] = (prefix_or) | <a class="code" href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a>(prefix_bits); <a class="code" href="varint_8h.html#a7fcc1174a3686feebdb7085e30283a66">\</a></div>
<div class="line"><a class="code" href="varint_8h.html#a7fcc1174a3686feebdb7085e30283a66"> grpc_chttp2_hpack_write_varint_tail</a>( \</div>
<div class="line"> (n)-<a class="code" href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a>(prefix_bits), (tgt) + 1, (length)-1); \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
<div class="ttc" id="varint_8h_html_a13810a2894d0705c3f1b6fd462f567bd"><div class="ttname"><a href="varint_8h.html#a13810a2894d0705c3f1b6fd462f567bd">GRPC_CHTTP2_MAX_IN_PREFIX</a></div><div class="ttdeci">#define GRPC_CHTTP2_MAX_IN_PREFIX(prefix_bits)</div><div class="ttdef"><b>Definition:</b> varint.h:52</div></div>
<div class="ttc" id="port__platform_8h_html_aeeb41e29e7c7a916a4e0fb6cfb9f92e0"><div class="ttname"><a href="port__platform_8h.html#aeeb41e29e7c7a916a4e0fb6cfb9f92e0">gpr_uint8</a></div><div class="ttdeci">uint8_t gpr_uint8</div><div class="ttdef"><b>Definition:</b> port_platform.h:307</div></div>
<div class="ttc" id="varint_8h_html_a7fcc1174a3686feebdb7085e30283a66"><div class="ttname"><a href="varint_8h.html#a7fcc1174a3686feebdb7085e30283a66">grpc_chttp2_hpack_write_varint_tail</a></div><div class="ttdeci">void grpc_chttp2_hpack_write_varint_tail(gpr_uint32 tail_value, gpr_uint8 *target, int tail_length)</div><div class="ttdef"><b>Definition:</b> varint.c:50</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a2b4567fce80183246809231da7d798dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_chttp2_hpack_varint_length </td>
<td>(</td>
<td class="paramtype"><a class="el" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a>&#160;</td>
<td class="paramname"><em>tail_value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7fcc1174a3686feebdb7085e30283a66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_chttp2_hpack_write_varint_tail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="port__platform_8h.html#aa6abd4df815a5498d1a04b5e691a74a9">gpr_uint32</a>&#160;</td>
<td class="paramname"><em>tail_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="port__platform_8h.html#aeeb41e29e7c7a916a4e0fb6cfb9f92e0">gpr_uint8</a> *&#160;</td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>tail_length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</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>