com.comphenix.protocol

Interface AsynchronousManager

All Known Implementing Classes:

AsyncFilterManager

public interface AsynchronousManager

Represents a asynchronous packet handler.

Author:

Kristian

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanupAll() Remove listeners, close threads and transmit every delayed packet.
ErrorReporter	getErrorReporter() Retrieve the default error reporter.
PacketStream	getPacketStream() Retrieve the default packet stream.
java.util.Set<java.lang.Integer>	getReceivingFilters() Retrieves a immutable set containing the ID of the recieved client packets that will be observed by the asynchronous listeners.
java.util.Set<java.lang.Integer>	getSendingFilters() Retrieves a immutable set containing the ID of the sent server packets that will be observed by the asynchronous listeners.
java.util.Set<PacketListener>	getTimeoutHandlers() Get a immutable list of every registered timeout handler.
boolean	hasAsynchronousListeners(PacketEvent packet) Determine if a given synchronous packet has asynchronous listeners.
AsyncListenerHandler	registerAsyncHandler(PacketListener listener) Registers an asynchronous packet handler.
void	registerTimeoutHandler(PacketListener listener) Register a synchronous listener that handles packets when they time out.
void	signalPacketTransmission(PacketEvent packet) Signal that a packet is ready to be transmitted.
void	unregisterAsyncHandler(AsyncListenerHandler handler) Unregisters and closes the given asynchronous handler.
void	unregisterAsyncHandlers(Plugin plugin) Unregisters every asynchronous handler associated with this plugin.
void	unregisterTimeoutHandler(PacketListener listener) Unregisters a given timeout listener.

Method Detail

registerAsyncHandler

AsyncListenerHandler registerAsyncHandler(PacketListener listener)

Registers an asynchronous packet handler.

Use AsyncMarker.incrementProcessingDelay() to delay a packet until its ready to be transmitted.

To start listening asynchronously, pass the getListenerLoop() runnable to a different thread.

Parameters:

listener - - the packet listener that will recieve these asynchronous events.

Returns:

An asynchrouns handler.

unregisterAsyncHandler

void unregisterAsyncHandler(AsyncListenerHandler handler)

Unregisters and closes the given asynchronous handler.

Parameters:

handler - - asynchronous handler.

unregisterAsyncHandlers

void unregisterAsyncHandlers(Plugin plugin)

Unregisters every asynchronous handler associated with this plugin.

Parameters:

plugin - - the original plugin.

getSendingFilters

java.util.Set<java.lang.Integer> getSendingFilters()

Retrieves a immutable set containing the ID of the sent server packets that will be observed by the asynchronous listeners.

Returns:

Every filtered server packet.

getReceivingFilters

java.util.Set<java.lang.Integer> getReceivingFilters()

Retrieves a immutable set containing the ID of the recieved client packets that will be observed by the asynchronous listeners.

Returns:

Every filtered client packet.

hasAsynchronousListeners

boolean hasAsynchronousListeners(PacketEvent packet)

Determine if a given synchronous packet has asynchronous listeners.

Parameters:

packet - - packet to test.

Returns:

TRUE if it does, FALSE otherwise.

getPacketStream

PacketStream getPacketStream()

Retrieve the default packet stream.

Returns:

Default packet stream.

getErrorReporter

ErrorReporter getErrorReporter()

Retrieve the default error reporter.

Returns:

Default reporter.

cleanupAll

void cleanupAll()

Remove listeners, close threads and transmit every delayed packet.

signalPacketTransmission

void signalPacketTransmission(PacketEvent packet)

Signal that a packet is ready to be transmitted.

This should only be called if AsyncMarker.incrementProcessingDelay() has been called previously.

Parameters:

packet - - packet to signal.

registerTimeoutHandler

void registerTimeoutHandler(PacketListener listener)

Register a synchronous listener that handles packets when they time out.

Parameters:

listener - - synchronous listener that will handle timed out packets.

unregisterTimeoutHandler

void unregisterTimeoutHandler(PacketListener listener)

Unregisters a given timeout listener.

Parameters:

listener - - the timeout listener to unregister.

getTimeoutHandlers

java.util.Set<PacketListener> getTimeoutHandlers()

Get a immutable list of every registered timeout handler.

Returns:

List of every registered timeout handler.