3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-22 20:03:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
crashpad/doc/generated/doxygen/classcrashpad_1_1HTTPBodyStream.html

159 lines
7.7 KiB
HTML
Raw Normal View History

Check in generated documentation
2015-10-08 14:55:01 -04:00
<!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"/>
Update documentation to master 8e3e65178a1d
2016-11-07 15:21:37 -05:00
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
Check in generated documentation
2015-10-08 14:55:01 -04:00
<title>Crashpad: crashpad::HTTPBodyStream 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" />
Update documentation to master f191fff64dd3
2016-11-08 14:26:59 -05:00
<link href="crashpad_doxygen.css" rel="stylesheet" type="text/css"/>
Check in generated documentation
2015-10-08 14:55:01 -04:00
</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;">
Update documentation to master 330adfb02984
2016-01-06 16:09:15 -05:00
<td id="projectalign" style="padding-left: 0.5em;">
Check in generated documentation
2015-10-08 14:55:01 -04:00
<div id="projectname">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
Update documentation to master 8e3e65178a1d
2016-11-07 15:21:37 -05:00
<!-- Generated by Doxygen 1.8.12 -->
Check in generated documentation
2015-10-08 14:55:01 -04:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
Update documentation to master 8e3e65178a1d
2016-11-07 15:21:37 -05:00
<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>
Check in generated documentation
2015-10-08 14:55:01 -04:00
<!-- 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_1HTTPBodyStream.html">HTTPBodyStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1HTTPBodyStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::HTTPBodyStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>An interface to a stream that can be used for an HTTP request body.
<a href="classcrashpad_1_1HTTPBodyStream.html#details">More...</a></p>
<p><code>#include &quot;util/net/http_body.h&quot;</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::HTTPBodyStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1HTTPBodyStream.png" usemap="#crashpad::HTTPBodyStream_map" alt=""/>
<map id="crashpad::HTTPBodyStream_map" name="crashpad::HTTPBodyStream_map">
<area href="classcrashpad_1_1CompositeHTTPBodyStream.html" title="An implementation of HTTPBodyStream that combines an array of several other HTTPBodyStream objects in..." alt="crashpad::CompositeHTTPBodyStream" shape="rect" coords="0,56,228,80"/>
<area href="classcrashpad_1_1FileHTTPBodyStream.html" title="An implementation of HTTPBodyStream that reads from the specified file and provides its contents for ..." alt="crashpad::FileHTTPBodyStream" shape="rect" coords="238,56,466,80"/>
<area href="classcrashpad_1_1StringHTTPBodyStream.html" title="An implementation of HTTPBodyStream that turns a fixed string into a stream. " alt="crashpad::StringHTTPBodyStream" shape="rect" coords="476,56,704,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
Update documentation to master ad9887ee0dc0
2015-10-28 16:54:59 -04:00
<tr class="memitem:aa6a460e23c34ff7b2edc056a5ffd11b2"><td class="memItemLeft" align="right" valign="top">virtual FileOperationResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1HTTPBodyStream.html#aa6a460e23c34ff7b2edc056a5ffd11b2">GetBytesBuffer</a> (uint8_t *buffer, size_t max_len)=0</td></tr>
<tr class="memdesc:aa6a460e23c34ff7b2edc056a5ffd11b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies up to <em>max_len</em> bytes into the user-supplied buffer. <a href="#aa6a460e23c34ff7b2edc056a5ffd11b2">More...</a><br /></td></tr>
<tr class="separator:aa6a460e23c34ff7b2edc056a5ffd11b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
Check in generated documentation
2015-10-08 14:55:01 -04:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An interface to a stream that can be used for an HTTP request body. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
Update documentation to master 8e3e65178a1d
2016-11-07 15:21:37 -05:00
<a id="aa6a460e23c34ff7b2edc056a5ffd11b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6a460e23c34ff7b2edc056a5ffd11b2">&sect;&nbsp;</a></span>GetBytesBuffer()</h2>
Check in generated documentation
2015-10-08 14:55:01 -04:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
Update documentation to master ad9887ee0dc0
2015-10-28 16:54:59 -04:00
<td class="memname">virtual FileOperationResult crashpad::HTTPBodyStream::GetBytesBuffer </td>
Check in generated documentation
2015-10-08 14:55:01 -04:00
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>max_len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies up to <em>max_len</em> bytes into the user-supplied buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>A user-supplied buffer into which this method will copy bytes from the stream. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>The length (or size) of <em>buffer</em>. At most this many bytes will be copied.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, a positive number indicating the number of bytes actually copied to <em>buffer</em>. On failure, a negative number. When the stream has no more data, returns <code>0</code>. </dd></dl>
Update documentation to master ad9887ee0dc0
2015-10-28 16:54:59 -04:00
<p>Implemented in <a class="el" href="classcrashpad_1_1CompositeHTTPBodyStream.html#a66355480dd05beba77261f0a512d3e70">crashpad::CompositeHTTPBodyStream</a>, <a class="el" href="classcrashpad_1_1FileHTTPBodyStream.html#a0495ba46a1dcdaedaf525d340972d771">crashpad::FileHTTPBodyStream</a>, and <a class="el" href="classcrashpad_1_1StringHTTPBodyStream.html#afa56035c89a4cfcc0e028c8c1838a56d">crashpad::StringHTTPBodyStream</a>.</p>
Check in generated documentation
2015-10-08 14:55:01 -04:00
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>util/net/http_body.h</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"/>
Update documentation to master 8e3e65178a1d
2016-11-07 15:21:37 -05:00
</a> 1.8.12
Check in generated documentation
2015-10-08 14:55:01 -04:00
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink