blob: 9c26fd0ae8d19fbad9cd07fac8221b6d5945aa15 [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.ProtonBufferInputStream 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_1ProtonBufferInputStream.html">ProtonBufferInputStream</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_1ProtonBufferInputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Buffer.ProtonBufferInputStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides a read-only stream view of a proton buffer instance. The stream allows seeking within the readable bytes portion of the provided buffer but does not allow altering the readable length or writing to the buffer.
<a href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferInputStream.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Buffer.ProtonBufferInputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonBufferInputStream.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:a059e387a4d82471c7964a2a07e710598"><td class="memItemLeft" align="right" valign="top"><a id="a059e387a4d82471c7964a2a07e710598"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ProtonBufferInputStream</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer)</td></tr>
<tr class="separator:a059e387a4d82471c7964a2a07e710598"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac534a905cb8756953d26adcf6adf9cbb"><td class="memItemLeft" align="right" valign="top"><a id="ac534a905cb8756953d26adcf6adf9cbb"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>Close</b> ()</td></tr>
<tr class="separator:ac534a905cb8756953d26adcf6adf9cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14e9610d8171eaa8cb68ddd7f01bfcda"><td class="memItemLeft" align="right" valign="top"><a id="a14e9610d8171eaa8cb68ddd7f01bfcda"></a>
override int&#160;</td><td class="memItemRight" valign="bottom"><b>ReadByte</b> ()</td></tr>
<tr class="separator:a14e9610d8171eaa8cb68ddd7f01bfcda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a003372f6182a8a395f1c80c221abffae"><td class="memItemLeft" align="right" valign="top"><a id="a003372f6182a8a395f1c80c221abffae"></a>
override int&#160;</td><td class="memItemRight" valign="bottom"><b>Read</b> (byte[] destination, int offset, int count)</td></tr>
<tr class="separator:a003372f6182a8a395f1c80c221abffae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a651db65df78193876d581529f5d02c45"><td class="memItemLeft" align="right" valign="top"><a id="a651db65df78193876d581529f5d02c45"></a>
override long&#160;</td><td class="memItemRight" valign="bottom"><b>Seek</b> (long offset, SeekOrigin origin)</td></tr>
<tr class="separator:a651db65df78193876d581529f5d02c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49f4a2e0a5343db7c4beddba71b78a76"><td class="memItemLeft" align="right" valign="top"><a id="a49f4a2e0a5343db7c4beddba71b78a76"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>SetLength</b> (long value)</td></tr>
<tr class="separator:a49f4a2e0a5343db7c4beddba71b78a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73d9f86a9324a433ac306ab5e7a436ea"><td class="memItemLeft" align="right" valign="top"><a id="a73d9f86a9324a433ac306ab5e7a436ea"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>Write</b> (byte[] buffer, int offset, int count)</td></tr>
<tr class="separator:a73d9f86a9324a433ac306ab5e7a436ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1ea669ad1b32ac0e7c3187a6baafade"><td class="memItemLeft" align="right" valign="top"><a id="aa1ea669ad1b32ac0e7c3187a6baafade"></a>
override void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:aa1ea669ad1b32ac0e7c3187a6baafade"><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:a2ea8ccf5c276d687418a6287600940b6"><td class="memItemLeft" align="right" valign="top"><a id="a2ea8ccf5c276d687418a6287600940b6"></a>
long&#160;</td><td class="memItemRight" valign="bottom"><b>BytesRead</b><code> [get]</code></td></tr>
<tr class="separator:a2ea8ccf5c276d687418a6287600940b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a826a6f93106f036c3dd0443196f29149"><td class="memItemLeft" align="right" valign="top"><a id="a826a6f93106f036c3dd0443196f29149"></a>
override bool&#160;</td><td class="memItemRight" valign="bottom"><b>CanRead</b><code> [get]</code></td></tr>
<tr class="separator:a826a6f93106f036c3dd0443196f29149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aeb8c7ce9beef92c1df448be5e7b5e8"><td class="memItemLeft" align="right" valign="top"><a id="a2aeb8c7ce9beef92c1df448be5e7b5e8"></a>
override bool&#160;</td><td class="memItemRight" valign="bottom"><b>CanSeek</b><code> [get]</code></td></tr>
<tr class="separator:a2aeb8c7ce9beef92c1df448be5e7b5e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3655018a3f1378a3187876c4505dfc4d"><td class="memItemLeft" align="right" valign="top"><a id="a3655018a3f1378a3187876c4505dfc4d"></a>
override bool&#160;</td><td class="memItemRight" valign="bottom"><b>CanWrite</b><code> [get]</code></td></tr>
<tr class="separator:a3655018a3f1378a3187876c4505dfc4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a211f4a63c4b5b4da51de0b653ba62cb5"><td class="memItemLeft" align="right" valign="top"><a id="a211f4a63c4b5b4da51de0b653ba62cb5"></a>
override long&#160;</td><td class="memItemRight" valign="bottom"><b>Length</b><code> [get]</code></td></tr>
<tr class="separator:a211f4a63c4b5b4da51de0b653ba62cb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71a31ada8843bda19753f40985dd7743"><td class="memItemLeft" align="right" valign="top"><a id="a71a31ada8843bda19753f40985dd7743"></a>
override long&#160;</td><td class="memItemRight" valign="bottom"><b>Position</b><code> [get, set]</code></td></tr>
<tr class="separator:a71a31ada8843bda19753f40985dd7743"><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 read-only stream view of a proton buffer instance. The stream allows seeking within the readable bytes portion of the provided buffer but does not allow altering the readable length or writing to the buffer. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Buffer/ProtonBufferInputStream.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>