backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Net/PacketReader.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

466 lines
18 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:34 CEST 2013 -->
<title>PacketReader</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PacketReader";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/PacketReader.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Net/NetworkSessionType.html" title="enum in Microsoft.Xna.Framework.Net"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Net/PacketWriter.html" title="class in Microsoft.Xna.Framework.Net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Net/PacketReader.html" target="_top">Frames</a></li>
<li><a href="PacketReader.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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">Microsoft.Xna.Framework.Net</div>
<h2 title="Class PacketReader" class="title">Class PacketReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../System/IO/BinaryReader.html" title="class in System.IO">System.IO.BinaryReader</a></li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.Net.PacketReader</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PacketReader</span>
extends <a href="../../../../System/IO/BinaryReader.html" title="class in System.IO">BinaryReader</a></pre>
<div class="block">Provides common functionality for efficiently reading incoming network packets. Reference page contains links to related code samples.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#PacketReader()">PacketReader</a></strong>()</code>
<div class="block">Initializes an empty instance of PacketReader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#PacketReader(int)">PacketReader</a></strong>(int&nbsp;capacity)</code>
<div class="block">Initializes an empty instance of PacketReader with the specified options.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#getPosition()">getPosition</a></strong>()</code>
<div class="block">Gets the current packet read position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#Length()">Length</a></strong>()</code>
<div class="block">Gets the length of the packet being read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Color.html" title="class in Microsoft.Xna.Framework">Color</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadColor()">ReadColor</a></strong>()</code>
<div class="block">Reads a Color value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadDouble()">ReadDouble</a></strong>()</code>
<div class="block">Reads an 8-byte floating point value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework">Matrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadMatrix()">ReadMatrix</a></strong>()</code>
<div class="block">Reads a Matrix value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Quaternion.html" title="class in Microsoft.Xna.Framework">Quaternion</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadQuaternion()">ReadQuaternion</a></strong>()</code>
<div class="block">Reads a Quaternion value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadSingle()">ReadSingle</a></strong>()</code>
<div class="block">Reads a 4-byte floating point value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Vector2.html" title="class in Microsoft.Xna.Framework">Vector2</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadVector2()">ReadVector2</a></strong>()</code>
<div class="block">Reads a Vector2 value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadVector3()">ReadVector3</a></strong>()</code>
<div class="block">Reads a Vector3 value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#ReadVector4()">ReadVector4</a></strong>()</code>
<div class="block">Reads a Vector4 value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Net/PacketReader.html#setPosition(int)">setPosition</a></strong>(int&nbsp;value)</code>
<div class="block">Sets the current packet read position.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_System.IO.BinaryReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;System.IO.<a href="../../../../System/IO/BinaryReader.html" title="class in System.IO">BinaryReader</a></h3>
<code><a href="../../../../System/IO/BinaryReader.html#Close()">Close</a>, <a href="../../../../System/IO/BinaryReader.html#Dispose()">Dispose</a>, <a href="../../../../System/IO/BinaryReader.html#Dispose(boolean)">Dispose</a>, <a href="../../../../System/IO/BinaryReader.html#FillBuffer(int)">FillBuffer</a>, <a href="../../../../System/IO/BinaryReader.html#getBaseStream()">getBaseStream</a>, <a href="../../../../System/IO/BinaryReader.html#Read()">Read</a>, <a href="../../../../System/IO/BinaryReader.html#Read(byte[], int, int)">Read</a>, <a href="../../../../System/IO/BinaryReader.html#Read(char[], int, int)">Read</a>, <a href="../../../../System/IO/BinaryReader.html#Read7BitEncodedInt()">Read7BitEncodedInt</a>, <a href="../../../../System/IO/BinaryReader.html#ReadBoolean()">ReadBoolean</a>, <a href="../../../../System/IO/BinaryReader.html#ReadByte()">ReadByte</a>, <a href="../../../../System/IO/BinaryReader.html#ReadBytes(int)">ReadBytes</a>, <a href="../../../../System/IO/BinaryReader.html#ReadChar()">ReadChar</a>, <a href="../../../../System/IO/BinaryReader.html#ReadChars(int)">ReadChars</a>, <a href="../../../../System/IO/BinaryReader.html#ReadInt16()">ReadInt16</a>, <a href="../../../../System/IO/BinaryReader.html#ReadInt32()">ReadInt32</a>, <a href="../../../../System/IO/BinaryReader.html#ReadInt64()">ReadInt64</a>, <a href="../../../../System/IO/BinaryReader.html#ReadString()">ReadString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PacketReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketReader</h4>
<pre>public&nbsp;PacketReader()</pre>
<div class="block">Initializes an empty instance of PacketReader.</div>
</li>
</ul>
<a name="PacketReader(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PacketReader</h4>
<pre>public&nbsp;PacketReader(int&nbsp;capacity)</pre>
<div class="block">Initializes an empty instance of PacketReader with the specified options.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - Initial capacity for a received network packet.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Length</h4>
<pre>public&nbsp;int&nbsp;Length()</pre>
<div class="block">Gets the length of the packet being read.</div>
</li>
</ul>
<a name="getPosition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre>public&nbsp;int&nbsp;getPosition()</pre>
<div class="block">Gets the current packet read position.</div>
</li>
</ul>
<a name="setPosition(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPosition</h4>
<pre>public&nbsp;void&nbsp;setPosition(int&nbsp;value)</pre>
<div class="block">Sets the current packet read position.</div>
</li>
</ul>
<a name="ReadColor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadColor</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Color.html" title="class in Microsoft.Xna.Framework">Color</a>&nbsp;ReadColor()</pre>
<div class="block">Reads a Color value.</div>
</li>
</ul>
<a name="ReadDouble()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadDouble</h4>
<pre>public&nbsp;double&nbsp;ReadDouble()</pre>
<div class="block">Reads an 8-byte floating point value.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../System/IO/BinaryReader.html#ReadDouble()">ReadDouble</a></code>&nbsp;in class&nbsp;<code><a href="../../../../System/IO/BinaryReader.html" title="class in System.IO">BinaryReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="ReadMatrix()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadMatrix</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Matrix.html" title="class in Microsoft.Xna.Framework">Matrix</a>&nbsp;ReadMatrix()</pre>
<div class="block">Reads a Matrix value.</div>
</li>
</ul>
<a name="ReadQuaternion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadQuaternion</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Quaternion.html" title="class in Microsoft.Xna.Framework">Quaternion</a>&nbsp;ReadQuaternion()</pre>
<div class="block">Reads a Quaternion value.</div>
</li>
</ul>
<a name="ReadSingle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadSingle</h4>
<pre>public&nbsp;float&nbsp;ReadSingle()</pre>
<div class="block">Reads a 4-byte floating point value.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../System/IO/BinaryReader.html#ReadSingle()">ReadSingle</a></code>&nbsp;in class&nbsp;<code><a href="../../../../System/IO/BinaryReader.html" title="class in System.IO">BinaryReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="ReadVector2()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadVector2</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Vector2.html" title="class in Microsoft.Xna.Framework">Vector2</a>&nbsp;ReadVector2()</pre>
<div class="block">Reads a Vector2 value.</div>
</li>
</ul>
<a name="ReadVector3()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ReadVector3</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Vector3.html" title="class in Microsoft.Xna.Framework">Vector3</a>&nbsp;ReadVector3()</pre>
<div class="block">Reads a Vector3 value.</div>
</li>
</ul>
<a name="ReadVector4()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReadVector4</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Vector4.html" title="class in Microsoft.Xna.Framework">Vector4</a>&nbsp;ReadVector4()</pre>
<div class="block">Reads a Vector4 value.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/PacketReader.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Net/NetworkSessionType.html" title="enum in Microsoft.Xna.Framework.Net"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Net/PacketWriter.html" title="class in Microsoft.Xna.Framework.Net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Net/PacketReader.html" target="_top">Frames</a></li>
<li><a href="PacketReader.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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 ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink