com.comphenix.protocol.injector.netty

Class ChannelInjector

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

com.comphenix.protocol.injector.netty.ChannelInjector

All Implemented Interfaces:

Injector, io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class ChannelInjector
extends io.netty.handler.codec.ByteToMessageDecoder
implements Injector

Represents a channel injector.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelInjector.ChannelSocketInjector Represents a socket injector that foreards to the current channel injector.

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	REPORT_CANNOT_EXECUTE_IN_CHANNEL_THREAD
static ReportType	REPORT_CANNOT_FIND_GET_VERSION
static ReportType	REPORT_CANNOT_INTERCEPT_CLIENT_PACKET
static ReportType	REPORT_CANNOT_INTERCEPT_SERVER_PACKET
static ReportType	REPORT_CANNOT_SEND_PACKET

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor and Description
ChannelInjector(org.bukkit.entity.Player player, Object networkManager, io.netty.channel.Channel channel, ChannelListener channelListener, InjectionFactory factory) Construct a new channel injector.

Method Summary

Modifier and Type	Method and Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	close() Close the current injector.
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf byteBuffer, List<Object> packets)
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, Object packet, io.netty.buffer.ByteBuf output) Encode a packet to a byte buffer, taking over for the standard Minecraft encoder.
protected void	encodeWirePacket(WirePacket packet, io.netty.buffer.ByteBuf output)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
protected void	finalWrite(io.netty.channel.ChannelHandlerContext ctx, Object packet, io.netty.channel.ChannelPromise promise) Invoked when a packet has been written to the channel.
static io.netty.channel.ChannelHandler	findChannelHandler(io.netty.channel.Channel channel, Class<?> clazz) Find the first channel handler that is assignable to a given type.
protected void	finishRead(io.netty.channel.ChannelHandlerContext ctx, Object msg) Invoked after our decoder.
io.netty.channel.Channel	getChannel()
PacketType.Protocol	getCurrentProtocol() Retrieve the current protocol state.
NetworkMarker	getMarker(Object packet) Retrieve the network marker associated with a given packet.
org.bukkit.entity.Player	getPlayer() Retrieve the current player or temporary player associated with the injector.
int	getProtocolVersion() Get the version of the current protocol.
protected void	handleLogin(Class<?> packetClass, Object packet) Invoked when we may need to handle the login packet.
boolean	inject() Inject the current channel.
boolean	isClosed() Determine if this channel has been closed and cleaned up.
boolean	isInjected() Determine if the channel has already been injected.
void	recieveClientPacket(Object packet) Recieve a packet on the server.
void	saveMarker(Object packet, NetworkMarker marker) Associate a given network marker with a specific packet.
void	sendServerPacket(Object packet, NetworkMarker marker, boolean filtered) Send a packet to a player's client.
void	setPlayer(org.bukkit.entity.Player player) Set the player instance.
void	setUpdatedPlayer(org.bukkit.entity.Player updated) Set the updated player instance.

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Field Detail

REPORT_CANNOT_INTERCEPT_SERVER_PACKET

public static final ReportType REPORT_CANNOT_INTERCEPT_SERVER_PACKET

REPORT_CANNOT_INTERCEPT_CLIENT_PACKET

public static final ReportType REPORT_CANNOT_INTERCEPT_CLIENT_PACKET

REPORT_CANNOT_EXECUTE_IN_CHANNEL_THREAD

public static final ReportType REPORT_CANNOT_EXECUTE_IN_CHANNEL_THREAD

REPORT_CANNOT_FIND_GET_VERSION

public static final ReportType REPORT_CANNOT_FIND_GET_VERSION

REPORT_CANNOT_SEND_PACKET

public static final ReportType REPORT_CANNOT_SEND_PACKET

Constructor Detail

ChannelInjector

public ChannelInjector(org.bukkit.entity.Player player,
                       Object networkManager,
                       io.netty.channel.Channel channel,
                       ChannelListener channelListener,
                       InjectionFactory factory)

Construct a new channel injector.

Parameters:

player - - the current player, or temporary player.

networkManager - - its network manager.

channel - - its channel.

channelListener - - a listener.

factory - - the factory that created this injector

Method Detail

getProtocolVersion

public int getProtocolVersion()

Get the version of the current protocol.

Specified by:

getProtocolVersion in interface Injector

Returns:

The version.

inject

public boolean inject()

Description copied from interface: Injector

