blob: c8381a8c5d56211576d32ba1784eba08b9fae92c [file] [log] [blame]
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Proton DotNet: Apache.Qpid.Proton.Buffer.ProtonBufferOutputStream 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" />
</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">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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&amp;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="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Buffer.html">Buffer</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferOutputStream.html">ProtonBufferOutputStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferOutputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Buffer.ProtonBufferOutputStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides a write-only stream accessor of a proton buffer instance. The stream does not allow reading of the buffer that it wraps.
<a href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferOutputStream.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Buffer.ProtonBufferOutputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferOutputStream.png" alt=""/>
</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:ac05f64563e20570be612ffde4eeb3487"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferOutputStream.html#ac05f64563e20570be612ffde4eeb3487">ProtonBufferOutputStream</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr>
<tr class="memdesc:ac05f64563e20570be612ffde4eeb3487"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new stream instance that wraps the given buffer. <a href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferOutputStream.html#ac05f64563e20570be612ffde4eeb3487">More...</a><br /></td></tr>
<tr class="separator:ac05f64563e20570be612ffde4eeb3487"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb33923e8310008c8ac7e6113bf041db"><td class="memItemLeft" align="right" valign="top"><a id="abb33923e8310008c8ac7e6113bf041db"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:abb33923e8310008c8ac7e6113bf041db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2cc57323cf37134142377d2564591e7"><td class="memItemLeft" align="right" valign="top"><a id="af2cc57323cf37134142377d2564591e7"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>Close</b> ()</td></tr>
<tr class="separator:af2cc57323cf37134142377d2564591e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afafafda9432cefbad05d4bcea7a0a7d0"><td class="memItemLeft" align="right" valign="top"><a id="afafafda9432cefbad05d4bcea7a0a7d0"></a>
override int&#160;</td><td class="memItemRight" valign="bottom"><b>Read</b> (byte[] buffer, int offset, int count)</td></tr>
<tr class="separator:afafafda9432cefbad05d4bcea7a0a7d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b96bd1c77fba67b623df6e71ebcb527"><td class="memItemLeft" align="right" valign="top"><a id="a3b96bd1c77fba67b623df6e71ebcb527"></a>
override long&#160;</td><td class="memItemRight" valign="bottom"><b>Seek</b> (long offset, SeekOrigin origin)</td></tr>
<tr class="separator:a3b96bd1c77fba67b623df6e71ebcb527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8177cad73df7cd036c012f5b679c3bf3"><td class="memItemLeft" align="right" valign="top"><a id="a8177cad73df7cd036c012f5b679c3bf3"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>SetLength</b> (long value)</td></tr>
<tr class="separator:a8177cad73df7cd036c012f5b679c3bf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0b8137fa7ab405fdfa62fd127996d54"><td class="memItemLeft" align="right" valign="top"><a id="ad0b8137fa7ab405fdfa62fd127996d54"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>WriteByte</b> (byte value)</td></tr>
<tr class="separator:ad0b8137fa7ab405fdfa62fd127996d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b64479a5c45258da0e11368c1d4a3e9"><td class="memItemLeft" align="right" valign="top"><a id="a2b64479a5c45258da0e11368c1d4a3e9"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>Write</b> (byte[] buffer, int offset, int count)</td></tr>
<tr class="separator:a2b64479a5c45258da0e11368c1d4a3e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ac19e6b10b6b68dbc6f655e34bbf6dda6"><td class="memItemLeft" align="right" valign="top"><a id="ac19e6b10b6b68dbc6f655e34bbf6dda6"></a>
override bool&#160;</td><td class="memItemRight" valign="bottom"><b>CanRead</b><code> [get]</code></td></tr>
<tr class="separator:ac19e6b10b6b68dbc6f655e34bbf6dda6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b55f7fd9ddf1658735c5f40b7ce7ef4"><td class="memItemLeft" align="right" valign="top"><a id="a7b55f7fd9ddf1658735c5f40b7ce7ef4"></a>
override bool&#160;</td><td class="memItemRight" valign="bottom"><b>CanSeek</b><code> [get]</code></td></tr>
<tr class="separator:a7b55f7fd9ddf1658735c5f40b7ce7ef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad432a91f408647e1f44ddce7d7571a0d"><td class="memItemLeft" align="right" valign="top"><a id="ad432a91f408647e1f44ddce7d7571a0d"></a>
override bool&#160;</td><td class="memItemRight" valign="bottom"><b>CanWrite</b><code> [get]</code></td></tr>
<tr class="separator:ad432a91f408647e1f44ddce7d7571a0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ba1c5f3cf7eb8306c36589acce9e3f9"><td class="memItemLeft" align="right" valign="top"><a id="a4ba1c5f3cf7eb8306c36589acce9e3f9"></a>
override long&#160;</td><td class="memItemRight" valign="bottom"><b>Length</b><code> [get]</code></td></tr>
<tr class="separator:a4ba1c5f3cf7eb8306c36589acce9e3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15f86bf34dbab6da81cada3727fa81a9"><td class="memItemLeft" align="right" valign="top"><a id="a15f86bf34dbab6da81cada3727fa81a9"></a>
override long&#160;</td><td class="memItemRight" valign="bottom"><b>Position</b><code> [get, set]</code></td></tr>
<tr class="separator:a15f86bf34dbab6da81cada3727fa81a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0848898977abe0a1dbc4a1ceabb6d3c5"><td class="memItemLeft" align="right" valign="top"><a id="a0848898977abe0a1dbc4a1ceabb6d3c5"></a>
long&#160;</td><td class="memItemRight" valign="bottom"><b>BytesWritten</b><code> [get]</code></td></tr>
<tr class="separator:a0848898977abe0a1dbc4a1ceabb6d3c5"><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>Provides a write-only stream accessor of a proton buffer instance. The stream does not allow reading of the buffer that it wraps. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac05f64563e20570be612ffde4eeb3487"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac05f64563e20570be612ffde4eeb3487">&#9670;&nbsp;</a></span>ProtonBufferOutputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Buffer.ProtonBufferOutputStream.ProtonBufferOutputStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a>&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new stream instance that wraps the given buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Buffer/ProtonBufferOutputStream.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>