blob: 289d6738a7428963b3ca27180c7c4af384ed9181 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.qpid.protonj2.buffer.ProtonBufferComponent (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.qpid.protonj2.buffer, interface: ProtonBufferComponent">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript"></script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">Class</a></li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Interface org.apache.qpid.protonj2.buffer.ProtonBufferComponent" class="title">Uses of Interface<br>org.apache.qpid.protonj2.buffer.ProtonBufferComponent</h1>
</div>
<div class="caption"><span>Packages that use <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.buffer">org.apache.qpid.protonj2.buffer</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.buffer.impl">org.apache.qpid.protonj2.buffer.impl</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.buffer.netty">org.apache.qpid.protonj2.buffer.netty</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.qpid.protonj2.buffer">
<h2>Uses of <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.buffer</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.buffer</a> that return <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponent.</span><code><a href="../ProtonBufferComponent.html#advanceReadOffset(int)" class="member-name-link">advanceReadOffset</a><wbr>(int&nbsp;amount)</code></div>
<div class="col-last even-row-color">
<div class="block">Advances the internally maintained read offset for this component by the
given amount.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponent.</span><code><a href="../ProtonBufferComponent.html#advanceWriteOffset(int)" class="member-name-link">advanceWriteOffset</a><wbr>(int&nbsp;amount)</code></div>
<div class="col-last odd-row-color">
<div class="block">Advances the internally maintained write offset for this component by the
given amount.</div>
</div>
<div class="col-first even-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Returns the first component that this access object provides which resets the
iteration state to the beginning.</div>
</div>
<div class="col-first odd-row-color"><code>default <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#firstReadable()" class="member-name-link">firstReadable</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns the first readable component that this access object provides which resets the
iteration state to the beginning.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#firstWritable()" class="member-name-link">firstWritable</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Returns the first writable component that this access object provides which resets the
iteration state to the beginning.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#next()" class="member-name-link">next</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Returns the next component that this access object provides which can be null if either
the first method has never been called or the access of components has reached the end
of the chain of buffer components that this access object is assigned to.</div>
</div>
<div class="col-first even-row-color"><code>default <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#nextReadable()" class="member-name-link">nextReadable</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>default <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#nextWritable()" class="member-name-link">nextWritable</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.buffer</a> that return types with arguments of type <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#componentIterator()" class="member-name-link">componentIterator</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#components()" class="member-name-link">components</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#readableComponentIterator()" class="member-name-link">readableComponentIterator</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#readableComponents()" class="member-name-link">readableComponents</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#writableComponentIterator()" class="member-name-link">writableComponentIterator</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonBufferComponentAccessor.</span><code><a href="../ProtonBufferComponentAccessor.html#writableComponents()" class="member-name-link">writableComponents</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.buffer.impl">
<h2>Uses of <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a> in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.buffer.impl</a></h2>
<div class="caption"><span>Classes in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.buffer.impl</a> that implement <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/ProtonByteArrayBuffer.html" class="type-name-link" title="class in org.apache.qpid.protonj2.buffer.impl">ProtonByteArrayBuffer</a></code></div>
<div class="col-last even-row-color">
<div class="block">An array based buffer implementation.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.buffer.impl</a> that return <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonByteArrayBuffer.</span><code><a href="../impl/ProtonByteArrayBuffer.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonByteArrayBuffer.</span><code><a href="../impl/ProtonByteArrayBuffer.html#next()" class="member-name-link">next</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.buffer.netty">
<h2>Uses of <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a> in <a href="../netty/package-summary.html">org.apache.qpid.protonj2.buffer.netty</a></h2>
<div class="caption"><span>Classes in <a href="../netty/package-summary.html">org.apache.qpid.protonj2.buffer.netty</a> that implement <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../netty/Netty4ToProtonBufferAdapter.html" class="type-name-link" title="class in org.apache.qpid.protonj2.buffer.netty">Netty4ToProtonBufferAdapter</a></code></div>
<div class="col-last even-row-color">
<div class="block">Wrapper class for Netty 4 ByteBuf instances which provides a generic way
for proton to interact with Netty 4 buffers.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../netty/Netty5ToProtonBufferAdapter.html" class="type-name-link" title="class in org.apache.qpid.protonj2.buffer.netty">Netty5ToProtonBufferAdapter</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Wrapper class for Netty 5 Buffer instances which provides a generic way
for proton to interact with Netty 4 buffers.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../netty/package-summary.html">org.apache.qpid.protonj2.buffer.netty</a> that return <a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Netty4ToProtonBufferAdapter.</span><code><a href="../netty/Netty4ToProtonBufferAdapter.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Netty5ToProtonBufferAdapter.</span><code><a href="../netty/Netty5ToProtonBufferAdapter.html#first()" class="member-name-link">first</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Netty4ToProtonBufferAdapter.</span><code><a href="../netty/Netty4ToProtonBufferAdapter.html#next()" class="member-name-link">next</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Netty5ToProtonBufferAdapter.</span><code><a href="../netty/Netty5ToProtonBufferAdapter.html#next()" class="member-name-link">next</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>