3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-21 19:23:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
crashpad/doc/generated/doxygen/classcrashpad_1_1HTTPMultipartBuilder.html
Mark Mentovai c0436c6475 Update documentation to master f191fff64dd3
2016-11-08 14:26:59 -05:00

220 lines
12 KiB
HTML
Raw Blame History

<!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>Crashpad: crashpad::HTTPMultipartBuilder Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="crashpad_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">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1HTTPMultipartBuilder.html">HTTPMultipartBuilder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1HTTPMultipartBuilder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::HTTPMultipartBuilder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is used to build a MIME multipart message, conforming to RFC 2046, for use as a HTTP request body.
<a href="classcrashpad_1_1HTTPMultipartBuilder.html#details">More...</a></p>
<p><code>#include &quot;util/net/http_multipart_builder.h&quot;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3c51d6649d19f1e5d39b787f18dc2d06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1HTTPMultipartBuilder.html#a3c51d6649d19f1e5d39b787f18dc2d06">SetFormData</a> (const std::string &amp;key, const std::string &amp;value)</td></tr>
<tr class="memdesc:a3c51d6649d19f1e5d39b787f18dc2d06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a <code>Content-Disposition: form-data</code> key-value pair. <a href="#a3c51d6649d19f1e5d39b787f18dc2d06">More...</a><br /></td></tr>
<tr class="separator:a3c51d6649d19f1e5d39b787f18dc2d06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d5d01b6e435c0706e1a687a3b64ad62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1HTTPMultipartBuilder.html#a9d5d01b6e435c0706e1a687a3b64ad62">SetFileAttachment</a> (const std::string &amp;key, const std::string &amp;upload_file_name, const base::FilePath &amp;path, const std::string &amp;content_type)</td></tr>
<tr class="memdesc:a9d5d01b6e435c0706e1a687a3b64ad62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the file at <em>path</em> to have its contents uploaded as multipart data, available at <code>name</code> of <em>upload_file_name</em>. <a href="#a9d5d01b6e435c0706e1a687a3b64ad62">More...</a><br /></td></tr>
<tr class="separator:a9d5d01b6e435c0706e1a687a3b64ad62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a071e0642997cb00acdc966371c2d1100"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classcrashpad_1_1HTTPBodyStream.html">HTTPBodyStream</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1HTTPMultipartBuilder.html#a071e0642997cb00acdc966371c2d1100">GetBodyStream</a> ()</td></tr>
<tr class="memdesc:a071e0642997cb00acdc966371c2d1100"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates the <a class="el" href="classcrashpad_1_1HTTPBodyStream.html" title="An interface to a stream that can be used for an HTTP request body. ">HTTPBodyStream</a> for the data currently supplied to the builder. <a href="#a071e0642997cb00acdc966371c2d1100">More...</a><br /></td></tr>
<tr class="separator:a071e0642997cb00acdc966371c2d1100"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a0e52dbb229875260451cb61f5d5d8d"><td class="memItemLeft" align="right" valign="top"><a id="a0a0e52dbb229875260451cb61f5d5d8d"></a>
HTTPHeaders::value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1HTTPMultipartBuilder.html#a0a0e52dbb229875260451cb61f5d5d8d">GetContentType</a> () const</td></tr>
<tr class="memdesc:a0a0e52dbb229875260451cb61f5d5d8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the header pair for <code>"Content-Type"</code>. <br /></td></tr>
<tr class="separator:a0a0e52dbb229875260451cb61f5d5d8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is used to build a MIME multipart message, conforming to RFC 2046, for use as a HTTP request body. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a071e0642997cb00acdc966371c2d1100"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a071e0642997cb00acdc966371c2d1100">&sect;&nbsp;</a></span>GetBodyStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="classcrashpad_1_1HTTPBodyStream.html">HTTPBodyStream</a> &gt; crashpad::HTTPMultipartBuilder::GetBodyStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates the <a class="el" href="classcrashpad_1_1HTTPBodyStream.html" title="An interface to a stream that can be used for an HTTP request body. ">HTTPBodyStream</a> for the data currently supplied to the builder. </p>
<dl class="section return"><dt>Returns</dt><dd>A caller-owned <a class="el" href="classcrashpad_1_1HTTPBodyStream.html" title="An interface to a stream that can be used for an HTTP request body. ">HTTPBodyStream</a> object. </dd></dl>
</div>
</div>
<a id="a9d5d01b6e435c0706e1a687a3b64ad62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d5d01b6e435c0706e1a687a3b64ad62">&sect;&nbsp;</a></span>SetFileAttachment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void crashpad::HTTPMultipartBuilder::SetFileAttachment </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>upload_file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const base::FilePath &amp;&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>content_type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the file at <em>path</em> to have its contents uploaded as multipart data, available at <code>name</code> of <em>upload_file_name</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The key of the form data, specified as the <code>name</code> in the multipart message. Any data previously set on this class with this key will be overwritten. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">upload_file_name</td><td>The <code>filename</code> to specify for this multipart data attachment. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path of the file whose contents will be uploaded. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">content_type</td><td>The <code>Content-Type</code> to specify for the attachment. If this is empty, <code>"application/octet-stream"</code> will be used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3c51d6649d19f1e5d39b787f18dc2d06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c51d6649d19f1e5d39b787f18dc2d06">&sect;&nbsp;</a></span>SetFormData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void crashpad::HTTPMultipartBuilder::SetFormData </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a <code>Content-Disposition: form-data</code> key-value pair. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The key of the form data, specified as the <code>name</code> in the multipart message. Any data previously set on this class with this key will be overwritten. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to set at the <em>key</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>util/net/http_multipart_builder.h</li>
<li>util/net/http_multipart_builder.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink