← Back to branch summary

~ubuntu-branches/debian/sid/pion/sid

« back to all changes in this revision

Viewing changes to doc/html/classpion_1_1http_1_1reader.html

  • Committer: Package Import Robot
  • Author(s): Roberto C. Sanchez
  • Date: 2013-07-06 18:04:35 UTC
  • Revision ID: package-import@ubuntu.com-20130706180435-kejjzc1qpyz3qv6c
Tags: upstream-5.0.1+dfsg
Import upstream version 5.0.1+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/classpion_1_1http_1_1reader.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>pion: pion::http::reader Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.6.1 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul>
 
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
15
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
16
      <li><a href="files.html"><span>Files</span></a></li>
 
17
    </ul>
 
18
  </div>
 
19
  <div class="tabs">
 
20
    <ul>
 
21
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
22
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
23
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
24
    </ul>
 
25
  </div>
 
26
  <div class="navpath"><b>pion</b>::<b>http</b>::<a class="el" href="classpion_1_1http_1_1reader.html">reader</a>
 
27
  </div>
 
28
</div>
 
29
<div class="contents">
 
30
<h1>pion::http::reader Class Reference</h1><!-- doxytag: class="pion::http::reader" --><!-- doxytag: inherits="pion::http::parser" -->
 
31
<p><code>#include &lt;<a class="el" href="reader_8hpp_source.html">reader.hpp</a>&gt;</code></p>
 
32
 
 
33
<p>Inherits <a class="el" href="classpion_1_1http_1_1parser.html">pion::http::parser</a>.</p>
 
34
 
 
35
<p>Inherited by <a class="el" href="classpion_1_1http_1_1request__reader.html">pion::http::request_reader</a>, and <a class="el" href="classpion_1_1http_1_1response__reader.html">pion::http::response_reader</a>.</p>
 
36
 
 
37
<p><a href="classpion_1_1http_1_1reader-members.html">List of all members.</a></p>
 
38
<table border="0" cellpadding="0" cellspacing="0">
 
39
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9f883cb767252fb9976e229e68f20ea"></a><!-- doxytag: member="pion::http::reader::receive" ref="af9f883cb767252fb9976e229e68f20ea" args="(void)" -->
 
41
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#af9f883cb767252fb9976e229e68f20ea">receive</a> (void)</td></tr>
 
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Incrementally reads &amp; parses the HTTP <a class="el" href="classpion_1_1http_1_1message.html">message</a>. <br/></td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6df8c9dd8f6587b49eb54ce4f7ace431"></a><!-- doxytag: member="pion::http::reader::get_connection" ref="a6df8c9dd8f6587b49eb54ce4f7ace431" args="(void)" -->
 
44
tcp::connection_ptr &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#a6df8c9dd8f6587b49eb54ce4f7ace431">get_connection</a> (void)</td></tr>
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns a shared pointer to the TCP connection <br/></td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabe13844673a420869d0e0fe31e198ad"></a><!-- doxytag: member="pion::http::reader::set_timeout" ref="aabe13844673a420869d0e0fe31e198ad" args="(boost::uint32_t seconds)" -->
 
47
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#aabe13844673a420869d0e0fe31e198ad">set_timeout</a> (boost::uint32_t seconds)</td></tr>
 
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets the maximum number of seconds for read operations <br/></td></tr>
 
49
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
 
50
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#a32970499fa606eb9a8a71ce7afbcf252">reader</a> (const bool is_request, tcp::connection_ptr &amp;tcp_conn)</td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#afd7a8af3a502d6863ef5c2166d3d7208">consume_bytes</a> (const boost::system::error_code &amp;read_error, std::size_t bytes_read)</td></tr>
 
52
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc3496a25c7bd1fb3ecc704ed752b190"></a><!-- doxytag: member="pion::http::reader::consume_bytes" ref="acc3496a25c7bd1fb3ecc704ed752b190" args="(void)" -->
 
