blob: ea60aa306e0e9bab79afa17eb81a5f3d8b6efb67 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.arrow.vector.ipc.message (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.arrow.vector.ipc.message (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/arrow/vector/ipc/jmh_generated/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/arrow/vector/ipc/message/jmh_generated/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/vector/ipc/message/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.arrow.vector.ipc.message</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></td>
<td class="colLast">
<div class="block">Interface for Arrow IPC messages (https://arrow.apache.org/docs/format/IPC.html).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.ArrowMessageVisitor.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage.ArrowMessageVisitor</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Visitor interface for implementations of <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message"><code>ArrowMessage</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializable.html" title="interface in org.apache.arrow.vector.ipc.message">FBSerializable</a></td>
<td class="colLast">
<div class="block">Interface for serializing to FlatBuffers.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></td>
<td class="colLast">
<div class="block">Metadata for an arrow message in a channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBodyCompression.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBodyCompression</a></td>
<td class="colLast">
<div class="block">Compression information about data written to a channel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBuffer.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBuffer</a></td>
<td class="colLast">
<div class="block">Metadata for a buffer written to a channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a></td>
<td class="colLast">
<div class="block">POJO wrapper around a Dictionary Batch IPC messages
(https://arrow.apache.org/docs/format/IPC.html#dictionary-batches)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowFieldNode.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFieldNode</a></td>
<td class="colLast">
<div class="block">Metadata about Vectors/Arrays that is written to a channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowFooter.html" title="class in org.apache.arrow.vector.ipc.message">ArrowFooter</a></td>
<td class="colLast">
<div class="block">Footer metadata for the arrow file format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></td>
<td class="colLast">
<div class="block">POJO representation of a RecordBatch IPC message (https://arrow.apache.org/docs/format/Columnar.html#recordbatch-message).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatchBenchmarks.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatchBenchmarks</a></td>
<td class="colLast">
<div class="block">Benchmarks for <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message"><code>ArrowRecordBatch</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializables.html" title="class in org.apache.arrow.vector.ipc.message">FBSerializables</a></td>
<td class="colLast">
<div class="block">Utility methods for <a href="../../../../../../org/apache/arrow/vector/ipc/message/FBSerializable.html" title="interface in org.apache.arrow.vector.ipc.message">FBSerializable</a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a></td>
<td class="colLast">
<div class="block">IPC options, now only use for write.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageChannelReader.html" title="class in org.apache.arrow.vector.ipc.message">MessageChannelReader</a></td>
<td class="colLast">
<div class="block">Reads a sequence of messages using a ReadChannel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a></td>
<td class="colLast">
<div class="block">Class to hold resulting Message metadata and buffer containing the serialized Flatbuffer
message when reading messages from a ReadChannel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageResult</a></td>
<td class="colLast">
<div class="block">Class to hold the Message metadata and body data when reading messages through a
MessageChannelReader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html" title="class in org.apache.arrow.vector.ipc.message">MessageSerializer</a></td>
<td class="colLast">
<div class="block">Utility class for serializing Messages.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">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="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/arrow/vector/ipc/jmh_generated/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/arrow/vector/ipc/message/jmh_generated/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/vector/ipc/message/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>