2012-10-01 05:05:47 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "en" >
< head >
2012-10-11 03:00:53 +02:00
<!-- Generated by javadoc (version 1.7.0_07) on Thu Oct 11 02:58:30 CEST 2012 -->
2012-10-01 05:05:47 +02:00
< title > AsynchronousManager< / title >
2012-10-11 03:00:53 +02:00
< meta name = "date" content = "2012-10-11" >
2012-10-01 05:05:47 +02:00
< 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="AsynchronousManager";
}
//-->
< / 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/AsynchronousManager.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/Application.html" title = "class in com.comphenix.protocol" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../com/comphenix/protocol/Packets.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/AsynchronousManager.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "AsynchronousManager.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: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / 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 AsynchronousManager" class = "title" > Interface AsynchronousManager< / h2 >
< / div >
< div class = "contentContainer" >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Known Implementing Classes:< / dt >
< dd > < a href = "../../../com/comphenix/protocol/async/AsyncFilterManager.html" title = "class in com.comphenix.protocol.async" > AsyncFilterManager< / a > < / dd >
< / dl >
< hr >
< br >
< pre > public interface < span class = "strong" > AsynchronousManager< / span > < / pre >
< div class = "block" > Represents a asynchronous packet handler.< / 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" > < / 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/AsynchronousManager.html#cleanupAll()" > cleanupAll< / a > < / strong > ()< / code >
< div class = "block" > Remove listeners, close threads and transmit every delayed packet.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > java.util.logging.Logger< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#getLogger()" > getLogger< / a > < / strong > ()< / code >
< div class = "block" > Retrieve the default error logger.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../com/comphenix/protocol/PacketStream.html" title = "interface in com.comphenix.protocol" > PacketStream< / a > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#getPacketStream()" > getPacketStream< / a > < / strong > ()< / code >
< div class = "block" > Retrieve the default packet stream.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > java.util.Set< java.lang.Integer> < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#getReceivingFilters()" > getReceivingFilters< / a > < / strong > ()< / code >
2012-10-17 07:58:24 +02:00
< div class = "block" > Retrieves a immutable set containing the ID of the recieved client packets that will be
2012-10-01 05:05:47 +02:00
observed by the asynchronous listeners.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > java.util.Set< java.lang.Integer> < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#getSendingFilters()" > getSendingFilters< / a > < / strong > ()< / code >
2012-10-17 07:58:24 +02:00
< div class = "block" > Retrieves a immutable set containing the ID of the sent server packets that will be
2012-10-01 05:05:47 +02:00
observed by the asynchronous listeners.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#hasAsynchronousListeners(com.comphenix.protocol.events.PacketEvent)" > hasAsynchronousListeners< / a > < / strong > (< a href = "../../../com/comphenix/protocol/events/PacketEvent.html" title = "class in com.comphenix.protocol.events" > PacketEvent< / a > packet)< / code >
< div class = "block" > Determine if a given synchronous packet has asynchronous listeners.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > < a href = "../../../com/comphenix/protocol/async/AsyncListenerHandler.html" title = "class in com.comphenix.protocol.async" > AsyncListenerHandler< / a > < / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#registerAsyncHandler(com.comphenix.protocol.events.PacketListener)" > registerAsyncHandler< / a > < / strong > (< a href = "../../../com/comphenix/protocol/events/PacketListener.html" title = "interface in com.comphenix.protocol.events" > PacketListener< / a > listener)< / code >
< div class = "block" > Registers an asynchronous packet handler.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2012-10-11 03:00:53 +02:00
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#signalPacketTransmission(com.comphenix.protocol.events.PacketEvent)" > signalPacketTransmission< / a > < / strong > (< a href = "../../../com/comphenix/protocol/events/PacketEvent.html" title = "class in com.comphenix.protocol.events" > PacketEvent< / a > packet)< / code >
< div class = "block" > Signal that a packet is ready to be transmitted.< / div >
< / td >
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2012-10-01 05:05:47 +02:00
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#unregisterAsyncHandler(com.comphenix.protocol.async.AsyncListenerHandler)" > unregisterAsyncHandler< / a > < / strong > (< a href = "../../../com/comphenix/protocol/async/AsyncListenerHandler.html" title = "class in com.comphenix.protocol.async" > AsyncListenerHandler< / a > handler)< / code >
< div class = "block" > Unregisters and closes the given asynchronous handler.< / div >
< / td >
< / tr >
2012-10-11 03:00:53 +02:00
< tr class = "rowColor" >
2012-10-01 05:05:47 +02:00
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < strong > < a href = "../../../com/comphenix/protocol/AsynchronousManager.html#unregisterAsyncHandlers(org.bukkit.plugin.Plugin)" > unregisterAsyncHandlers< / a > < / strong > (org.bukkit.plugin.Plugin plugin)< / code >
< div class = "block" > Unregisters every asynchronous handler associated with this plugin.< / 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 = "registerAsyncHandler(com.comphenix.protocol.events.PacketListener)" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > registerAsyncHandler< / h4 >
< pre > < a href = "../../../com/comphenix/protocol/async/AsyncListenerHandler.html" title = "class in com.comphenix.protocol.async" > AsyncListenerHandler< / a > registerAsyncHandler(< a href = "../../../com/comphenix/protocol/events/PacketListener.html" title = "interface in com.comphenix.protocol.events" > PacketListener< / a > listener)< / pre >
2012-10-17 07:58:24 +02:00
< div class = "block" > Registers an asynchronous packet handler.
< p >
2012-10-01 05:05:47 +02:00
To start listening asynchronously, pass the getListenerLoop() runnable to a different thread.< / div >
2012-10-05 04:45:17 +02:00
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > listener< / code > - - the packet listener that will recieve these asynchronous events.< / dd >
2012-10-01 05:05:47 +02:00
< dt > < span class = "strong" > Returns:< / span > < / dt > < dd > An asynchrouns handler.< / dd > < / dl >
< / li >
< / ul >
< a name = "unregisterAsyncHandler(com.comphenix.protocol.async.AsyncListenerHandler)" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > unregisterAsyncHandler< / h4 >
< pre > void unregisterAsyncHandler(< a href = "../../../com/comphenix/protocol/async/AsyncListenerHandler.html" title = "class in com.comphenix.protocol.async" > AsyncListenerHandler< / a > handler)< / pre >
< div class = "block" > Unregisters and closes the given asynchronous handler.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > handler< / code > - - asynchronous handler.< / dd > < / dl >
< / li >
< / ul >
< a name = "unregisterAsyncHandlers(org.bukkit.plugin.Plugin)" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > unregisterAsyncHandlers< / h4 >
< pre > void unregisterAsyncHandlers(org.bukkit.plugin.Plugin plugin)< / pre >
< div class = "block" > Unregisters every asynchronous handler associated with this plugin.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > plugin< / code > - - the original plugin.< / dd > < / dl >
< / li >
< / ul >
< a name = "getSendingFilters()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getSendingFilters< / h4 >
< pre > java.util.Set< java.lang.Integer> getSendingFilters()< / pre >
2012-10-17 07:58:24 +02:00
< div class = "block" > Retrieves a immutable set containing the ID of the sent server packets that will be
2012-10-01 05:05:47 +02:00
observed by the asynchronous listeners.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Every filtered server packet.< / dd > < / dl >
< / li >
< / ul >
< a name = "getReceivingFilters()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getReceivingFilters< / h4 >
< pre > java.util.Set< java.lang.Integer> getReceivingFilters()< / pre >
2012-10-17 07:58:24 +02:00
< div class = "block" > Retrieves a immutable set containing the ID of the recieved client packets that will be
2012-10-01 05:05:47 +02:00
observed by the asynchronous listeners.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Every filtered client packet.< / dd > < / dl >
< / li >
< / ul >
< a name = "hasAsynchronousListeners(com.comphenix.protocol.events.PacketEvent)" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > hasAsynchronousListeners< / h4 >
< pre > boolean hasAsynchronousListeners(< a href = "../../../com/comphenix/protocol/events/PacketEvent.html" title = "class in com.comphenix.protocol.events" > PacketEvent< / a > packet)< / pre >
< div class = "block" > Determine if a given synchronous packet has asynchronous listeners.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > packet< / code > - - packet to test.< / dd >
< dt > < span class = "strong" > Returns:< / span > < / dt > < dd > TRUE if it does, FALSE otherwise.< / dd > < / dl >
< / li >
< / ul >
< a name = "getPacketStream()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getPacketStream< / h4 >
< pre > < a href = "../../../com/comphenix/protocol/PacketStream.html" title = "interface in com.comphenix.protocol" > PacketStream< / a > getPacketStream()< / pre >
< div class = "block" > Retrieve the default packet stream.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Default packet stream.< / dd > < / dl >
< / li >
< / ul >
< a name = "getLogger()" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getLogger< / h4 >
< pre > java.util.logging.Logger getLogger()< / pre >
< div class = "block" > Retrieve the default error logger.< / div >
< dl > < dt > < span class = "strong" > Returns:< / span > < / dt > < dd > Default logger.< / dd > < / dl >
< / li >
< / ul >
< a name = "cleanupAll()" >
<!-- -->
< / a >
2012-10-11 03:00:53 +02:00
< ul class = "blockList" >
2012-10-01 05:05:47 +02:00
< li class = "blockList" >
< h4 > cleanupAll< / h4 >
< pre > void cleanupAll()< / pre >
< div class = "block" > Remove listeners, close threads and transmit every delayed packet.< / div >
< / li >
< / ul >
2012-10-11 03:00:53 +02:00
< a name = "signalPacketTransmission(com.comphenix.protocol.events.PacketEvent)" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > signalPacketTransmission< / h4 >
< pre > void signalPacketTransmission(< a href = "../../../com/comphenix/protocol/events/PacketEvent.html" title = "class in com.comphenix.protocol.events" > PacketEvent< / a > packet)< / pre >
2012-10-17 07:58:24 +02:00
< div class = "block" > Signal that a packet is ready to be transmitted.
< p >
This should only be called if < a href = "../../../com/comphenix/protocol/async/AsyncMarker.html#incrementProcessingDelay()" > < code > AsyncMarker.incrementProcessingDelay()< / code > < / a >
2012-10-11 03:00:53 +02:00
has been called previously.< / div >
< dl > < dt > < span class = "strong" > Parameters:< / span > < / dt > < dd > < code > packet< / code > - - packet to signal.< / dd > < / dl >
< / li >
< / ul >
2012-10-01 05:05:47 +02:00
< / 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/AsynchronousManager.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/Application.html" title = "class in com.comphenix.protocol" > < span class = "strong" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../com/comphenix/protocol/Packets.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/AsynchronousManager.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "AsynchronousManager.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: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
< li > < a href = "#method_detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip-navbar_bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
