Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / vector / ipc / message / MessageSerializer.html
blob: 4adeb1f37c01ab309ecc365c191b39b894c2d3e2 [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>MessageSerializer (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="MessageSerializer (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":41,"i26":9,"i27":41,"i28":9,"i29":41,"i30":9,"i31":9,"i32":9,"i33":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MessageSerializer.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/message/MessageResult.html" title="class in org.apache.arrow.vector.ipc.message"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/vector/ipc/message/MessageSerializer.html" target="_top">Frames</a></li>
<li><a href="MessageSerializer.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.arrow.vector.ipc.message</div>
<h2 title="Class MessageSerializer" class="title">Class MessageSerializer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.vector.ipc.message.MessageSerializer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">MessageSerializer</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utility class for serializing Messages. Messages are all serialized a similar way.
1. 4 byte little endian message header prefix
2. FB serialized Message: This includes it the body length, which is the serialized
body and the type of the message.
3. Serialized message.
<p>For schema messages, the serialization is simply the FB serialized Schema.
<p>For RecordBatch messages the serialization is:
1. 4 byte little endian batch metadata header
2. FB serialized RowBatch
3. Padding to align to 8 byte boundary.
4. serialized RowBatch buffers.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#IPC_CONTINUATION_TOKEN">IPC_CONTINUATION_TOKEN</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#MessageSerializer--">MessageSerializer</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#bytesToInt-byte:A-">bytesToInt</a></span>(byte[]&nbsp;bytes)</code>
<div class="block">Convert an array of 4 bytes in little-endian to an native-endian i32 value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeDictionaryBatch-org.apache.arrow.flatbuf.Message-org.apache.arrow.memory.ArrowBuf-">deserializeDictionaryBatch</a></span>(<a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf">Message</a>&nbsp;message,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;bodyBuffer)</code>
<div class="block">Deserializes an ArrowDictionaryBatch from a dictionary batch Message and data in an ArrowBuf.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeDictionaryBatch-org.apache.arrow.vector.ipc.message.MessageMetadataResult-org.apache.arrow.memory.ArrowBuf-">deserializeDictionaryBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;message,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;bodyBuffer)</code>
<div class="block">Deserializes an ArrowDictionaryBatch from a dictionary batch Message and data in an ArrowBuf.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeDictionaryBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.vector.ipc.message.ArrowBlock-org.apache.arrow.memory.BufferAllocator-">deserializeDictionaryBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;block,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;alloc)</code>
<div class="block">Deserializes a DictionaryBatch knowing the size of the entire message up front.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeDictionaryBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.memory.BufferAllocator-">deserializeDictionaryBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">Deserializes an ArrowDictionaryBatch read from the input channel.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeMessageBatch-org.apache.arrow.vector.ipc.message.MessageChannelReader-">deserializeMessageBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageChannelReader.html" title="class in org.apache.arrow.vector.ipc.message">MessageChannelReader</a>&nbsp;reader)</code>
<div class="block">Deserialize a message that is either an ArrowDictionaryBatch or ArrowRecordBatch.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeMessageBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.memory.BufferAllocator-">deserializeMessageBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;alloc)</code>
<div class="block">Deserialize a message that is either an ArrowDictionaryBatch or ArrowRecordBatch.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeRecordBatch-org.apache.arrow.flatbuf.Message-org.apache.arrow.memory.ArrowBuf-">deserializeRecordBatch</a></span>(<a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf">Message</a>&nbsp;recordBatchMessage,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;bodyBuffer)</code>
<div class="block">Deserializes an ArrowRecordBatch from a record batch message and data in an ArrowBuf.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeRecordBatch-org.apache.arrow.vector.ipc.message.MessageMetadataResult-org.apache.arrow.memory.ArrowBuf-">deserializeRecordBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;serializedMessage,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;underlying)</code>
<div class="block">Reads a record batch based on the metadata in serializedMessage and the underlying data buffer.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeRecordBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.vector.ipc.message.ArrowBlock-org.apache.arrow.memory.BufferAllocator-">deserializeRecordBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;block,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;alloc)</code>
<div class="block">Deserializes an ArrowRecordBatch knowing the size of the entire message up front.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeRecordBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.memory.BufferAllocator-">deserializeRecordBatch</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">Deserializes an ArrowRecordBatch read from the input channel.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeRecordBatch-org.apache.arrow.flatbuf.RecordBatch-org.apache.arrow.memory.ArrowBuf-">deserializeRecordBatch</a></span>(<a href="../../../../../../org/apache/arrow/flatbuf/RecordBatch.html" title="class in org.apache.arrow.flatbuf">RecordBatch</a>&nbsp;recordBatchFB,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;body)</code>
<div class="block">Deserializes an ArrowRecordBatch given the Flatbuffer metadata and in-memory body.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeSchema-org.apache.arrow.flatbuf.Message-">deserializeSchema</a></span>(<a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf">Message</a>&nbsp;schemaMessage)</code>
<div class="block">Deserializes an Arrow Schema object from a schema message.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeSchema-org.apache.arrow.vector.ipc.message.MessageMetadataResult-">deserializeSchema</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;message)</code>
<div class="block">Deserializes an Arrow Schema object from a <a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message"><code>MessageMetadataResult</code></a>.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#deserializeSchema-org.apache.arrow.vector.ipc.ReadChannel-">deserializeSchema</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in)</code>
<div class="block">Deserializes an Arrow Schema read from the input channel.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#intToBytes-int-byte:A-">intToBytes</a></span>(int&nbsp;value,
byte[]&nbsp;bytes)</code>
<div class="block">Convert an integer to a little endian 4 byte array.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#longToBytes-long-byte:A-">longToBytes</a></span>(long&nbsp;value,
byte[]&nbsp;bytes)</code>
<div class="block">Convert a long to a little-endian 8 byte array.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#readMessage-org.apache.arrow.vector.ipc.ReadChannel-">readMessage</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in)</code>
<div class="block">Read a Message from the input channel and return a MessageMetadataResult that contains the
Message metadata, buffer containing the serialized Message metadata as read, and length of the
Message in bytes.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#readMessageBody-org.apache.arrow.vector.ipc.ReadChannel-long-org.apache.arrow.memory.BufferAllocator-">readMessageBody</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
long&nbsp;bodyLength,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>
<div class="block">Read a Message body from the in channel into an ArrowBuf.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowDictionaryBatch-">serialize</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;batch)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowDictionaryBatch-org.apache.arrow.vector.ipc.message.IpcOption-">serialize</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;batch,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Serializes a dictionary ArrowRecordBatch.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-">serialize</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch)</code>
<div class="block">Serializes an ArrowRecordBatch.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-org.apache.arrow.vector.ipc.message.IpcOption-">serialize</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Serializes an ArrowRecordBatch.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.types.pojo.Schema-">serialize</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema)</code>
<div class="block">Serialize a schema object.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">serialize</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Serialize a schema object.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMessage-com.google.flatbuffers.FlatBufferBuilder-byte-int-long-">serializeMessage</a></span>(com.google.flatbuffers.FlatBufferBuilder&nbsp;builder,
byte&nbsp;headerType,
int&nbsp;headerOffset,
long&nbsp;bodyLength)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMessage-com.google.flatbuffers.FlatBufferBuilder-byte-int-long-org.apache.arrow.vector.ipc.message.IpcOption-">serializeMessage</a></span>(com.google.flatbuffers.FlatBufferBuilder&nbsp;builder,
byte&nbsp;headerType,
int&nbsp;headerOffset,
long&nbsp;bodyLength,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</code>
<div class="block">Serializes a message header.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMetadata-org.apache.arrow.vector.ipc.message.ArrowMessage-">serializeMetadata</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;message)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMetadata-org.apache.arrow.vector.ipc.message.ArrowMessage-org.apache.arrow.vector.ipc.message.IpcOption-">serializeMetadata</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;message,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</code>
<div class="block">Returns the serialized form of <a href="../../../../../../org/apache/arrow/flatbuf/RecordBatch.html" title="class in org.apache.arrow.flatbuf"><code>RecordBatch</code></a> wrapped in a <a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf"><code>Message</code></a>.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMetadata-org.apache.arrow.vector.types.pojo.Schema-">serializeMetadata</a></span>(<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#serializeMetadata-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">serializeMetadata</a></span>(<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</code>
<div class="block">Returns the serialized flatbuffer bytes of the schema wrapped in a message table.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#writeBatchBuffers-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-">writeBatchBuffers</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch)</code>
<div class="block">Write the Arrow buffers of the record batch to the output channel.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#writeMessageBuffer-org.apache.arrow.vector.ipc.WriteChannel-int-java.nio.ByteBuffer-">writeMessageBuffer</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
int&nbsp;messageLength,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;messageBuffer)</code>&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageSerializer.html#writeMessageBuffer-org.apache.arrow.vector.ipc.WriteChannel-int-java.nio.ByteBuffer-org.apache.arrow.vector.ipc.message.IpcOption-">writeMessageBuffer</a></span>(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
int&nbsp;messageLength,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;messageBuffer,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)</code>
<div class="block">Write the serialized Message metadata, prefixed by the length, to the output Channel.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="IPC_CONTINUATION_TOKEN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IPC_CONTINUATION_TOKEN</h4>
<pre>public static final&nbsp;int IPC_CONTINUATION_TOKEN</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.arrow.vector.ipc.message.MessageSerializer.IPC_CONTINUATION_TOKEN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MessageSerializer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MessageSerializer</h4>
<pre>public&nbsp;MessageSerializer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="bytesToInt-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bytesToInt</h4>
<pre>public static&nbsp;int&nbsp;bytesToInt(byte[]&nbsp;bytes)</pre>
<div class="block">Convert an array of 4 bytes in little-endian to an native-endian i32 value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - byte array with minimum length of 4 in little-endian</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>converted an native-endian 32-bit integer</dd>
</dl>
</li>
</ul>
<a name="intToBytes-int-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intToBytes</h4>
<pre>public static&nbsp;void&nbsp;intToBytes(int&nbsp;value,
byte[]&nbsp;bytes)</pre>
<div class="block">Convert an integer to a little endian 4 byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - integer value input</dd>
<dd><code>bytes</code> - existing byte array with minimum length of 4 to contain the conversion output</dd>
</dl>
</li>
</ul>
<a name="longToBytes-long-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>longToBytes</h4>
<pre>public static&nbsp;void&nbsp;longToBytes(long&nbsp;value,
byte[]&nbsp;bytes)</pre>
<div class="block">Convert a long to a little-endian 8 byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - long value input</dd>
<dd><code>bytes</code> - existing byte array with minimum length of 8 to contain the conversion output</dd>
</dl>
</li>
</ul>
<a name="writeMessageBuffer-org.apache.arrow.vector.ipc.WriteChannel-int-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeMessageBuffer</h4>
<pre>public static&nbsp;int&nbsp;writeMessageBuffer(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
int&nbsp;messageLength,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;messageBuffer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="writeMessageBuffer-org.apache.arrow.vector.ipc.WriteChannel-int-java.nio.ByteBuffer-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeMessageBuffer</h4>
<pre>public static&nbsp;int&nbsp;writeMessageBuffer(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
int&nbsp;messageLength,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;messageBuffer,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Write the serialized Message metadata, prefixed by the length, to the output Channel. This
ensures that it aligns to an 8 byte boundary and will adjust the message length to include
any padding used for alignment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - Output Channel</dd>
<dd><code>messageLength</code> - Number of bytes in the message buffer, written as little Endian prefix</dd>
<dd><code>messageBuffer</code> - Message metadata buffer to be written, this does not include any
message body data which should be subsequently written to the Channel</dd>
<dd><code>option</code> - IPC write options</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of bytes written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.types.pojo.Schema-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static&nbsp;long&nbsp;serialize(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Serialize a schema object.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static&nbsp;long&nbsp;serialize(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Serialize a schema object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - where to write the schema</dd>
<dd><code>schema</code> - the object to serialize to out</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="serializeMetadata-org.apache.arrow.vector.types.pojo.Schema-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMetadata</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;serializeMetadata(<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the serialized flatbuffer bytes of the schema wrapped in a message table.</div>
</li>
</ul>
<a name="serializeMetadata-org.apache.arrow.vector.types.pojo.Schema-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMetadata</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;serializeMetadata(<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;schema,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</pre>
<div class="block">Returns the serialized flatbuffer bytes of the schema wrapped in a message table.</div>
</li>
</ul>
<a name="deserializeSchema-org.apache.arrow.flatbuf.Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeSchema</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;deserializeSchema(<a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf">Message</a>&nbsp;schemaMessage)</pre>
<div class="block">Deserializes an Arrow Schema object from a schema message. Format is from serialize().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemaMessage</code> - a Message of type MessageHeader.Schema</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized Arrow Schema</dd>
</dl>
</li>
</ul>
<a name="deserializeSchema-org.apache.arrow.vector.ipc.ReadChannel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeSchema</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;deserializeSchema(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an Arrow Schema read from the input channel. Format is from serialize().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the channel to deserialize from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized Arrow Schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeSchema-org.apache.arrow.vector.ipc.message.MessageMetadataResult-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeSchema</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/types/pojo/Schema.html" title="class in org.apache.arrow.vector.types.pojo">Schema</a>&nbsp;deserializeSchema(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;message)</pre>
<div class="block">Deserializes an Arrow Schema object from a <a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message"><code>MessageMetadataResult</code></a>. Format is from serialize().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - a Message of type MessageHeader.Schema</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized Arrow Schema</dd>
</dl>
</li>
</ul>
<a name="serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;serialize(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Serializes an ArrowRecordBatch. Returns the offset and length of the written batch.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;serialize(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Serializes an ArrowRecordBatch. Returns the offset and length of the written batch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - where to write the batch</dd>
<dd><code>batch</code> - the object to serialize to out</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the serialized block metadata</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="writeBatchBuffers-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeBatchBuffers</h4>
<pre>public static&nbsp;long&nbsp;writeBatchBuffers(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;batch)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Write the Arrow buffers of the record batch to the output channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the output channel to write the buffers to</dd>
<dd><code>batch</code> - an ArrowRecordBatch containing buffers to be written</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="serializeMetadata-org.apache.arrow.vector.ipc.message.ArrowMessage-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMetadata</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;serializeMetadata(<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;message)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Returns the serialized form of <a href="../../../../../../org/apache/arrow/flatbuf/RecordBatch.html" title="class in org.apache.arrow.flatbuf"><code>RecordBatch</code></a> wrapped in a <a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf"><code>Message</code></a>.</div>
</li>
</ul>
<a name="serializeMetadata-org.apache.arrow.vector.ipc.message.ArrowMessage-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMetadata</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;serializeMetadata(<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;message,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</pre>
<div class="block">Returns the serialized form of <a href="../../../../../../org/apache/arrow/flatbuf/RecordBatch.html" title="class in org.apache.arrow.flatbuf"><code>RecordBatch</code></a> wrapped in a <a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf"><code>Message</code></a>.</div>
</li>
</ul>
<a name="deserializeRecordBatch-org.apache.arrow.flatbuf.Message-org.apache.arrow.memory.ArrowBuf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeRecordBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;deserializeRecordBatch(<a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf">Message</a>&nbsp;recordBatchMessage,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;bodyBuffer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowRecordBatch from a record batch message and data in an ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recordBatchMessage</code> - a Message of type MessageHeader.RecordBatch</dd>
<dd><code>bodyBuffer</code> - Arrow buffer containing the RecordBatch data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowRecordBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeRecordBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeRecordBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;deserializeRecordBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowRecordBatch read from the input channel. This uses the given allocator
to create an ArrowBuf for the batch body data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - Channel to read a RecordBatch message and data from</dd>
<dd><code>allocator</code> - BufferAllocator to allocate an Arrow buffer to read message body data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowRecordBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="deserializeRecordBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.vector.ipc.message.ArrowBlock-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeRecordBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;deserializeRecordBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;block,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;alloc)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowRecordBatch knowing the size of the entire message up front. This
minimizes the number of reads to the underlying stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the channel to deserialize from</dd>
<dd><code>block</code> - the object to deserialize to</dd>
<dd><code>alloc</code> - to allocate buffers</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowRecordBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeRecordBatch-org.apache.arrow.flatbuf.RecordBatch-org.apache.arrow.memory.ArrowBuf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeRecordBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;deserializeRecordBatch(<a href="../../../../../../org/apache/arrow/flatbuf/RecordBatch.html" title="class in org.apache.arrow.flatbuf">RecordBatch</a>&nbsp;recordBatchFB,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;body)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowRecordBatch given the Flatbuffer metadata and in-memory body.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recordBatchFB</code> - Deserialized FlatBuffer record batch</dd>
<dd><code>body</code> - Read body of the record batch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ArrowRecordBatch from metadata and in-memory body</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="deserializeRecordBatch-org.apache.arrow.vector.ipc.message.MessageMetadataResult-org.apache.arrow.memory.ArrowBuf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeRecordBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowRecordBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowRecordBatch</a>&nbsp;deserializeRecordBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;serializedMessage,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;underlying)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Reads a record batch based on the metadata in serializedMessage and the underlying data buffer.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowDictionaryBatch-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;serialize(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;batch)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="serialize-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.ArrowDictionaryBatch-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;serialize(<a href="../../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a>&nbsp;out,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;batch,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;option)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Serializes a dictionary ArrowRecordBatch. Returns the offset and length of the written batch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - where to serialize</dd>
<dd><code>batch</code> - the batch to serialize</dd>
<dd><code>option</code> - options for IPC</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the metadata of the serialized block</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeDictionaryBatch-org.apache.arrow.flatbuf.Message-org.apache.arrow.memory.ArrowBuf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeDictionaryBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;deserializeDictionaryBatch(<a href="../../../../../../org/apache/arrow/flatbuf/Message.html" title="class in org.apache.arrow.flatbuf">Message</a>&nbsp;message,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;bodyBuffer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowDictionaryBatch from a dictionary batch Message and data in an ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - a message of type MessageHeader.DictionaryBatch</dd>
<dd><code>bodyBuffer</code> - Arrow buffer containing the DictionaryBatch data
of type MessageHeader.DictionaryBatch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowDictionaryBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeDictionaryBatch-org.apache.arrow.vector.ipc.message.MessageMetadataResult-org.apache.arrow.memory.ArrowBuf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeDictionaryBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;deserializeDictionaryBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;message,
<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;bodyBuffer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowDictionaryBatch from a dictionary batch Message and data in an ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - a message of type MessageHeader.DictionaryBatch</dd>
<dd><code>bodyBuffer</code> - Arrow buffer containing the DictionaryBatch data
of type MessageHeader.DictionaryBatch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowDictionaryBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeDictionaryBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeDictionaryBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;deserializeDictionaryBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes an ArrowDictionaryBatch read from the input channel. This uses the given allocator
to create an ArrowBuf for the batch body data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - Channel to read a DictionaryBatch message and data from</dd>
<dd><code>allocator</code> - BufferAllocator to allocate an Arrow buffer to read message body data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowDictionaryBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="deserializeDictionaryBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.vector.ipc.message.ArrowBlock-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeDictionaryBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowDictionaryBatch.html" title="class in org.apache.arrow.vector.ipc.message">ArrowDictionaryBatch</a>&nbsp;deserializeDictionaryBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowBlock.html" title="class in org.apache.arrow.vector.ipc.message">ArrowBlock</a>&nbsp;block,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;alloc)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserializes a DictionaryBatch knowing the size of the entire message up front. This
minimizes the number of reads to the underlying stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - where to read from</dd>
<dd><code>block</code> - block metadata for deserializing</dd>
<dd><code>alloc</code> - to allocate new buffers</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the deserialized ArrowDictionaryBatch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if something went wrong</dd>
</dl>
</li>
</ul>
<a name="deserializeMessageBatch-org.apache.arrow.vector.ipc.message.MessageChannelReader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeMessageBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;deserializeMessageBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageChannelReader.html" title="class in org.apache.arrow.vector.ipc.message">MessageChannelReader</a>&nbsp;reader)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserialize a message that is either an ArrowDictionaryBatch or ArrowRecordBatch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reader</code> - MessageChannelReader to read a sequence of messages from a ReadChannel</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The deserialized record batch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the message is not an ArrowDictionaryBatch or ArrowRecordBatch</dd>
</dl>
</li>
</ul>
<a name="deserializeMessageBatch-org.apache.arrow.vector.ipc.ReadChannel-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeMessageBatch</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/ArrowMessage.html" title="interface in org.apache.arrow.vector.ipc.message">ArrowMessage</a>&nbsp;deserializeMessageBatch(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;alloc)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Deserialize a message that is either an ArrowDictionaryBatch or ArrowRecordBatch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - ReadChannel to read messages from</dd>
<dd><code>alloc</code> - Allocator for message data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The deserialized record batch</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the message is not an ArrowDictionaryBatch or ArrowRecordBatch</dd>
</dl>
</li>
</ul>
<a name="serializeMessage-com.google.flatbuffers.FlatBufferBuilder-byte-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMessage</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;serializeMessage(com.google.flatbuffers.FlatBufferBuilder&nbsp;builder,
byte&nbsp;headerType,
int&nbsp;headerOffset,
long&nbsp;bodyLength)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</li>
</ul>
<a name="serializeMessage-com.google.flatbuffers.FlatBufferBuilder-byte-int-long-org.apache.arrow.vector.ipc.message.IpcOption-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeMessage</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;serializeMessage(com.google.flatbuffers.FlatBufferBuilder&nbsp;builder,
byte&nbsp;headerType,
int&nbsp;headerOffset,
long&nbsp;bodyLength,
<a href="../../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a>&nbsp;writeOption)</pre>
<div class="block">Serializes a message header.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - to write the flatbuf to</dd>
<dd><code>headerType</code> - headerType field</dd>
<dd><code>headerOffset</code> - header offset field</dd>
<dd><code>bodyLength</code> - body length field</dd>
<dd><code>writeOption</code> - IPC write options</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the corresponding ByteBuffer</dd>
</dl>
</li>
</ul>
<a name="readMessage-org.apache.arrow.vector.ipc.ReadChannel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readMessage</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/vector/ipc/message/MessageMetadataResult.html" title="class in org.apache.arrow.vector.ipc.message">MessageMetadataResult</a>&nbsp;readMessage(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Read a Message from the input channel and return a MessageMetadataResult that contains the
Message metadata, buffer containing the serialized Message metadata as read, and length of the
Message in bytes. Returns null if the end-of-stream has been reached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - ReadChannel to read messages from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MessageMetadataResult with deserialized Message metadata and message information if
a valid Message was read, or null if end-of-stream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a name="readMessageBody-org.apache.arrow.vector.ipc.ReadChannel-long-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readMessageBody</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;readMessageBody(<a href="../../../../../../org/apache/arrow/vector/ipc/ReadChannel.html" title="class in org.apache.arrow.vector.ipc">ReadChannel</a>&nbsp;in,
long&nbsp;bodyLength,
<a href="../../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Read a Message body from the in channel into an ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - ReadChannel to read message body from</dd>
<dd><code>bodyLength</code> - Length in bytes of the message body to read</dd>
<dd><code>allocator</code> - Allocate the ArrowBuf to contain message body data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ArrowBuf containing the message body data</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MessageSerializer.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/message/MessageResult.html" title="class in org.apache.arrow.vector.ipc.message"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/vector/ipc/message/MessageSerializer.html" target="_top">Frames</a></li>
<li><a href="MessageSerializer.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>