com.comphenix.protocol.async

Class AsyncMarker

java.lang.Object

com.comphenix.protocol.async.AsyncMarker

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AsyncMarker>

public class AsyncMarker
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<AsyncMarker>

Contains information about the packet that is being processed by asynchronous listeners.

Asynchronous listeners can use this to set packet timeout or transmission order.

Author:

Kristian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SENDING_DELTA Default number of packets to skip.
static int	DEFAULT_TIMEOUT_DELTA Default number of milliseconds until a packet will rejected.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(AsyncMarker o)
long	getInitialTime() Retrieve the time the packet was initially queued for asynchronous processing.
java.util.Iterator<PrioritizedListener<AsyncListenerHandler>>	getListenerTraversal() Retrieve iterator for the next listener in line.
long	getNewSendingIndex() Retrieve the desired sending order after processing has completed.
long	getOriginalSendingIndex() Retrieve the order the packet was originally transmitted.
PacketStream	getPacketStream() Retrieve the packet stream responsible for transmitting this packet.
long	getTimeout() Retrieve the time the packet will be forcefully rejected.
boolean	hasExpired() Determine if this packet has expired.
boolean	hasExpired(long currentTime) Determine if this packet has expired given this time.
boolean	isAsyncCancelled() Determine if the asynchronous handling should be cancelled.
boolean	isMinecraftAsync(PacketEvent event) Determine if Minecraft allows asynchronous processing of this packet.
boolean	isProcessed() Retrieve whether or not this packet has been processed by the async listeners.
boolean	isTransmitted() Retrieve whether or not this packet has already been sent.
void	sendPacket(PacketEvent event) Transmit a given packet to the current packet stream.
void	setAsyncCancelled(boolean asyncCancelled) Set whether or not the asynchronous handling should be cancelled.
void	setNewSendingIndex(long newSendingIndex) Sets the desired sending order after processing has completed.
void	setPacketStream(PacketStream packetStream) Sets the output packet stream responsible for transmitting this packet.
void	setTimeout(long timeout) Set the time the packet will be forcefully rejected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TIMEOUT_DELTA

public static final int DEFAULT_TIMEOUT_DELTA

Default number of milliseconds until a packet will rejected.

See Also:

Constant Field Values

DEFAULT_SENDING_DELTA

public static final int DEFAULT_SENDING_DELTA

Default number of packets to skip.

See Also:

Constant Field Values

Method Detail

getInitialTime

public long getInitialTime()

Retrieve the time the packet was initially queued for asynchronous processing.

Returns:

The initial time in number of milliseconds since 01.01.1970 00:00.

getTimeout

public long getTimeout()

Retrieve the time the packet will be forcefully rejected.

Returns:

The time to reject the packet, in milliseconds since 01.01.1970 00:00.

setTimeout

public void setTimeout(long timeout)

Set the time the packet will be forcefully rejected.

Parameters:

timeout - - time to reject the packet, in milliseconds since 01.01.1970 00:00.

getOriginalSendingIndex

public long getOriginalSendingIndex()

Retrieve the order the packet was originally transmitted.

Returns:

The original packet index.

getNewSendingIndex

public long getNewSendingIndex()

Retrieve the desired sending order after processing has completed.

Higher sending order means lower priority.

Returns:

Desired sending order.

setNewSendingIndex

public void setNewSendingIndex(long newSendingIndex)

Sets the desired sending order after processing has completed.

Higher sending order means lower priority.

Parameters:

newSendingIndex - - new packet send index.

getPacketStream

public PacketStream getPacketStream()

Retrieve the packet stream responsible for transmitting this packet.

Returns:

The packet stream.

setPacketStream

public void setPacketStream(PacketStream packetStream)

Sets the output packet stream responsible for transmitting this packet.

Parameters:

packetStream - - new output packet stream.

isProcessed

public boolean isProcessed()

Retrieve whether or not this packet has been processed by the async listeners.

Returns:

TRUE if it has been processed, FALSE otherwise.

isTransmitted

public boolean isTransmitted()

Retrieve whether or not this packet has already been sent.

Returns:

TRUE if it has been sent before, FALSE otherwise.

hasExpired

public boolean hasExpired()

Determine if this packet has expired.

Returns:

TRUE if it has, FALSE otherwise.

hasExpired

public boolean hasExpired(long currentTime)

Determine if this packet has expired given this time.

Parameters:

currentTime - - the current time in milliseconds since 01.01.1970 00:00.

Returns:

TRUE if it has, FALSE otherwise.

isAsyncCancelled

public boolean isAsyncCancelled()

Determine if the asynchronous handling should be cancelled.

Returns:

TRUE if it should, FALSE otherwise.

setAsyncCancelled

public void setAsyncCancelled(boolean asyncCancelled)

Set whether or not the asynchronous handling should be cancelled.

Parameters:

asyncCancelled - - TRUE to cancel it, FALSE otherwise.

getListenerTraversal

public java.util.Iterator<PrioritizedListener<AsyncListenerHandler>> getListenerTraversal()

Retrieve iterator for the next listener in line.

Returns:

Next async packet listener iterator.

sendPacket

public void sendPacket(PacketEvent event)
                throws java.io.IOException

Transmit a given packet to the current packet stream.

Parameters:

event - - the packet to send.

Throws:

java.io.IOException - If the packet couldn't be sent.

isMinecraftAsync

public boolean isMinecraftAsync(PacketEvent event)
                         throws FieldAccessException

Determine if Minecraft allows asynchronous processing of this packet.

Returns:

TRUE if it does, FALSE otherwise.

Throws:

FieldAccessException

compareTo

public int compareTo(AsyncMarker o)

Specified by:

compareTo in interface java.lang.Comparable<AsyncMarker>