com.comphenix.protocol

Interface ProtocolManager

All Superinterfaces:

PacketStream

All Known Subinterfaces:

InternalManager

All Known Implementing Classes:

DelayedPacketManager, PacketFilterManager

public interface ProtocolManager
extends PacketStream

Represents an API for accessing the Minecraft protocol.

Author:

Kristian

Method Summary

Methods

Modifier and Type	Method and Description
void	addPacketListener(PacketListener listener) Adds a packet listener.
void	broadcastServerPacket(PacketContainer packet) Broadcast a given packet to every connected player on the server.
void	broadcastServerPacket(PacketContainer packet, org.bukkit.entity.Entity entity, boolean includeTracker) Broadcast a packet to every player that is receiving information about a given entity.
void	broadcastServerPacket(PacketContainer packet, org.bukkit.Location origin, int maxObserverDistance) Broadcast a packet to every player within the given maximum observer distance.
PacketContainer	createPacket(int id) Deprecated.
PacketContainer	createPacket(int id, boolean forceDefaults) Deprecated.
PacketContainer	createPacket(PacketType type) Constructs a new encapsulated Minecraft packet with the given ID.
PacketContainer	createPacket(PacketType type, boolean forceDefaults) Constructs a new encapsulated Minecraft packet with the given ID.
PacketConstructor	createPacketConstructor(int id, java.lang.Object... arguments) Deprecated.
PacketConstructor	createPacketConstructor(PacketType type, java.lang.Object... arguments) Construct a packet using the special builtin Minecraft constructors.
AsynchronousManager	getAsynchronousManager() Retrieve the current asynchronous packet manager.
org.bukkit.entity.Entity	getEntityFromID(org.bukkit.World container, int id) Retrieve the associated entity.
java.util.List<org.bukkit.entity.Player>	getEntityTrackers(org.bukkit.entity.Entity entity) Retrieve every client that is receiving information about a given entity.
MinecraftVersion	getMinecraftVersion() Retrieve the current Minecraft version.
com.google.common.collect.ImmutableSet<PacketListener>	getPacketListeners() Retrieves a list of every registered packet listener.
java.util.Set<java.lang.Integer>	getReceivingFilters() Deprecated.
java.util.Set<PacketType>	getReceivingFilterTypes() Retrieves a immutable set containing the type of the received client packets that will be observed by listeners.
java.util.Set<java.lang.Integer>	getSendingFilters() Deprecated.
java.util.Set<PacketType>	getSendingFilterTypes() Retrieves a immutable set containing the type of the sent server packets that will be observed by listeners.
boolean	isClosed() Determines whether or not this protocol manager has been disabled.
void	recieveClientPacket(org.bukkit.entity.Player sender, PacketContainer packet, boolean filters) Simulate receiving a certain packet from a given player.
void	removePacketListener(PacketListener listener) Removes a given packet listener.
void	removePacketListeners(org.bukkit.plugin.Plugin plugin) Removes every listener associated with the given plugin.
void	sendServerPacket(org.bukkit.entity.Player receiver, PacketContainer packet, boolean filters) Send a packet to the given player.
void	updateEntity(org.bukkit.entity.Entity entity, java.util.List<org.bukkit.entity.Player> observers) Completely resend an entity to a list of clients.

Methods inherited from interface com.comphenix.protocol.PacketStream

recieveClientPacket, recieveClientPacket, sendServerPacket, sendServerPacket

Method Detail

sendServerPacket

void sendServerPacket(org.bukkit.entity.Player receiver,
                    PacketContainer packet,
                    boolean filters)
                      throws java.lang.reflect.InvocationTargetException

Send a packet to the given player.

Re-sending a previously cancelled packet is discouraged. Use AsyncMarker.incrementProcessingDelay() to delay a packet until a certain condition has been met.

Specified by:

sendServerPacket in interface PacketStream

Parameters:

receiver - - the receiver.

packet - - packet to send.

filters - - whether or not to invoke any packet filters below ListenerPriority.MONITOR.

Throws:

java.lang.reflect.InvocationTargetException - - if an error occurred when sending the packet.

recieveClientPacket

void recieveClientPacket(org.bukkit.entity.Player sender,
                       PacketContainer packet,
                       boolean filters)
                         throws java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException

Simulate receiving a certain packet from a given player.

Receiving a previously cancelled packet is discouraged. Use AsyncMarker.incrementProcessingDelay() to delay a packet until a certain condition has been met.

Specified by:

recieveClientPacket in interface PacketStream

Parameters:

sender - - the sender.

packet - - the packet that was sent.

filters - - whether or not to invoke any packet filters below ListenerPriority.MONITOR.

Throws:

java.lang.reflect.InvocationTargetException - If the reflection machinery failed.

java.lang.IllegalAccessException - If the underlying method caused an error.

broadcastServerPacket

void broadcastServerPacket(PacketContainer packet)

Broadcast a given packet to every connected player on the server.

Parameters:

packet - - the packet to broadcast.

Throws:

FieldAccessException - If we were unable to send the packet due to reflection problems.

broadcastServerPacket

void broadcastServerPacket(PacketContainer packet,
                         org.bukkit.entity.Entity entity,
                         boolean includeTracker)

Broadcast a packet to every player that is receiving information about a given entity.

This is usually every player in the same world within an observable distance. If the entity is a player, it will only be included if includeTracker is TRUE.

Parameters:

packet - - the packet to broadcast.

entity - - the entity whose trackers we will inform.

includeTracker - - whether or not to also transmit the packet to the entity, if it is a tracker.

Throws:

FieldAccessException - If we were unable to send the packet due to reflection problems.

broadcastServerPacket

