File: Poco.Net.MultipartWriter.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 (83 lines) | stat: -rw-r--r-- 5,582 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
<!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::MultipartWriter</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 MultipartWriter</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> Messages<br />
<b>Header:</b> Poco/Net/MultipartWriter.h</p>
<h2>Description</h2>
<div class="description">
<p>This class is used to write MIME multipart messages to an output stream. </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 create a multipart message, first create a <a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a> object. Then, for each part, call <a href="Poco.Net.MultipartWriter.html#14032" title="Poco::Net::MultipartWriter::nextPart()">nextPart</a>() and write the content to the output stream. Repeat for all parts.  After the last part has been written, call <a href="Poco.Net.MultipartWriter.html#14034" title="Poco::Net::MultipartWriter::close()">close</a>() to finish the multipart message. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.MultipartWriter.html#14036" title="Poco::Net::MultipartWriter::boundary()">boundary</a>, <a href="Poco.Net.MultipartWriter.html#14034" title="Poco::Net::MultipartWriter::close()">close</a>, <a href="Poco.Net.MultipartWriter.html#14037" title="Poco::Net::MultipartWriter::createBoundary()">createBoundary</a>, <a href="Poco.Net.MultipartWriter.html#14032" title="Poco::Net::MultipartWriter::nextPart()">nextPart</a>, <a href="Poco.Net.MultipartWriter.html#14035" title="Poco::Net::MultipartWriter::stream()">stream</a></p>
<h2>Constructors</h2>
<h3><a name="14026">MultipartWriter</a></h3>
<p class="decl">explicit <a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::ostream &amp; ostr<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a>, using the given output stream. </p>
<p>Creates a random boundary string. </p>
</div>
<h3><a name="14028">MultipartWriter</a></h3>
<p class="decl"><a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::ostream &amp; ostr,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; boundary<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a>, using the given output stream and boundary string. </p>
</div>
<h2>Destructor</h2>
<h3><a name="14031">~MultipartWriter</a></h3>
<p class="decl">~<a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.MultipartWriter.html" title="class Poco::Net::MultipartWriter">MultipartWriter</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="14036">boundary</a></h3>
<p class="decl">const std::string &amp; boundary() const;</p>
<div class="description">
<p>Returns the multipart boundary used by this writer. </p>
</div>
<h3><a name="14034">close</a></h3>
<p class="decl">void close();</p>
<div class="description">
<p>Closes the multipart message and writes the terminating boundary string. </p>
<p>Does not close the underlying stream. </p>
</div>
<h3><a name="14037">createBoundary</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static std::string createBoundary();</p>
<div class="description">
<p>Creates a random boundary string. </p>
<p>The string always has the form MIME_boundary_XXXXXXXXXXXX, where XXXXXXXXXXXX is a random hexadecimal number. </p>
</div>
<h3><a name="14032">nextPart</a></h3>
<p class="decl">void nextPart(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.MessageHeader.html" title="class Poco::Net::MessageHeader">MessageHeader</a> &amp; header<br />);</p>
<div class="description">
<p>Opens a new message part and writes the message boundary string, followed by the message header to the stream. </p>
</div>
<h3><a name="14035">stream</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">std::ostream &amp; stream();</p>
<div class="description">
<p>Returns the writer's stream. </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>