/usr/share/doc/libpion-doc/html/reader_8hpp_source.html is in libpion-doc 5.0.7+dfsg-4.
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 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pion: include/pion/http/reader.hpp Source File</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="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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pion
 <span id="projectnumber">5.0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_96d8a58f4ca411bbafcf73a070f69a21.html">pion</a></li><li class="navelem"><a class="el" href="dir_a798c42f1e65975a408690f112137fd9.html">http</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">reader.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// ---------------------------------------------------------------------</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// pion: a Boost C++ framework for building lightweight HTTP interfaces</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// ---------------------------------------------------------------------</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2007-2014 Splunk Inc. (https://github.com/splunk/pion)</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// Distributed under the Boost Software License, Version 1.0.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// See http://www.boost.org/LICENSE_1_0.txt</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef __PION_HTTP_READER_HEADER__</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define __PION_HTTP_READER_HEADER__</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <boost/asio.hpp></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <pion/config.hpp></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <pion/http/parser.hpp></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <pion/http/message.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <pion/tcp/connection.hpp></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <pion/tcp/timer.hpp></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespacepion.html">pion</a> { <span class="comment">// begin namespace pion</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>http { <span class="comment">// begin namespace http</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classpion_1_1http_1_1reader.html"> 28</a></span> <span class="keyword">class </span>PION_API <a class="code" href="classpion_1_1http_1_1reader.html">reader</a> :</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">public</span> <a class="code" href="classpion_1_1http_1_1parser.html">http::parser</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// default destructor</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpion_1_1http_1_1reader.html">reader</a>() {}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> receive(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classpion_1_1http_1_1reader.html#a6df8c9dd8f6587b49eb54ce4f7ace431"> 40</a></span>  <span class="keyword">inline</span> tcp::connection_ptr& <a class="code" href="classpion_1_1http_1_1reader.html#a6df8c9dd8f6587b49eb54ce4f7ace431">get_connection</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> m_tcp_conn; }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classpion_1_1http_1_1reader.html#aabe13844673a420869d0e0fe31e198ad"> 43</a></span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1http_1_1reader.html#aabe13844673a420869d0e0fe31e198ad">set_timeout</a>(boost::uint32_t seconds) { m_read_timeout = seconds; }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classpion_1_1http_1_1reader.html#af9bdf6ead8b5caeae1d481e418e4dddc"> 55</a></span>  <a class="code" href="classpion_1_1http_1_1reader.html#af9bdf6ead8b5caeae1d481e418e4dddc">reader</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> is_request, <span class="keyword">const</span> tcp::connection_ptr& tcp_conn)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  : http::<a class="code" href="classpion_1_1http_1_1parser.html">parser</a>(is_request), m_tcp_conn(tcp_conn),</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  m_read_timeout(DEFAULT_READ_TIMEOUT)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {} </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> consume_bytes(<span class="keyword">const</span> boost::system::error_code& read_error,</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::size_t bytes_read);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> consume_bytes(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> read_bytes(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> finished_reading(<span class="keyword">const</span> boost::system::error_code& ec) = 0;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <a class="code" href="classpion_1_1http_1_1message.html">http::message</a>& get_message(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> read_bytes_with_timeout(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">void</span> handle_read_error(<span class="keyword">const</span> boost::system::error_code& read_error);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">static</span> <span class="keyword">const</span> boost::uint32_t DEFAULT_READ_TIMEOUT;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  tcp::connection_ptr m_tcp_conn;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  tcp::timer_ptr m_timer_ptr;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  boost::uint32_t m_read_timeout;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">// end namespace http</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> } <span class="comment">// end namespace pion</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classpion_1_1http_1_1reader_html"><div class="ttname"><a href="classpion_1_1http_1_1reader.html">pion::http::reader</a></div><div class="ttdef"><b>Definition:</b> <a href="reader_8hpp_source.html#l00028">reader.hpp:28</a></div></div>
<div class="ttc" id="classpion_1_1http_1_1reader_html_af9bdf6ead8b5caeae1d481e418e4dddc"><div class="ttname"><a href="classpion_1_1http_1_1reader.html#af9bdf6ead8b5caeae1d481e418e4dddc">pion::http::reader::reader</a></div><div class="ttdeci">reader(const bool is_request, const tcp::connection_ptr &tcp_conn)</div><div class="ttdef"><b>Definition:</b> <a href="reader_8hpp_source.html#l00055">reader.hpp:55</a></div></div>
<div class="ttc" id="classpion_1_1http_1_1reader_html_a6df8c9dd8f6587b49eb54ce4f7ace431"><div class="ttname"><a href="classpion_1_1http_1_1reader.html#a6df8c9dd8f6587b49eb54ce4f7ace431">pion::http::reader::get_connection</a></div><div class="ttdeci">tcp::connection_ptr & get_connection(void)</div><div class="ttdoc">returns a shared pointer to the TCP connection </div><div class="ttdef"><b>Definition:</b> <a href="reader_8hpp_source.html#l00040">reader.hpp:40</a></div></div>
<div class="ttc" id="classpion_1_1http_1_1message_html"><div class="ttname"><a href="classpion_1_1http_1_1message.html">pion::http::message</a></div><div class="ttdef"><b>Definition:</b> <a href="message_8hpp_source.html#l00055">message.hpp:55</a></div></div>
<div class="ttc" id="namespacepion_html"><div class="ttname"><a href="namespacepion.html">pion</a></div><div class="ttdef"><b>Definition:</b> <a href="admin__rights_8hpp_source.html#l00019">admin_rights.hpp:19</a></div></div>
<div class="ttc" id="classpion_1_1http_1_1parser_html"><div class="ttname"><a href="classpion_1_1http_1_1parser.html">pion::http::parser</a></div><div class="ttdef"><b>Definition:</b> <a href="http_2parser_8hpp_source.html#l00039">parser.hpp:39</a></div></div>
<div class="ttc" id="classpion_1_1http_1_1reader_html_aabe13844673a420869d0e0fe31e198ad"><div class="ttname"><a href="classpion_1_1http_1_1reader.html#aabe13844673a420869d0e0fe31e198ad">pion::http::reader::set_timeout</a></div><div class="ttdeci">void set_timeout(boost::uint32_t seconds)</div><div class="ttdoc">sets the maximum number of seconds for read operations </div><div class="ttdef"><b>Definition:</b> <a href="reader_8hpp_source.html#l00043">reader.hpp:43</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|