void broadcastServerPacket(PacketContainer packet,
                         org.bukkit.Location origin,
                         int maxObserverDistance)

Broadcast a packet to every player within the given maximum observer distance.

Parameters:

packet - - the packet to broadcast.

origin - - the origin to consider when calculating the distance to each observer.

maxObserverDistance - - the maximum distance to the origin.

getPacketListeners

com.google.common.collect.ImmutableSet<PacketListener> getPacketListeners()

Retrieves a list of every registered packet listener.

Returns:

Every registered packet listener.

addPacketListener

void addPacketListener(PacketListener listener)

Adds a packet listener.

Adding an already registered listener has no effect. If you need to change the packets the current listener is observing, you must first remove the packet listener before you can register it again.

Parameters:

listener - - new packet listener.

removePacketListener

void removePacketListener(PacketListener listener)

Removes a given packet listener.

Attempting to remove a listener that doesn't exist has no effect.

Parameters:

listener - - the packet listener to remove.

removePacketListeners

void removePacketListeners(org.bukkit.plugin.Plugin plugin)

Removes every listener associated with the given plugin.

Parameters:

plugin - - the plugin to unload.

createPacket

@Deprecated
PacketContainer createPacket(int id)

Deprecated.

Constructs a new encapsulated Minecraft packet with the given ID.

Deprecated: Use createPacket(PacketType) instead.

Parameters:

id - - packet ID.

Returns:

New encapsulated Minecraft packet.

createPacket

PacketContainer createPacket(PacketType type)

Constructs a new encapsulated Minecraft packet with the given ID.

Parameters:

type - - packet type.

Returns:

New encapsulated Minecraft packet.

createPacket

@Deprecated
PacketContainer createPacket(int id,
                                      boolean forceDefaults)

Deprecated.

Constructs a new encapsulated Minecraft packet with the given ID.

If set to true, the forceDefaults option will force the system to automatically give non-primitive fields in the packet sensible default values. For instance, certain packets - like Packet60Explosion - require a List or Set to be non-null. If the forceDefaults option is true, the List or Set will be automatically created.

Deprecated: Use createPacket(PacketType, boolean) instead.

Parameters:

id - - packet ID.

forceDefaults - - TRUE to use sensible defaults in most fields, FALSE otherwise.

Returns:

New encapsulated Minecraft packet.

createPacket

PacketContainer createPacket(PacketType type,
                           boolean forceDefaults)

Constructs a new encapsulated Minecraft packet with the given ID.

If set to true, the forceDefaults option will force the system to automatically give non-primitive fields in the packet sensible default values. For instance, certain packets - like Packet60Explosion - require a List or Set to be non-null. If the forceDefaults option is true, the List or Set will be automatically created.

Parameters:

type - - packet type.

forceDefaults - - TRUE to use sensible defaults in most fields, FALSE otherwise.

Returns:

New encapsulated Minecraft packet.

createPacketConstructor

@Deprecated
PacketConstructor createPacketConstructor(int id,
                                                   java.lang.Object... arguments)

Deprecated.

Construct a packet using the special builtin Minecraft constructors.

Deprecated: Use createPacketConstructor(PacketType, Object...) instead.

Parameters:

id - - the packet ID.

arguments - - arguments that will be passed to the constructor.

Returns:

The packet constructor.

createPacketConstructor

PacketConstructor createPacketConstructor(PacketType type,
                                        java.lang.Object... arguments)

Construct a packet using the special builtin Minecraft constructors.

Parameters:

id - - the packet type.

arguments - - arguments that will be passed to the constructor.

Returns:

The packet constructor.

updateEntity

void updateEntity(org.bukkit.entity.Entity entity,
                java.util.List<org.bukkit.entity.Player> observers)
                  throws FieldAccessException

Completely resend an entity to a list of clients.

Note that this method is NOT thread safe. If you call this method from anything but the main thread, it will throw an exception.

Parameters:

entity - - entity to refresh.

observers - - the clients to update.

Throws:

FieldAccessException

getEntityFromID

org.bukkit.entity.Entity getEntityFromID(org.bukkit.World container,
                                       int id)
                                         throws FieldAccessException

Retrieve the associated entity.

Parameters:

container - - the world the entity belongs to.

id - - the unique ID of the entity.

Returns:

The associated entity.

Throws:

FieldAccessException - Reflection failed.

getEntityTrackers

java.util.List<org.bukkit.entity.Player> getEntityTrackers(org.bukkit.entity.Entity entity)
                                                           throws FieldAccessException

Retrieve every client that is receiving information about a given entity.

Parameters:

entity - - the entity that is being tracked.

Returns:

Every client/player that is tracking the given entity.

Throws:

FieldAccessException - If reflection failed.

getSendingFilters

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

Deprecated.

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

Deprecated: Use getSendingFilterTypes() instead.

Returns:

Every filtered server packet.

getSendingFilterTypes

java.util.Set<PacketType> getSendingFilterTypes()

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

Returns:

Every filtered server packet.

getReceivingFilters

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

Deprecated.

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

Deprecated: Use getReceivingFilterTypes() instead.

Returns:

Every filtered client packet.

getReceivingFilterTypes

java.util.Set<PacketType> getReceivingFilterTypes()

Retrieves a immutable set containing the type of the received client packets that will be observed by listeners.

Returns:

Every filtered client packet.

getMinecraftVersion

MinecraftVersion getMinecraftVersion()

Retrieve the current Minecraft version.

Returns:

The current version.

isClosed

boolean isClosed()

Determines whether or not this protocol manager has been disabled.

Returns:

TRUE if it has, FALSE otherwise.

getAsynchronousManager

AsynchronousManager getAsynchronousManager()

Retrieve the current asynchronous packet manager.

Returns:

Asynchronous packet manager.