53
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#acc3496a25c7bd1fb3ecc704ed752b190">consume_bytes</a> (void)</td></tr>
 
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Consumes bytes that have been read using an HTTP <a class="el" href="classpion_1_1http_1_1parser.html">parser</a>. <br/></td></tr>
 
55
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a3b9767dc84fd1a6ee0e1558ec3d76e"></a><!-- doxytag: member="pion::http::reader::read_bytes" ref="a8a3b9767dc84fd1a6ee0e1558ec3d76e" args="(void)=0" -->
 
56
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#a8a3b9767dc84fd1a6ee0e1558ec3d76e">read_bytes</a> (void)=0</td></tr>
 
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads more bytes from the TCP connection. <br/></td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7d3818810df72a7d2895ff1f767be9b"></a><!-- doxytag: member="pion::http::reader::finished_reading" ref="ae7d3818810df72a7d2895ff1f767be9b" args="(const boost::system::error_code &amp;ec)=0" -->
 
59
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#ae7d3818810df72a7d2895ff1f767be9b">finished_reading</a> (const boost::system::error_code &amp;ec)=0</td></tr>
 
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called after we have finished reading/parsing the HTTP <a class="el" href="classpion_1_1http_1_1message.html">message</a>. <br/></td></tr>
 
61
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6186ceb636d352cae97c33fe105bd9a3"></a><!-- doxytag: member="pion::http::reader::get_message" ref="a6186ceb636d352cae97c33fe105bd9a3" args="(void)=0" -->
 
62
virtual <a class="el" href="classpion_1_1http_1_1message.html">http::message</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1http_1_1reader.html#a6186ceb636d352cae97c33fe105bd9a3">get_message</a> (void)=0</td></tr>
 
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a reference to the HTTP <a class="el" href="classpion_1_1http_1_1message.html">message</a> being parsed. <br/></td></tr>
 
64
</table>
 
65
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
66
<p><a class="el" href="classpion_1_1http_1_1reader.html">reader</a>: asynchronously reads and parses HTTP messages </p>
 
67
 
 
68
<p>Definition at line <a class="el" href="reader_8hpp_source.html#l00028">28</a> of file <a class="el" href="reader_8hpp_source.html">reader.hpp</a>.</p>
 
69
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
70
<a class="anchor" id="a32970499fa606eb9a8a71ce7afbcf252"></a><!-- doxytag: member="pion::http::reader::reader" ref="a32970499fa606eb9a8a71ce7afbcf252" args="(const bool is_request, tcp::connection_ptr &amp;tcp_conn)" -->
 
71
<div class="memitem">
 
72
<div class="memproto">
 
73
      <table class="memname">
 
74
        <tr>
 
75
          <td class="memname">pion::http::reader::reader </td>
 
76
          <td>(</td>
 
77
          <td class="paramtype">const bool&nbsp;</td>
 
78
          <td class="paramname"> <em>is_request</em>, </td>
 
79
        </tr>
 
80
        <tr>
 
81
          <td class="paramkey"></td>
 
82
          <td></td>
 
83
          <td class="paramtype">tcp::connection_ptr &amp;&nbsp;</td>
 
84
          <td class="paramname"> <em>tcp_conn</em></td><td>&nbsp;</td>
 
85
        </tr>
 
86
        <tr>
 
87
          <td></td>
 
88
          <td>)</td>
 
89
          <td></td><td></td><td><code> [inline, protected]</code></td>
 
90
        </tr>
 
91
      </table>
 
92
</div>
 
93
<div class="memdoc">
 
94
<p>protected constructor: only derived classes may create objects</p>
 
95
<dl><dt><b>Parameters:</b></dt><dd>
 
96
  <table border="0" cellspacing="2" cellpadding="0">
 
97
    <tr><td valign="top"></td><td valign="top"><em>is_request</em>&nbsp;</td><td>if true, the <a class="el" href="classpion_1_1http_1_1message.html">message</a> is parsed as an HTTP <a class="el" href="classpion_1_1http_1_1request.html">request</a>; if false, the <a class="el" href="classpion_1_1http_1_1message.html">message</a> is parsed as an HTTP <a class="el" href="classpion_1_1http_1_1response.html">response</a> </td></tr>
 
98
    <tr><td valign="top"></td><td valign="top"><em>tcp_conn</em>&nbsp;</td><td>TCP connection containing a new <a class="el" href="classpion_1_1http_1_1message.html">message</a> to parse </td></tr>
 
99
  </table>
 
100
  </dd>
 
101
</dl>
 
102
 
 
103
<p>Definition at line <a class="el" href="reader_8hpp_source.html#l00055">55</a> of file <a class="el" href="reader_8hpp_source.html">reader.hpp</a>.</p>
 
104
 
 
105
</div>
 
106
</div>
 
107
<hr/><h2>Member Function Documentation</h2>
 
108
<a class="anchor" id="afd7a8af3a502d6863ef5c2166d3d7208"></a><!-- doxytag: member="pion::http::reader::consume_bytes" ref="afd7a8af3a502d6863ef5c2166d3d7208" args="(const boost::system::error_code &amp;read_error, std::size_t bytes_read)" -->
 
109
<div class="memitem">
 
110
<div class="memproto">
 
111
      <table class="memname">
 
112
        <tr>
 
113
          <td class="memname">void pion::http::reader::consume_bytes </td>
 
114
          <td>(</td>
 
115
          <td class="paramtype">const boost::system::error_code &amp;&nbsp;</td>
 
116
          <td class="paramname"> <em>read_error</em>, </td>
 
117
        </tr>
 
118
        <tr>
 
119
          <td class="paramkey"></td>
 
120
          <td></td>
 
121
          <td class="paramtype">std::size_t&nbsp;</td>
 
122
          <td class="paramname"> <em>bytes_read</em></td><td>&nbsp;</td>
 
123
        </tr>
 
124
        <tr>
 
125
          <td></td>
 
126
          <td>)</td>
 
127
          <td></td><td></td><td><code> [protected]</code></td>
 
128
        </tr>
 
129
      </table>
 
130
</div>
 
131
<div class="memdoc">
 
132
<p>Consumes bytes that have been read using an HTTP <a class="el" href="classpion_1_1http_1_1parser.html">parser</a></p>
 
133
<dl><dt><b>Parameters:</b></dt><dd>
 
134
  <table border="0" cellspacing="2" cellpadding="0">
 
135
    <tr><td valign="top"></td><td valign="top"><em>read_error</em>&nbsp;</td><td>error status from the last read operation </td></tr>
 
136
    <tr><td valign="top"></td><td valign="top"><em>bytes_read</em>&nbsp;</td><td>number of bytes consumed by the last read operation </td></tr>
 
137
  </table>
 
138
  </dd>
 
139
</dl>
 
140
 
 
141
<p>Definition at line <a class="el" href="http__reader_8cpp_source.html#l00041">41</a> of file <a class="el" href="http__reader_8cpp_source.html">http_reader.cpp</a>.</p>
 
142
 
 
143
<p>References <a class="el" href="http__reader_8cpp_source.html#l00066">consume_bytes()</a>, <a class="el" href="http_2parser_8hpp_source.html#l00272">pion::http::parser::is_parsing_request()</a>, <a class="el" href="http_2parser_8hpp_source.html#l00561">pion::http::parser::m_logger</a>, and <a class="el" href="http_2parser_8hpp_source.html#l00180">pion::http::parser::set_read_buffer()</a>.</p>
 
144
 
 
145
</div>
 
146
</div>
 
147
<hr/>The documentation for this class was generated from the following files:<ul>
 
148
<li>include/pion/http/<a class="el" href="reader_8hpp_source.html">reader.hpp</a></li>
 
149
<li>src/<a class="el" href="http__reader_8cpp_source.html">http_reader.cpp</a></li>
 
150
</ul>
 
151
</div>
 
152
<hr size="1"/><address style="text-align: right;"><small>Generated on 15 Apr 2013 for pion by&nbsp;
 
153
<a href="http://www.doxygen.org/index.html">
 
154
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
 
155
</body>
 
156
</html>