/usr/share/doc/libpion-doc/html/classpion_1_1spdy_1_1decompressor.html is in libpion-doc 5.0.5+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | <!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"/>
<title>pion: pion::spdy::decompressor Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>pion</b>::<b>spdy</b>::<a class="el" href="classpion_1_1spdy_1_1decompressor.html">decompressor</a>
</div>
</div>
<div class="contents">
<h1>pion::spdy::decompressor Class Reference</h1><!-- doxytag: class="pion::spdy::decompressor" -->
<p><code>#include <<a class="el" href="decompressor_8hpp_source.html">decompressor.hpp</a>></code></p>
<p><a href="classpion_1_1spdy_1_1decompressor-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1spdy_1_1decompressor.html#a9fb34f033b4d95e5f23fa9b0d03c4818">data_size_t</a> { <a class="el" href="classpion_1_1spdy_1_1decompressor.html#a9fb34f033b4d95e5f23fa9b0d03c4818a44ab53316cb7bd9c9d66621b6e537e08">MAX_UNCOMPRESSED_DATA_BUF_SIZE</a> = 16384
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>data size constants </p>
<a href="classpion_1_1spdy_1_1decompressor.html#a9fb34f033b4d95e5f23fa9b0d03c4818">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab60b284101b5b7ffedc2fb4daab2f77d"></a><!-- doxytag: member="pion::spdy::decompressor::decompressor" ref="ab60b284101b5b7ffedc2fb4daab2f77d" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1spdy_1_1decompressor.html#ab60b284101b5b7ffedc2fb4daab2f77d">decompressor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructs a new <a class="el" href="classpion_1_1spdy_1_1decompressor.html">decompressor</a> object (default constructor) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc518d8ec91bb78d58077f7fb661881f"></a><!-- doxytag: member="pion::spdy::decompressor::~decompressor" ref="adc518d8ec91bb78d58077f7fb661881f" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1spdy_1_1decompressor.html#adc518d8ec91bb78d58077f7fb661881f">~decompressor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1spdy_1_1decompressor.html#a9e6e8b557657365b9e30a501c9bdd00b">decompress</a> (const char *compressed_data_ptr, boost::uint32_t stream_id, const <a class="el" href="structpion_1_1spdy_1_1spdy__control__frame__info.html">spdy_control_frame_info</a> &frame, boost::uint32_t header_block_length)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1spdy_1_1decompressor.html#ab6c148eb985c1e016235cef3863913c8">spdy_decompress_header</a> (const char *compressed_data_ptr, z_streamp decomp, boost::uint32_t length, boost::uint32_t &uncomp_length)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>SPDYDecompressor : Decompresses SPDY frames </p>
<p>Definition at line <a class="el" href="decompressor_8hpp_source.html#l00029">29</a> of file <a class="el" href="decompressor_8hpp_source.html">decompressor.hpp</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a9fb34f033b4d95e5f23fa9b0d03c4818"></a><!-- doxytag: member="pion::spdy::decompressor::data_size_t" ref="a9fb34f033b4d95e5f23fa9b0d03c4818" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classpion_1_1spdy_1_1decompressor.html#a9fb34f033b4d95e5f23fa9b0d03c4818">pion::spdy::decompressor::data_size_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>data size constants </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a9fb34f033b4d95e5f23fa9b0d03c4818a44ab53316cb7bd9c9d66621b6e537e08"></a><!-- doxytag: member="MAX_UNCOMPRESSED_DATA_BUF_SIZE" ref="a9fb34f033b4d95e5f23fa9b0d03c4818a44ab53316cb7bd9c9d66621b6e537e08" args="" -->MAX_UNCOMPRESSED_DATA_BUF_SIZE</em> </td><td>
<p>maximum size of an uncompressed spdy header </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="decompressor_8hpp_source.html#l00034">34</a> of file <a class="el" href="decompressor_8hpp_source.html">decompressor.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9e6e8b557657365b9e30a501c9bdd00b"></a><!-- doxytag: member="pion::spdy::decompressor::decompress" ref="a9e6e8b557657365b9e30a501c9bdd00b" args="(const char *compressed_data_ptr, boost::uint32_t stream_id, const spdy_control_frame_info &frame, boost::uint32_t header_block_length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * pion::spdy::decompressor::decompress </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>compressed_data_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"> <em>stream_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpion_1_1spdy_1_1spdy__control__frame__info.html">spdy_control_frame_info</a> & </td>
<td class="paramname"> <em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"> <em>header_block_length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>decompresses the http content</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the uncompressed string, or null on failure </dd></dl>
<p><p>Get our <a class="el" href="classpion_1_1spdy_1_1decompressor.html">decompressor</a>. </p>
</p>
<p>Definition at line <a class="el" href="spdy__decompressor_8cpp_source.html#l00089">89</a> of file <a class="el" href="spdy__decompressor_8cpp_source.html">spdy_decompressor.cpp</a>.</p>
<p>References <a class="el" href="spdy__decompressor_8cpp_source.html#l00131">spdy_decompress_header()</a>.</p>
</div>
</div>
<a class="anchor" id="ab6c148eb985c1e016235cef3863913c8"></a><!-- doxytag: member="pion::spdy::decompressor::spdy_decompress_header" ref="ab6c148eb985c1e016235cef3863913c8" args="(const char *compressed_data_ptr, z_streamp decomp, boost::uint32_t length, boost::uint32_t &uncomp_length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool pion::spdy::decompressor::spdy_decompress_header </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>compressed_data_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">z_streamp </td>
<td class="paramname"> <em>decomp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::uint32_t & </td>
<td class="paramname"> <em>uncomp_length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>decompresses the spdy header</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful </dd></dl>
<p>Definition at line <a class="el" href="spdy__decompressor_8cpp_source.html#l00131">131</a> of file <a class="el" href="spdy__decompressor_8cpp_source.html">spdy_decompressor.cpp</a>.</p>
<p>References <a class="el" href="decompressor_8hpp_source.html#l00036">MAX_UNCOMPRESSED_DATA_BUF_SIZE</a>.</p>
<p>Referenced by <a class="el" href="spdy__decompressor_8cpp_source.html#l00089">decompress()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/pion/spdy/<a class="el" href="decompressor_8hpp_source.html">decompressor.hpp</a></li>
<li>src/<a class="el" href="spdy__decompressor_8cpp_source.html">spdy_decompressor.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 17 Dec 2013 for pion by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|