us.myles.ViaVersion.api

Class PacketWrapper

java.lang.Object

us.myles.ViaVersion.api.PacketWrapper

public class PacketWrapper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	PASSTHROUGH_ID

Constructor Summary

Constructors

Constructor and Description
PacketWrapper(int packetID, io.netty.buffer.ByteBuf inputBuffer, UserConnection userConnection)

Method Summary

Modifier and Type	Method and Description
PacketWrapper	apply(Direction direction, State state, int index, List<Protocol> pipeline)
PacketWrapper	apply(Direction direction, State state, int index, List<Protocol> pipeline, boolean reverse) Applies a pipeline from an index to the wrapper.
void	cancel() Cancel this packet from sending
void	clearInputBuffer() Clear the input buffer / readable objects
void	clearPacket() Clear the packet, used if you have to change the packet completely
PacketWrapper	create(int packetID) Create a new packet for the target of this packet.
PacketWrapper	create(int packetID, ValueCreator init) Create a new packet with values.
<T> T	get(Type<T> type, int index) Get a part from the output
int	getId()
boolean	is(Type type, int index) Check if a type is at an index
boolean	isCancelled() Check if this packet is cancelled.
boolean	isReadable(Type type, int index) Check if a type is at an index
<T> T	passthrough(Type<T> type) Take a value from the input and write to the output.
void	passthroughAll() Take all the inputs and write them to the output.
<T> T	read(Type<T> type) Read a type from the input.
void	resetReader() Reset the reader, so that it can be read again.
void	send() Deprecated.
void	send(Class<? extends Protocol> packetProtocol) Send this packet to the associated user.
void	send(Class<? extends Protocol> packetProtocol, boolean skipCurrentPipeline) Send this packet to the associated user.
void	send(Class<? extends Protocol> packetProtocol, boolean skipCurrentPipeline, boolean currentThread) Send this packet to the associated user.
io.netty.channel.ChannelFuture	sendFuture(Class<? extends Protocol> packetProtocol) Send this packet to the associated user.
void	sendToServer() Deprecated.
void	sendToServer(Class<? extends Protocol> packetProtocol)
void	sendToServer(Class<? extends Protocol> packetProtocol, boolean skipCurrentPipeline)
void	sendToServer(Class<? extends Protocol> packetProtocol, boolean skipCurrentPipeline, boolean currentThread) Send this packet to the server.
<T> void	set(Type<T> type, int index, T value) Set a currently existing part in the output
void	setId(int id)
String	toString()
UserConnection	user() Get the user associated with this Packet
<T> void	write(Type<T> type, T value) Write a type to the output.
void	writeToBuffer(io.netty.buffer.ByteBuf buffer) Write the current output to a buffer.

Methods inherited from class java.lang.Object

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

Field Detail

PASSTHROUGH_ID

public static final int PASSTHROUGH_ID

See Also:

Constant Field Values

Constructor Detail

PacketWrapper

public PacketWrapper(int packetID,
                     io.netty.buffer.ByteBuf inputBuffer,
                     UserConnection userConnection)

Method Detail

get

public <T> T get(Type<T> type,
                 int index)
          throws Exception

Get a part from the output

Type Parameters:

T - The return type of the type you wish to get.

Parameters:

type - The type of the part you wish to get.

index - The index of the part (relative to the type)

Returns:

The requested type or throws ArrayIndexOutOfBounds

Throws:

InformativeException - If it fails to find it, an exception will be thrown.

Exception

is

public boolean is(Type type,
                  int index)

Check if a type is at an index

Parameters:

type - The type of the part you wish to get.

index - The index of the part (relative to the type)

Returns:

True if the type is at the index

isReadable

public boolean isReadable(Type type,
                          int index)

Check if a type is at an index

Parameters:

type - The type of the part you wish to get.

index - The index of the part (relative to the type)

Returns:

True if the type is at the index

set

public <T> void set(Type<T> type,
                    int index,
                    T value)
             throws Exception

Set a currently existing part in the output

Type Parameters:

T - The return type of the type you wish to set.

Parameters:

type - The type of the part you wish to set.

index - The index of the part (relative to the type)

value - The value of the part you wish to set it to.

Throws:

InformativeException - If it fails to set it, an exception will be thrown.

Exception

read

public <T> T read(Type<T> type)
           throws Exception

Read a type from the input.

Type Parameters:

T - The return type of the type you wish to read.

Parameters:

type - The type you wish to read

Returns:

The requested type

Throws:

InformativeException - If it fails to read

Exception

write

public <T> void write(Type<T> type,
                      T value)

Write a type to the output.

Type Parameters:

T - The return type of the type you wish to write.

Parameters:

type - The type to write.

value - The value of the type to write.

passthrough

public <T> T passthrough(Type<T> type)
                  throws Exception

Take a value from the input and write to the output.

Type Parameters:

T - The return type of the type you wish to pass through.

Parameters:

type - The type to read and write.

