Google Git
Sign in
apache / qpid-site / 6ff9200909f263aba9647dce8586a54ad06f4609 / . / input / releases / qpid-proton-dotnet-1.0.0-M4 / api / interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html
blob: 5b27a45e2f4107712356f58a272847b02bc0e929 [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.IReadableComponent Interface 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="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html">IReadableComponent</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Buffer.IReadableComponent Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides a view of an individual component of a proton buffer during a call to the readable buffer processing methods.
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Buffer.IReadableComponent:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.png" usemap="#Apache.Qpid.Proton.Buffer.IReadableComponent_map" alt=""/>
<map id="Apache.Qpid.Proton.Buffer.IReadableComponent_map" name="Apache.Qpid.Proton.Buffer.IReadableComponent_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Buffer_1_1ProtonByteBuffer.html" title="A proton buffer implementation that wraps a single heap allocated byte array and provides read and wr..." alt="Apache.Qpid.Proton.Buffer.ProtonByteBuffer" shape="rect" coords="0,56,290,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a7e4fa735079934185a392fb6d4a36fa3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#a7e4fa735079934185a392fb6d4a36fa3">HasReadableArray</a><code> [get]</code></td></tr>
<tr class="memdesc:a7e4fa735079934185a392fb6d4a36fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the component is back by a byte array that has readable bytes. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#a7e4fa735079934185a392fb6d4a36fa3">More...</a><br /></td></tr>
<tr class="separator:a7e4fa735079934185a392fb6d4a36fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05cc42d261f43cf22a8c88d4a72dfc1c"><td class="memItemLeft" align="right" valign="top">byte[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#a05cc42d261f43cf22a8c88d4a72dfc1c">ReadableArray</a><code> [get]</code></td></tr>
<tr class="memdesc:a05cc42d261f43cf22a8c88d4a72dfc1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the readable array that backs this component if one exists otherwise throw an invalid operation exception to indicate that there is no readable byte array. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#a05cc42d261f43cf22a8c88d4a72dfc1c">More...</a><br /></td></tr>
<tr class="separator:a05cc42d261f43cf22a8c88d4a72dfc1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6b86d98d87534ac5b2964130aefe925"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#ae6b86d98d87534ac5b2964130aefe925">ReadableArrayOffset</a><code> [get]</code></td></tr>
<tr class="memdesc:ae6b86d98d87534ac5b2964130aefe925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the offset into the readable backing array if one exists otherwise throws an invalid operation exception to indicate that there is no readable byte array. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#ae6b86d98d87534ac5b2964130aefe925">More...</a><br /></td></tr>
<tr class="separator:ae6b86d98d87534ac5b2964130aefe925"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7bf6e809b2dd557e3b4b12e157e5fb5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#af7bf6e809b2dd557e3b4b12e157e5fb5">ReadableArrayLength</a><code> [get]</code></td></tr>
<tr class="memdesc:af7bf6e809b2dd557e3b4b12e157e5fb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the usable length of the readable backing array if one exists otherwise throws an invalid operation exception to indicate that there is no readable byte array. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IReadableComponent.html#af7bf6e809b2dd557e3b4b12e157e5fb5">More...</a><br /></td></tr>
<tr class="separator:af7bf6e809b2dd557e3b4b12e157e5fb5"><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 view of an individual component of a proton buffer during a call to the readable buffer processing methods. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="a7e4fa735079934185a392fb6d4a36fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e4fa735079934185a392fb6d4a36fa3">&#9670;&nbsp;</a></span>HasReadableArray</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Buffer.IReadableComponent.HasReadableArray</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the component is back by a byte array that has readable bytes. </p>
</div>
</div>
<a id="a05cc42d261f43cf22a8c88d4a72dfc1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05cc42d261f43cf22a8c88d4a72dfc1c">&#9670;&nbsp;</a></span>ReadableArray</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte [] Apache.Qpid.Proton.Buffer.IReadableComponent.ReadableArray</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the readable array that backs this component if one exists otherwise throw an invalid operation exception to indicate that there is no readable byte array. </p>
<p>If a byte array is returned from this method it should never be used to make modifications to the proton buffer data. </p>
</div>
</div>
<a id="af7bf6e809b2dd557e3b4b12e157e5fb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7bf6e809b2dd557e3b4b12e157e5fb5">&#9670;&nbsp;</a></span>ReadableArrayLength</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Buffer.IReadableComponent.ReadableArrayLength</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the usable length of the readable backing array if one exists otherwise throws an invalid operation exception to indicate that there is no readable byte array. </p>
</div>
</div>
<a id="ae6b86d98d87534ac5b2964130aefe925"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6b86d98d87534ac5b2964130aefe925">&#9670;&nbsp;</a></span>ReadableArrayOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Buffer.IReadableComponent.ReadableArrayOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the offset into the readable backing array if one exists otherwise throws an invalid operation exception to indicate that there is no readable byte array. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Buffer/IReadableComponent.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>