| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <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" /> |
| <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.18 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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_1HTTPBodyStream.html">HTTPBodyStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <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 "util/net/http_body.h"</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,232,80"/> |
| <area href="classcrashpad_1_1FileReaderHTTPBodyStream.html" title="An implementation of HTTPBodyStream that reads from a FileReaderInterface and provides its contents f..." alt="crashpad::FileReaderHTTPBodyStream" shape="rect" coords="242,56,474,80"/> |
| <area href="classcrashpad_1_1GzipHTTPBodyStream.html" title="An implementation of HTTPBodyStream that gzip-compresses another HTTPBodyStream." alt="crashpad::GzipHTTPBodyStream" shape="rect" coords="484,56,716,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="726,56,958,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> |
| <tr class="memitem:aa6a460e23c34ff7b2edc056a5ffd11b2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacecrashpad.html#a25465a3a2d289a06addf93c346c6f917">FileOperationResult</a> </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"> </td><td class="mdescRight">Copies up to <em>max_len</em> bytes into the user-supplied buffer. <a href="classcrashpad_1_1HTTPBodyStream.html#aa6a460e23c34ff7b2edc056a5ffd11b2">More...</a><br /></td></tr> |
| <tr class="separator:aa6a460e23c34ff7b2edc056a5ffd11b2"><td class="memSeparator" colspan="2"> </td></tr> |
| </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> |
| <a id="aa6a460e23c34ff7b2edc056a5ffd11b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6a460e23c34ff7b2edc056a5ffd11b2">◆ </a></span>GetBytesBuffer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespacecrashpad.html#a25465a3a2d289a06addf93c346c6f917">FileOperationResult</a> crashpad::HTTPBodyStream::GetBytesBuffer </td> |
| <td>(</td> |
| <td class="paramtype">uint8_t * </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>max_len</em> </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> |
| |
| <p>Implemented in <a class="el" href="classcrashpad_1_1CompositeHTTPBodyStream.html#a66355480dd05beba77261f0a512d3e70">crashpad::CompositeHTTPBodyStream</a>, <a class="el" href="classcrashpad_1_1FileReaderHTTPBodyStream.html#ad17733883c6bcb8858ac84fdaa13c968">crashpad::FileReaderHTTPBodyStream</a>, <a class="el" href="classcrashpad_1_1StringHTTPBodyStream.html#afa56035c89a4cfcc0e028c8c1838a56d">crashpad::StringHTTPBodyStream</a>, and <a class="el" href="classcrashpad_1_1GzipHTTPBodyStream.html#a470d17ec47dde6bae9bc11c60d291b55">crashpad::GzipHTTPBodyStream</a>.</p> |
| |
| </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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.18 |
| </small></address> |
| </body> |
| </html> |