Returns:

The type which was read/written.

Throws:

Exception - If it failed to read or write

passthroughAll

public void passthroughAll()
                    throws Exception

Take all the inputs and write them to the output.

Throws:

Exception - If it failed to read or write

writeToBuffer

public void writeToBuffer(io.netty.buffer.ByteBuf buffer)
                   throws Exception

Write the current output to a buffer.

Parameters:

buffer - The buffer to write to.

Throws:

InformativeException - Throws an exception if it fails to write a value.

Exception

clearInputBuffer

public void clearInputBuffer()

Clear the input buffer / readable objects

clearPacket

public void clearPacket()

Clear the packet, used if you have to change the packet completely

send

public void send(Class<? extends Protocol> packetProtocol,
                 boolean skipCurrentPipeline)
          throws Exception

Send this packet to the associated user. Be careful not to send packets twice. (Sends it after current)

Parameters:

packetProtocol - The protocol version of the packet.

skipCurrentPipeline - Skip the current pipeline

Throws:

Exception - if it fails to write

send

public void send(Class<? extends Protocol> packetProtocol,
                 boolean skipCurrentPipeline,
                 boolean currentThread)
          throws Exception

Send this packet to the associated user. Be careful not to send packets twice. (Sends it after current)

Parameters:

packetProtocol - The protocol version of the packet.

skipCurrentPipeline - Skip the current pipeline

currentThread - Run in the same thread

Throws:

Exception - if it fails to write

send

public void send(Class<? extends Protocol> packetProtocol)
          throws Exception

Send this packet to the associated user. Be careful not to send packets twice. (Sends it after current)

Parameters:

packetProtocol - The protocol version of the packet.

Throws:

Exception - if it fails to write

sendFuture

public io.netty.channel.ChannelFuture sendFuture(Class<? extends Protocol> packetProtocol)
                                          throws Exception

Send this packet to the associated user. Be careful not to send packets twice. (Sends it after current) Also returns the packets ChannelFuture

Parameters:

packetProtocol - The protocol version of the packet.

Returns:

The packets ChannelFuture

Throws:

Exception - if it fails to write

send

@Deprecated
public void send()
                      throws Exception

Deprecated.

Send this packet to the associated user. Be careful not to send packets twice. (Sends it after current) This method is no longer used, it's favoured to use send(Class) as it will handle the pipeline properly.

Throws:

Exception - if it fails to write

create

public PacketWrapper create(int packetID)

Create a new packet for the target of this packet.

Parameters:

packetID - The ID of the new packet

Returns:

The newly created packet wrapper

create

public PacketWrapper create(int packetID,
                            ValueCreator init)
                     throws Exception

Create a new packet with values.

Parameters:

packetID - The ID of the new packet

init - A ValueCreator to write to the packet.

Returns:

The newly created packet wrapper

Throws:

Exception - If it failed to write the values from the ValueCreator.

apply

public PacketWrapper apply(Direction direction,
                           State state,
                           int index,
                           List<Protocol> pipeline,
                           boolean reverse)
                    throws Exception

Applies a pipeline from an index to the wrapper.

Parameters:

direction - protocol direction

state - protocol state

index - index to start from, will be reversed depending on the reverse parameter

pipeline - protocol pipeline

reverse - whether the array should be looped in reverse, will also reverse the given index

Returns:

The current packetwrapper

Throws:

Exception - If it fails to transform a packet, exception will be thrown

apply

public PacketWrapper apply(Direction direction,
                           State state,
                           int index,
                           List<Protocol> pipeline)
                    throws Exception

Throws:

Exception

See Also:

apply(Direction, State, int, List, boolean)

cancel

public void cancel()

Cancel this packet from sending

isCancelled

public boolean isCancelled()

Check if this packet is cancelled.

Returns:

True if the packet won't be sent.

user

public UserConnection user()

Get the user associated with this Packet

Returns:

The user

resetReader

public void resetReader()

Reset the reader, so that it can be read again.

sendToServer

@Deprecated
public void sendToServer()
                              throws Exception

Deprecated.

Send the current packet to the server. (Ensure the ID is suitable for viaversion)

Throws:

Exception - If it failed to write

sendToServer

public void sendToServer(Class<? extends Protocol> packetProtocol,
                         boolean skipCurrentPipeline,
                         boolean currentThread)
                  throws Exception

Send this packet to the server.

Parameters:

packetProtocol - The protocol version of the packet.

skipCurrentPipeline - Skip the current pipeline

currentThread - Run in the same thread

Throws:

Exception - if it fails to write

sendToServer

public void sendToServer(Class<? extends Protocol> packetProtocol,
                         boolean skipCurrentPipeline)
                  throws Exception

Throws:

Exception

sendToServer

public void sendToServer(Class<? extends Protocol> packetProtocol)
                  throws Exception

Throws:

Exception

getId

public int getId()

setId

public void setId(int id)

toString

public String toString()

Overrides:

toString in class Object