Inject the current channel.

Note that only active channels can be injected.

Specified by:

inject in interface Injector

Returns:

TRUE if we injected the channel, false if we could not inject or it was already injected.

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

encodeWirePacket

protected void encodeWirePacket(WirePacket packet,
                                io.netty.buffer.ByteBuf output)
                         throws Exception

Throws:

Exception

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
                      Object packet,
                      io.netty.buffer.ByteBuf output)
               throws Exception

Encode a packet to a byte buffer, taking over for the standard Minecraft encoder.

Parameters:

ctx - - the current context.

packet - - the packet to encode to a byte array.

output - - the output byte array.

Throws:

Exception - If anything went wrong.

finalWrite

protected void finalWrite(io.netty.channel.ChannelHandlerContext ctx,
                          Object packet,
                          io.netty.channel.ChannelPromise promise)

Invoked when a packet has been written to the channel.

Parameters:

ctx - - current context.

packet - - the packet that has been written.

promise - - a promise.

decode

protected void decode(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.buffer.ByteBuf byteBuffer,
                      List<Object> packets)
               throws Exception

Specified by:

decode in class io.netty.handler.codec.ByteToMessageDecoder

Throws:

Exception

finishRead

protected void finishRead(io.netty.channel.ChannelHandlerContext ctx,
                          Object msg)

Invoked after our decoder.

Parameters:

ctx - - current context.

msg - - the current packet.

handleLogin

protected void handleLogin(Class<?> packetClass,
                           Object packet)

Invoked when we may need to handle the login packet.

Parameters:

packetClass - - the packet class.

packet - - the packet.

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

sendServerPacket

public void sendServerPacket(Object packet,
                             NetworkMarker marker,
                             boolean filtered)

Description copied from interface: Injector

Send a packet to a player's client.

Specified by:

sendServerPacket in interface Injector

Parameters:

packet - - the packet to send.

marker - - the network marker.

filtered - - whether or not the packet is filtered.

recieveClientPacket

public void recieveClientPacket(Object packet)

Description copied from interface: Injector

Recieve a packet on the server.

Specified by:

recieveClientPacket in interface Injector

Parameters:

packet - - the (NMS) packet to send.

getCurrentProtocol

public PacketType.Protocol getCurrentProtocol()

Description copied from interface: Injector

Retrieve the current protocol state.

Specified by:

getCurrentProtocol in interface Injector

Returns:

The current protocol.

getMarker

public NetworkMarker getMarker(Object packet)

Description copied from interface: Injector

Retrieve the network marker associated with a given packet.

Specified by:

getMarker in interface Injector

Parameters:

packet - - the packet.

Returns:

The network marker.

saveMarker

public void saveMarker(Object packet,
                       NetworkMarker marker)

Description copied from interface: Injector

Associate a given network marker with a specific packet.

Specified by:

saveMarker in interface Injector

Parameters:

packet - - the NMS packet.

marker - - the associated marker.

getPlayer

public org.bukkit.entity.Player getPlayer()

Description copied from interface: Injector

Retrieve the current player or temporary player associated with the injector.

Specified by:

getPlayer in interface Injector

Returns:

The current player.

setPlayer

public void setPlayer(org.bukkit.entity.Player player)

Set the player instance.

Specified by:

setPlayer in interface Injector

Parameters:

player - - current instance.

setUpdatedPlayer

public void setUpdatedPlayer(org.bukkit.entity.Player updated)

Set the updated player instance.

Specified by:

setUpdatedPlayer in interface Injector

Parameters:

updated - - updated instance.

isInjected

public boolean isInjected()

Description copied from interface: Injector

Determine if the channel has already been injected.

Specified by:

isInjected in interface Injector

Returns:

TRUE if it has, FALSE otherwise.

isClosed

public boolean isClosed()

Determine if this channel has been closed and cleaned up.

Specified by:

isClosed in interface Injector

Returns:

TRUE if it has, FALSE otherwise.

close

public void close()

Description copied from interface: Injector

Close the current injector.

Specified by:

close in interface Injector

findChannelHandler

public static io.netty.channel.ChannelHandler findChannelHandler(io.netty.channel.Channel channel,
                                                                 Class<?> clazz)

Find the first channel handler that is assignable to a given type.

Parameters:

channel - - the channel.

clazz - - the type.

Returns:

The first handler, or NULL.

getChannel

public io.netty.channel.Channel getChannel()