File: Poco.Net.MultipartReader.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (104 lines) | stat: -rw-r--r-- 7,830 bytes parent folder | download | duplicates (2)
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
<!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>
<title>Class Poco::Net::MultipartReader</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Net.html" class="namespace">Poco::Net</a></h1>
<h1 class="symbol">class MultipartReader</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> Messages<br />
<b>Header:</b> Poco/Net/MultipartReader.h</p>
<h2>Description</h2>
<div class="description">
<p>This class is used to split a MIME multipart message into its single parts. </p>
<p>The format of multipart messages is described in section 5.1 of <a href="http://www.ietf.org/rfc/rfc2046.txt" target="_blank">RFC 2046</a>. </p>
<p>To split a multipart message into its parts, do the following: </p>
<ul>
<li>Create a <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a> object, passing it an input stream and optionally a boundary string. </li>
<li>while <a href="Poco.Net.MultipartReader.html#14007" title="Poco::Net::MultipartReader::hasNextPart()">hasNextPart</a>() returns true, call <a href="Poco.Net.MultipartReader.html#14005" title="Poco::Net::MultipartReader::nextPart()">nextPart</a>() and read the part from <a href="Poco.Net.MultipartReader.html#14008" title="Poco::Net::MultipartReader::stream()">stream</a>(). </li>
</ul>
<p>Always ensure that you read all data from the part stream, otherwise the <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a> will fail to find the next part. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.MultipartReader.html#14009" title="Poco::Net::MultipartReader::boundary()">boundary</a>, <a href="Poco.Net.MultipartReader.html#14010" title="Poco::Net::MultipartReader::findFirstBoundary()">findFirstBoundary</a>, <a href="Poco.Net.MultipartReader.html#14011" title="Poco::Net::MultipartReader::guessBoundary()">guessBoundary</a>, <a href="Poco.Net.MultipartReader.html#14007" title="Poco::Net::MultipartReader::hasNextPart()">hasNextPart</a>, <a href="Poco.Net.MultipartReader.html#14005" title="Poco::Net::MultipartReader::nextPart()">nextPart</a>, <a href="Poco.Net.MultipartReader.html#14012" title="Poco::Net::MultipartReader::parseHeader()">parseHeader</a>, <a href="Poco.Net.MultipartReader.html#14014" title="Poco::Net::MultipartReader::readLine()">readLine</a>, <a href="Poco.Net.MultipartReader.html#14008" title="Poco::Net::MultipartReader::stream()">stream</a></p>
<h2>Constructors</h2>
<h3><a name="13999">MultipartReader</a></h3>
<p class="decl">explicit <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::istream &amp; istr<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a> and attaches it to the given input stream.  </p>
<p>The boundary string is determined from the input stream. The message must not contain a preamble preceding the first encapsulation boundary. </p>
</div>
<h3><a name="14001">MultipartReader</a></h3>
<p class="decl"><a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::istream &amp; istr,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; boundary<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a> and attaches it to the given input stream. The given boundary string is used to find message boundaries. </p>
</div>
<h2>Destructor</h2>
<h3><a name="14004">~MultipartReader</a></h3>
<p class="decl">~<a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="14009">boundary</a></h3>
<p class="decl">const std::string &amp; boundary() const;</p>
<div class="description">
<p>Returns the multipart boundary used by this reader. </p>
</div>
<h3><a name="14007">hasNextPart</a></h3>
<p class="decl">bool hasNextPart();</p>
<div class="description">
<p>Returns true if and only if more parts are available. </p>
<p>Before the first call to <a href="Poco.Net.MultipartReader.html#14005" title="Poco::Net::MultipartReader::nextPart()">nextPart</a>(), returns always true. </p>
</div>
<h3><a name="14005">nextPart</a></h3>
<p class="decl">void nextPart(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Net.MessageHeader.html" title="class Poco::Net::MessageHeader">MessageHeader</a> &amp; messageHeader<br />);</p>
<div class="description">
<p>Moves to the next part in the message and stores the part's header fields in messageHeader. </p>
<p>Throws an <a href="Poco.Net.MultipartException.html" title="class Poco::Net::MultipartException">MultipartException</a> if there are no more parts available, or if no boundary line can be found in the input stream. </p>
</div>
<h3><a name="14008">stream</a></h3>
<p class="decl">std::istream &amp; stream() const;</p>
<div class="description">
<p>Returns a reference to the reader's stream that can be used to read the current part. </p>
<p>The returned reference will be valid until <a href="Poco.Net.MultipartReader.html#14005" title="Poco::Net::MultipartReader::nextPart()">nextPart</a>() is called or the <a href="Poco.Net.MultipartReader.html" title="class Poco::Net::MultipartReader">MultipartReader</a> object is destroyed. </p>
</div>
<h3><a name="14010">findFirstBoundary</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void findFirstBoundary();</p>
<div class="description">
<p></p>
</div>
<h3><a name="14011">guessBoundary</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void guessBoundary();</p>
<div class="description">
<p></p>
</div>
<h3><a name="14012">parseHeader</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void parseHeader(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Net.MessageHeader.html" title="class Poco::Net::MessageHeader">MessageHeader</a> &amp; messageHeader<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="14014">readLine</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool readLine(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::string &amp; line,<br />&nbsp;&nbsp;&nbsp;&nbsp;std::string::size_type n<br />);</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>