| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.qpid.protonj2.buffer (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="declaration: package: org.apache.qpid.protonj2.buffer"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li>Description | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| </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="Package org.apache.qpid.protonj2.buffer" class="title">Package org.apache.qpid.protonj2.buffer</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.qpid.protonj2.buffer</span></div> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</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="impl/package-summary.html">org.apache.qpid.protonj2.buffer.impl</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="netty/package-summary.html">org.apache.qpid.protonj2.buffer.netty</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Buffer type abstraction used to provide users of the proton library with |
| a means of using their own type of byte buffer types in combination with the |
| library tooling.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ProtonBufferAccessors.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAccessors</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for any buffer access implementation which provides consistent read |
| and write APIs for primitive values.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for a ProtonBuffer allocator object that can be used by Proton |
| objects to create memory buffers using the preferred type of the application |
| or library that embeds the Proton engine.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="ProtonBufferClosedException.html" title="class in org.apache.qpid.protonj2.buffer">ProtonBufferClosedException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Proton Buffer related error that indicates that the buffer is closed |
| and cannot be accessed for any further buffer operations.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ProtonBufferComponent.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A buffer component represents a single component of the memory backing |
| a <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> which could be a buffer that inherently made up of more |
| than one section of memory or it could be a intentional composite buffer |
| that collect individual buffers each with their own component backing.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ProtonBufferComponentAccessor.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferComponentAccessor</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Provides a way of accessing the internal components of a <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> |
| which can be used to gain access to underlying buffer internals for IO or other |
| low level buffer operations.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ProtonBufferInputStream.html" title="class in org.apache.qpid.protonj2.buffer">ProtonBufferInputStream</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An InputStream that can be used to adapt a <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> for use in the |
| standard streams API.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ProtonBufferIterator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferIterator</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">An <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"><code>Iterator</code></a> like API for accessing the underlying bytes of the |
| target buffer one at a time.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ProtonBufferIterator.ByteConsumer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferIterator.ByteConsumer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Functional interface for defining standard or commonly used consumers of the |
| bytes provided by a <a href="ProtonBufferIterator.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBufferIterator</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ProtonBufferOutputStream.html" title="class in org.apache.qpid.protonj2.buffer">ProtonBufferOutputStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> specialized <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link"><code>OutputStream</code></a> implementation which can be used to adapt |
| the proton buffer types into code that uses the streams API.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="ProtonBufferReadOnlyException.html" title="class in org.apache.qpid.protonj2.buffer">ProtonBufferReadOnlyException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">Proton Buffer related error that indicates that the buffer is read-only |
| and cannot be accessed for any further buffer write operations.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ProtonBufferUtils.html" title="class in org.apache.qpid.protonj2.buffer">ProtonBufferUtils</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Set of Utility methods useful when dealing with byte arrays and other |
| primitive types.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ProtonCompositeBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonCompositeBuffer</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Defines the API for a specialized buffer type that is a composite of |
| other buffer instances which is presented as a single buffer view.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
