com.comphenix.protocol.events

Class ScheduledPacket

java.lang.Object

com.comphenix.protocol.events.ScheduledPacket

public class ScheduledPacket
extends Object

Represents a packet that is scheduled for transmission at a later stage.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	filtered
protected PacketContainer	packet
protected org.bukkit.entity.Player	target

Constructor Summary

Constructors

Constructor and Description
ScheduledPacket(PacketContainer packet, org.bukkit.entity.Player target, boolean filtered) Construct a new scheduled packet.

Method Summary

Modifier and Type	Method and Description
static ScheduledPacket	fromFiltered(PacketContainer packet, org.bukkit.entity.Player target) Construct a new scheduled packet that will be processed by any packet listeners.
static ScheduledPacket	fromSilent(PacketContainer packet, org.bukkit.entity.Player target) Construct a new scheduled packet that will not be processed by any packet listeners (except MONITOR).
PacketContainer	getPacket() Retrieve the packet that will be sent or transmitted.
PacketType.Sender	getSender() Retrieve the sender of this packet.
org.bukkit.entity.Player	getTarget() Retrieve the target player.
boolean	isFiltered() Determine if this packet will be processed by any of the packet listeners.
void	schedule() Schedule the packet transmission or reception.
void	schedule(PacketStream stream) Schedule the packet transmission or reception.
void	setFiltered(boolean filtered) Set whether or not this packet will be processed by packet listeners (except MONITOR listeners).
void	setPacket(PacketContainer packet) Set the packet that will be sent or transmitted.
void	setTarget(org.bukkit.entity.Player target) Set the target player.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

packet

protected PacketContainer packet

target

protected org.bukkit.entity.Player target

filtered

protected boolean filtered

Constructor Detail

ScheduledPacket

public ScheduledPacket(PacketContainer packet,
                       org.bukkit.entity.Player target,
                       boolean filtered)

Construct a new scheduled packet.

Note that the sender is infered from the packet type.

Parameters:

packet - - the packet.

target - - the target player.

filtered - - whether or not to

Method Detail

fromSilent

public static ScheduledPacket fromSilent(PacketContainer packet,
                                         org.bukkit.entity.Player target)

Construct a new scheduled packet that will not be processed by any packet listeners (except MONITOR).

Parameters:

packet - - the packet.

target - - the target player.

Returns:

The scheduled packet.

fromFiltered

public static ScheduledPacket fromFiltered(PacketContainer packet,
                                           org.bukkit.entity.Player target)

Construct a new scheduled packet that will be processed by any packet listeners.

Parameters:

packet - - the packet.

target - - the target player.

Returns:

The scheduled packet.

getPacket

public PacketContainer getPacket()

Retrieve the packet that will be sent or transmitted.

Returns:

The sent or received packet.

setPacket

public void setPacket(PacketContainer packet)

Set the packet that will be sent or transmitted.

Parameters:

packet - - the new packet, cannot be NULL.

getTarget

public org.bukkit.entity.Player getTarget()

Retrieve the target player.

Returns:

The target player.

setTarget

public void setTarget(org.bukkit.entity.Player target)

Set the target player.

Parameters:

target - - the new target, cannot be NULL.

isFiltered

public boolean isFiltered()

Determine if this packet will be processed by any of the packet listeners.

Returns:

TRUE if it will, FALSE otherwise.

setFiltered

public void setFiltered(boolean filtered)

Set whether or not this packet will be processed by packet listeners (except MONITOR listeners).

Parameters:

filtered - - TRUE if it should be processed by listeners, FALSE otherwise.

getSender

public PacketType.Sender getSender()

Retrieve the sender of this packet.

Returns:

The sender.

schedule

public void schedule()

Schedule the packet transmission or reception.

schedule

public void schedule(PacketStream stream)

Schedule the packet transmission or reception.

Parameters:

stream - - the packet stream.

toString

public String toString()

Overrides:

toString in class Object