net.minecraftforge.fml.common.network

Class FMLEmbeddedChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.embedded.EmbeddedChannel

net.minecraftforge.fml.common.network.FMLEmbeddedChannel

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, io.netty.util.AttributeMap, java.lang.Comparable<io.netty.channel.Channel>

public class FMLEmbeddedChannel
extends io.netty.channel.embedded.EmbeddedChannel

Utility wrapper around EmbeddedChannel. Provides some convenience methods associated with the specific needs of FML network handling.

Author:

cpw

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

io.netty.channel.AbstractChannel.AbstractUnsafe

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

io.netty.channel.Channel.Unsafe

Constructor Summary

Constructors

Constructor and Description
FMLEmbeddedChannel(ModContainer container, java.lang.String channelName, Side source, io.netty.channel.ChannelHandler... handlers)
FMLEmbeddedChannel(java.lang.String channelName, Side source, io.netty.channel.ChannelHandler... handlers)

Method Summary

Modifier and Type	Method and Description
void	cleanAttributes()
java.lang.String	findChannelHandlerNameForType(java.lang.Class<? extends io.netty.channel.ChannelHandler> type)
Packet<?>	generatePacketFrom(java.lang.Object object) Utility method to generate a regular packet from a custom packet.

Methods inherited from class io.netty.channel.embedded.EmbeddedChannel

checkException, close, close, config, disconnect, disconnect, doBeginRead, doBind, doClose, doDisconnect, doRegister, doWrite, ensureOpen, finish, finishAndReleaseAll, flushInbound, flushOutbound, handleInboundMessage, handleOutboundMessage, inboundMessages, isActive, isCompatible, isOpen, lastInboundBuffer, lastOutboundBuffer, localAddress0, metadata, newChannelPipeline, newUnsafe, outboundMessages, readInbound, readOutbound, releaseInbound, releaseOutbound, remoteAddress0, runPendingTasks, runScheduledPendingTasks, writeInbound, writeOneInbound, writeOneInbound, writeOneOutbound, writeOneOutbound, writeOutbound

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, doDeregister, equals, eventLoop, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Constructor Detail

FMLEmbeddedChannel

public FMLEmbeddedChannel(java.lang.String channelName,
                          Side source,
                          io.netty.channel.ChannelHandler... handlers)

FMLEmbeddedChannel

public FMLEmbeddedChannel(ModContainer container,
                          java.lang.String channelName,
                          Side source,
                          io.netty.channel.ChannelHandler... handlers)

Method Detail

generatePacketFrom

public Packet<?> generatePacketFrom(java.lang.Object object)

Utility method to generate a regular packet from a custom packet. Basically, it writes the packet through the outbound side which should have a message to message codec present (such as FMLIndexedMessageToMessageCodec, transforming from mod packets to standard FMLProxyPackets. This is mostly useful in cases where vanilla expects a packet, such as the TileEntity getDescriptionPacket.

Parameters:

object - The inbound packet

Returns:

A Packet suitable for passing to vanilla network code.

findChannelHandlerNameForType

@Nullable
public java.lang.String findChannelHandlerNameForType(java.lang.Class<? extends io.netty.channel.ChannelHandler> type)

cleanAttributes

public void cleanAttributes()