Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-12-01 07:03:41 +01:00
Code Issues Projects Releases Wiki Activity
352e8d70c4
ProtocolLib/Javadoc/com/comphenix/protocol/PacketStream.html
Kristian S. Stangeland 352e8d70c4 Adding JavaDoc for 1.3.0
2012-10-05 04:45:17 +02:00

301 lines
13 KiB
HTML
Raw Blame History

<!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 (version 1.7.0_07) on Fri Oct 05 04:44:05 CEST 2012 -->
<title>PacketStream</title>
<meta name="date" content="2012-10-05">
<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="PacketStream";
}
//-->
</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/PacketStream.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="../../../com/comphenix/protocol/Packets.Server.html" title="class in com.comphenix.protocol"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/comphenix/protocol/ProtocolLibrary.html" title="class in com.comphenix.protocol"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/comphenix/protocol/PacketStream.html" target="_top">Frames</a></li>
<li><a href="PacketStream.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>Constr&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>Constr&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">com.comphenix.protocol</div>
<h2 title="Interface PacketStream" class="title">Interface PacketStream</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../com/comphenix/protocol/ProtocolManager.html" title="interface in com.comphenix.protocol">ProtocolManager</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../com/comphenix/protocol/injector/PacketFilterManager.html" title="class in com.comphenix.protocol.injector">PacketFilterManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">PacketStream</span></pre>
<div class="block">Represents a object capable of sending or receiving packets.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Kristian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/PacketStream.html#recieveClientPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer)">recieveClientPacket</a></strong>(org.bukkit.entity.Player&nbsp;sender,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet)</code>
<div class="block">Simulate recieving a certain packet from a given player.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/PacketStream.html#recieveClientPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer, boolean)">recieveClientPacket</a></strong>(org.bukkit.entity.Player&nbsp;sender,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet,
boolean&nbsp;filters)</code>
<div class="block">Simulate recieving a certain packet from a given player.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/PacketStream.html#sendServerPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer)">sendServerPacket</a></strong>(org.bukkit.entity.Player&nbsp;reciever,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet)</code>
<div class="block">Send a packet to the given player.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/PacketStream.html#sendServerPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer, boolean)">sendServerPacket</a></strong>(org.bukkit.entity.Player&nbsp;reciever,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet,
boolean&nbsp;filters)</code>
<div class="block">Send a packet to the given player.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="sendServerPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendServerPacket</h4>
<pre>void&nbsp;sendServerPacket(org.bukkit.entity.Player&nbsp;reciever,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet)
throws java.lang.reflect.InvocationTargetException</pre>
<div class="block">Send a packet to the given player.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reciever</code> - - the reciever.</dd><dd><code>packet</code> - - packet to send.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.reflect.InvocationTargetException</code> - - if an error occured when sending the packet.</dd></dl>
</li>
</ul>
<a name="sendServerPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendServerPacket</h4>
<pre>void&nbsp;sendServerPacket(org.bukkit.entity.Player&nbsp;reciever,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet,
boolean&nbsp;filters)
throws java.lang.reflect.InvocationTargetException</pre>
<div class="block">Send a packet to the given player.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reciever</code> - - the reciever.</dd><dd><code>packet</code> - - packet to send.</dd><dd><code>filters</code> - - whether or not to invoke any packet filters.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.reflect.InvocationTargetException</code> - - if an error occured when sending the packet.</dd></dl>
</li>
</ul>
<a name="recieveClientPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recieveClientPacket</h4>
<pre>void&nbsp;recieveClientPacket(org.bukkit.entity.Player&nbsp;sender,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet)
throws java.lang.IllegalAccessException,
java.lang.reflect.InvocationTargetException</pre>
<div class="block">Simulate recieving a certain packet from a given player.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sender</code> - - the sender.</dd><dd><code>packet</code> - - the packet that was sent.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.reflect.InvocationTargetException</code> - If the reflection machinery failed.</dd>
<dd><code>java.lang.IllegalAccessException</code> - If the underlying method caused an error.</dd></dl>
</li>
</ul>
<a name="recieveClientPacket(org.bukkit.entity.Player, com.comphenix.protocol.events.PacketContainer, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>recieveClientPacket</h4>
<pre>void&nbsp;recieveClientPacket(org.bukkit.entity.Player&nbsp;sender,
<a href="../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;packet,
boolean&nbsp;filters)
throws java.lang.IllegalAccessException,
java.lang.reflect.InvocationTargetException</pre>
<div class="block">Simulate recieving a certain packet from a given player.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sender</code> - - the sender.</dd><dd><code>packet</code> - - the packet that was sent.</dd><dd><code>filters</code> - - whether or not to invoke any packet filters.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.reflect.InvocationTargetException</code> - If the reflection machinery failed.</dd>
<dd><code>java.lang.IllegalAccessException</code> - If the underlying method caused an 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><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/PacketStream.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="../../../com/comphenix/protocol/Packets.Server.html" title="class in com.comphenix.protocol"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/comphenix/protocol/ProtocolLibrary.html" title="class in com.comphenix.protocol"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/comphenix/protocol/PacketStream.html" target="_top">Frames</a></li>
<li><a href="PacketStream.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>Constr&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>Constr&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