| <!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 (1.8.0_292) on Tue Jun 15 06:00:58 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.hadoop.typedbytes (Apache Hadoop Main 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <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.hadoop.typedbytes (Apache Hadoop Main 3.3.1 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/hadoop/tracing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/hadoop/util/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/typedbytes/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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 org.apache.hadoop.typedbytes</h1> |
| <div class="docSummary"> |
| <div class="block">Typed bytes are sequences of bytes in which the first byte is a type code.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"><a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.hadoop.typedbytes Description">Package org.apache.hadoop.typedbytes Description</h2> |
| <div class="block">Typed bytes are sequences of bytes in which the first byte is a type code. They are especially useful as a |
| (simple and very straightforward) binary format for transferring data to and from Hadoop Streaming programs. |
| |
| <h3>Type Codes</h3> |
| |
| Each typed bytes sequence starts with an unsigned byte that contains the type code. Possible values are: |
| |
| <table border="1" cellpadding="2" summary="Type Codes"> |
| <tr><th>Code</th><th>Type</th></tr> |
| <tr><td><i>0</i></td><td>A sequence of bytes.</td></tr> |
| <tr><td><i>1</i></td><td>A byte.</td></tr> |
| <tr><td><i>2</i></td><td>A boolean.</td></tr> |
| <tr><td><i>3</i></td><td>An integer.</td></tr> |
| <tr><td><i>4</i></td><td>A long.</td></tr> |
| <tr><td><i>5</i></td><td>A float.</td></tr> |
| <tr><td><i>6</i></td><td>A double.</td></tr> |
| <tr><td><i>7</i></td><td>A string.</td></tr> |
| <tr><td><i>8</i></td><td>A vector.</td></tr> |
| <tr><td><i>9</i></td><td>A list.</td></tr> |
| <tr><td><i>10</i></td><td>A map.</td></tr> |
| </table> |
| |
| The type codes <i>50</i> to <i>200</i> are treated as aliases for <i>0</i>, and can thus be used for |
| application-specific serialization. |
| |
| <h3>Subsequent Bytes</h3> |
| |
| These are the subsequent bytes for the different type codes (everything is big-endian and unpadded): |
| |
| <table border="1" cellpadding="2" summary="Subsequent Bytes"> |
| <tr><th>Code</th><th>Subsequent Bytes</th></tr> |
| <tr><td><i>0</i></td><td><32-bit signed integer> <as many bytes as indicated by the integer></td></tr> |
| <tr><td><i>1</i></td><td><signed byte></td></tr> |
| <tr><td><i>2</i></td><td><signed byte (<i>0</i> = <i>false</i> and <i>1</i> = <i>true</i>)></td></tr> |
| <tr><td><i>3</i></td><td><32-bit signed integer></td></tr> |
| <tr><td><i>4</i></td><td><64-bit signed integer></td></tr> |
| <tr><td><i>5</i></td><td><32-bit IEEE floating point number></td></tr> |
| <tr><td><i>6</i></td><td><64-bit IEEE floating point number></td></tr> |
| <tr><td><i>7</i></td><td><32-bit signed integer> <as many UTF-8 bytes as indicated by the integer></td></tr> |
| <tr><td><i>8</i></td><td><32-bit signed integer> <as many typed bytes sequences as indicated by the integer></td></tr> |
| <tr><td><i>9</i></td><td><variable number of typed bytes sequences> <<i>255</i> written as an unsigned byte></td></tr> |
| <tr><td><i>10</i></td><td><32-bit signed integer> <as many (key-value) pairs of typed bytes sequences as indicated by the integer></td></tr> |
| </table></div> |
| </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/hadoop/tracing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/hadoop/util/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/typedbytes/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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 © 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |