us.myles.ViaVersion.api.protocol

Class ProtocolPipeline

java.lang.Object

us.myles.ViaVersion.api.protocol.Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

us.myles.ViaVersion.api.protocol.SimpleProtocol

us.myles.ViaVersion.api.protocol.ProtocolPipeline

public class ProtocolPipeline
extends SimpleProtocol

Nested Class Summary

Nested classes/interfaces inherited from class us.myles.ViaVersion.api.protocol.SimpleProtocol

SimpleProtocol.DummyPacketTypes

Nested classes/interfaces inherited from class us.myles.ViaVersion.api.protocol.Protocol

Protocol.Packet, Protocol.ProtocolPacket

Field Summary

Fields inherited from class us.myles.ViaVersion.api.protocol.Protocol

newClientboundPacketEnum, newServerboundPacketEnum, oldClientboundPacketEnum, oldServerboundPacketEnum

Constructor Summary

Constructors

Constructor and Description
ProtocolPipeline(UserConnection userConnection)

Method Summary

Modifier and Type	Method and Description
void	add(Protocol protocol) Add a protocol to the current pipeline This will call the Protocol.init(UserConnection) method.
void	cleanPipes() Cleans the pipe and adds BaseProtocol /!\ WARNING - It doesn't add version-specific base Protocol
boolean	contains(Class<? extends Protocol> pipeClass) Check if the pipeline contains a protocol
boolean	filter(Object o, List list) Use the pipeline to filter a NMS packet
<P extends Protocol> P	getProtocol(Class<P> pipeClass)
void	init(UserConnection userConnection) Initialise a user for this protocol setting up objects.
List<Protocol>	pipes()
protected void	registerPackets() Register the packets for this protocol.
void	transform(Direction direction, State state, PacketWrapper packetWrapper) Transform a packet using this protocol

Methods inherited from class us.myles.ViaVersion.api.protocol.Protocol

cancelIncoming, cancelIncoming, cancelIncoming, cancelOutgoing, cancelOutgoing, cancelOutgoing, filterPacket, get, getMappingData, hasMappingDataToLoad, hasRegisteredIncoming, hasRegisteredOutgoing, isFiltered, loadMappingData, onMappingDataLoaded, put, register, registerIncoming, registerIncoming, registerIncoming, registerIncoming, registerIncoming, registerIncomingChannelIdChanges, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoing, registerOutgoingChannelIdChanges, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolPipeline

public ProtocolPipeline(UserConnection userConnection)

Method Detail

registerPackets

protected void registerPackets()

Description copied from class: Protocol

Register the packets for this protocol. To be overriden.

Overrides:

registerPackets in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

init

public void init(UserConnection userConnection)

Description copied from class: Protocol

Initialise a user for this protocol setting up objects. /!\ WARNING - May be called more than once in a single UserConnection

To be overridden if needed.

Overrides:

init in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

Parameters:

userConnection - The user to initialise

add

public void add(Protocol protocol)

Add a protocol to the current pipeline This will call the Protocol.init(UserConnection) method.

Parameters:

protocol - The protocol to add to the end

transform

public void transform(Direction direction,
                      State state,
                      PacketWrapper packetWrapper)
               throws Exception

Description copied from class: Protocol

Transform a packet using this protocol

Overrides:

transform in class Protocol<SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes,SimpleProtocol.DummyPacketTypes>

Parameters:

direction - The direction the packet is going in

state - The current protocol state

packetWrapper - The packet wrapper to transform

Throws:

Exception - Throws exception if it fails to transform

contains

public boolean contains(Class<? extends Protocol> pipeClass)

Check if the pipeline contains a protocol

Parameters:

pipeClass - The class to check

Returns:

True if the protocol class is in the pipeline

getProtocol

public <P extends Protocol> P getProtocol(Class<P> pipeClass)

filter

public boolean filter(Object o,
                      List list)
               throws Exception

Use the pipeline to filter a NMS packet

Parameters:

o - The NMS packet object

list - The output list to write to

Returns:

If it should not write the input object to te list.

Throws:

Exception - If it failed to convert / packet cancelld.

pipes

public List<Protocol> pipes()

cleanPipes

public void cleanPipes()

Cleans the pipe and adds BaseProtocol /!\ WARNING - It doesn't add version-specific base Protocol