From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- .../cpw/mods/fml/common/network/ByteBufUtils.html | 461 ++++++++++++ .../fml/common/network/FMLEmbeddedChannel.html | 369 ++++++++++ .../mods/fml/common/network/FMLEventChannel.html | 354 +++++++++ .../network/FMLIndexedMessageToMessageCodec.html | 527 ++++++++++++++ ...LNetworkEvent.ClientConnectedToServerEvent.html | 328 +++++++++ .../FMLNetworkEvent.ClientCustomPacketEvent.html | 331 +++++++++ ...rkEvent.ClientDisconnectionFromServerEvent.html | 285 ++++++++ .../FMLNetworkEvent.CustomNetworkEvent.html | 294 ++++++++ .../network/FMLNetworkEvent.CustomPacketEvent.html | 329 +++++++++ ...NetworkEvent.CustomPacketRegistrationEvent.html | 348 +++++++++ ...tworkEvent.ServerConnectionFromClientEvent.html | 313 ++++++++ .../FMLNetworkEvent.ServerCustomPacketEvent.html | 331 +++++++++ ...rkEvent.ServerDisconnectionFromClientEvent.html | 285 ++++++++ .../mods/fml/common/network/FMLNetworkEvent.html | 331 +++++++++ .../fml/common/network/FMLNetworkException.html | 277 ++++++++ .../network/FMLOutboundHandler.OutboundTarget.html | 484 +++++++++++++ .../fml/common/network/FMLOutboundHandler.html | 376 ++++++++++ .../cpw/mods/fml/common/network/IGuiHandler.html | 249 +++++++ .../fml/common/network/NetworkCheckHandler.html | 164 +++++ .../common/network/NetworkEventFiringHandler.html | 342 +++++++++ .../network/NetworkHandshakeEstablished.html | 298 ++++++++ .../network/NetworkRegistry.TargetPoint.html | 331 +++++++++ .../mods/fml/common/network/NetworkRegistry.html | 726 +++++++++++++++++++ .../handshake/ChannelRegistrationHandler.html | 349 +++++++++ .../network/handshake/FMLHandshakeCodec.html | 386 ++++++++++ .../handshake/FMLHandshakeMessage.ClientHello.html | 319 +++++++++ .../FMLHandshakeMessage.HandshakeAck.html | 323 +++++++++ .../FMLHandshakeMessage.HandshakeReset.html | 257 +++++++ .../handshake/FMLHandshakeMessage.ModIdData.html | 374 ++++++++++ .../handshake/FMLHandshakeMessage.ModList.html | 374 ++++++++++ .../handshake/FMLHandshakeMessage.ServerHello.html | 319 +++++++++ .../network/handshake/FMLHandshakeMessage.html | 336 +++++++++ .../network/handshake/HandshakeInjector.html | 316 ++++++++ .../network/handshake/HandshakeMessageHandler.html | 393 ++++++++++ .../common/network/handshake/IHandshakeState.html | 206 ++++++ .../network/handshake/NetworkDispatcher.html | 791 +++++++++++++++++++++ .../common/network/handshake/package-frame.html | 34 + .../common/network/handshake/package-summary.html | 190 +++++ .../fml/common/network/handshake/package-tree.html | 172 +++++ .../network/internal/EntitySpawnHandler.html | 349 +++++++++ .../internal/FMLMessage.CompleteHandshake.html | 262 +++++++ .../internal/FMLMessage.EntityAdjustMessage.html | 273 +++++++ .../network/internal/FMLMessage.EntityMessage.html | 254 +++++++ .../internal/FMLMessage.EntitySpawnMessage.html | 271 +++++++ .../network/internal/FMLMessage.OpenGui.html | 250 +++++++ .../fml/common/network/internal/FMLMessage.html | 265 +++++++ .../common/network/internal/FMLNetworkHandler.html | 454 ++++++++++++ .../common/network/internal/FMLProxyPacket.html | 464 ++++++++++++ .../common/network/internal/FMLRuntimeCodec.html | 408 +++++++++++ .../internal/HandshakeCompletionHandler.html | 350 +++++++++ .../internal/NetworkModHolder.NetworkChecker.html | 260 +++++++ .../common/network/internal/NetworkModHolder.html | 398 +++++++++++ .../common/network/internal/OpenGuiHandler.html | 349 +++++++++ .../fml/common/network/internal/package-frame.html | 31 + .../common/network/internal/package-summary.html | 179 +++++ .../fml/common/network/internal/package-tree.html | 173 +++++ .../cpw/mods/fml/common/network/package-frame.html | 53 ++ .../mods/fml/common/network/package-summary.html | 295 ++++++++ .../cpw/mods/fml/common/network/package-tree.html | 223 ++++++ .../fml/common/network/simpleimpl/IMessage.html | 226 ++++++ .../common/network/simpleimpl/IMessageHandler.html | 219 ++++++ .../common/network/simpleimpl/MessageContext.html | 290 ++++++++ .../simpleimpl/SimpleChannelHandlerWrapper.html | 371 ++++++++++ .../network/simpleimpl/SimpleIndexedCodec.html | 386 ++++++++++ .../network/simpleimpl/SimpleNetworkWrapper.html | 463 ++++++++++++ .../common/network/simpleimpl/package-frame.html | 27 + .../common/network/simpleimpl/package-summary.html | 170 +++++ .../common/network/simpleimpl/package-tree.html | 158 ++++ 68 files changed, 21143 insertions(+) create mode 100644 javadoc/cpw/mods/fml/common/network/ByteBufUtils.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLEventChannel.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLNetworkException.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html create mode 100644 javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/IGuiHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html create mode 100644 javadoc/cpw/mods/fml/common/network/NetworkRegistry.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/handshake/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/internal/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/package-tree.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html create mode 100644 javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html (limited to 'javadoc/cpw/mods/fml/common/network') diff --git a/javadoc/cpw/mods/fml/common/network/ByteBufUtils.html b/javadoc/cpw/mods/fml/common/network/ByteBufUtils.html new file mode 100644 index 0000000..52beba3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/ByteBufUtils.html @@ -0,0 +1,461 @@ + + + + + +ByteBufUtils (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class ByteBufUtils

+
+
+ +
+
    +
  • +
    +
    +
    public class ByteBufUtils
+extends java.lang.Object
    +
    Utilities for interacting with ByteBuf.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ByteBufUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringgetContentDump(io.netty.buffer.ByteBuf buffer) 
      static ItemStackreadItemStack(io.netty.buffer.ByteBuf from) +
      Read an ItemStack from the byte buffer provided.
      +
      static NBTTagCompoundreadTag(io.netty.buffer.ByteBuf from) +
      Read an NBTTagCompound from the byte buffer.
      +
      static java.lang.StringreadUTF8String(io.netty.buffer.ByteBuf from) +
      Read a UTF8 string from the byte buffer.
      +
      static intreadVarInt(io.netty.buffer.ByteBuf buf, + int maxSize) +
      Read a varint from the supplied buffer.
      +
      static intreadVarShort(io.netty.buffer.ByteBuf buf) +
      An extended length short.
      +
      static intvarIntByteCount(int toCount) +
      The number of bytes to write the supplied int using the 7 bit varint encoding.
      +
      static voidwriteItemStack(io.netty.buffer.ByteBuf to, + ItemStack stack) +
      Write an ItemStack using minecraft compatible encoding.
      +
      static voidwriteTag(io.netty.buffer.ByteBuf to, + NBTTagCompound tag) +
      Write an NBTTagCompound to the byte buffer.
      +
      static voidwriteUTF8String(io.netty.buffer.ByteBuf to, + java.lang.String string) +
      Write a String with UTF8 byte encoding to the buffer.
      +
      static voidwriteVarInt(io.netty.buffer.ByteBuf to, + int toWrite, + int maxSize) +
      Write an integer to the buffer using variable length encoding.
      +
      static voidwriteVarShort(io.netty.buffer.ByteBuf buf, + int toWrite) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ByteBufUtils

        +
        public ByteBufUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        varIntByteCount

        +
        public static int varIntByteCount(int toCount)
        +
        The number of bytes to write the supplied int using the 7 bit varint encoding.
        +
        Parameters:
        toCount - The number to analyse
        +
        Returns:
        The number of bytes it will take to write it (maximum of 5)
        +
        • +
      + + + +
        +
      • +

        readVarInt

        +
        public static int readVarInt(io.netty.buffer.ByteBuf buf,
+             int maxSize)
        +
        Read a varint from the supplied buffer.
        +
        Parameters:
        buf - The buffer to read from
        maxSize - The maximum length of bytes to read
        +
        Returns:
        The integer
        +
        • +
      + + + +
        +
      • +

        readVarShort

        +
        public static int readVarShort(io.netty.buffer.ByteBuf buf)
        +
        An extended length short. Used by custom payload packets to extend size.
        +
        Parameters:
        buf -
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        writeVarShort

        +
        public static void writeVarShort(io.netty.buffer.ByteBuf buf,
+                 int toWrite)
        +
        • +
      + + + +
        +
      • +

        writeVarInt

        +
        public static void writeVarInt(io.netty.buffer.ByteBuf to,
+               int toWrite,
+               int maxSize)
        +
        Write an integer to the buffer using variable length encoding. The maxSize constrains + how many bytes (and therefore the maximum number) that will be written.
        +
        Parameters:
        to - The buffer to write to
        toWrite - The integer to write
        maxSize - The maximum number of bytes to use
        +
        • +
      + + + +
        +
      • +

        readUTF8String

        +
        public static java.lang.String readUTF8String(io.netty.buffer.ByteBuf from)
        +
        Read a UTF8 string from the byte buffer. + It is encoded as []
        +
        Parameters:
        from - The buffer to read from
        +
        Returns:
        The string
        +
        • +
      + + + +
        +
      • +

        writeUTF8String

        +
        public static void writeUTF8String(io.netty.buffer.ByteBuf to,
+                   java.lang.String string)
        +
        Write a String with UTF8 byte encoding to the buffer. + It is encoded as []
        +
        Parameters:
        to - the buffer to write to
        string - The string to write
        +
        • +
      + + + +
        +
      • +

        writeItemStack

        +
        public static void writeItemStack(io.netty.buffer.ByteBuf to,
+                  ItemStack stack)
        +
        Write an ItemStack using minecraft compatible encoding.
        +
        Parameters:
        to - The buffer to write to
        stack - The itemstack to write
        +
        • +
      + + + +
        +
      • +

        readItemStack

        +
        public static ItemStack readItemStack(io.netty.buffer.ByteBuf from)
        +
        Read an ItemStack from the byte buffer provided. It uses the minecraft encoding.
        +
        Parameters:
        from - The buffer to read from
        +
        Returns:
        The itemstack read
        +
        • +
      + + + +
        +
      • +

        writeTag

        +
        public static void writeTag(io.netty.buffer.ByteBuf to,
+            NBTTagCompound tag)
        +
        Write an NBTTagCompound to the byte buffer. It uses the minecraft encoding.
        +
        Parameters:
        to - The buffer to write to
        tag - The tag to write
        +
        • +
      + + + +
        +
      • +

        readTag

        +
        public static NBTTagCompound readTag(io.netty.buffer.ByteBuf from)
        +
        Read an NBTTagCompound from the byte buffer. It uses the minecraft encoding.
        +
        Parameters:
        from - The buffer to read from
        +
        Returns:
        The read tag
        +
        • +
      + + + +
        +
      • +

        getContentDump

        +
        public static java.lang.String getContentDump(io.netty.buffer.ByteBuf buffer)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html b/javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html new file mode 100644 index 0000000..cbd25bf --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLEmbeddedChannel.html @@ -0,0 +1,369 @@ + + + + + +FMLEmbeddedChannel (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLEmbeddedChannel

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.Channel, 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.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringfindChannelHandlerNameForType(java.lang.Class<? extends io.netty.channel.ChannelHandler> type) 
      PacketgeneratePacketFrom(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, config, doBeginRead, doBind, doClose, doDisconnect, doRegister, doWrite, ensureOpen, finish, inboundMessages, isActive, isCompatible, isOpen, lastInboundBuffer, lastOutboundBuffer, localAddress0, metadata, newUnsafe, outboundMessages, readInbound, readOutbound, remoteAddress0, runPendingTasks, writeInbound, writeOutbound
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.AbstractChannel

        +alloc, bind, bind, checkEOF, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doDeregister, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.util.DefaultAttributeMap

        +attr
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface io.netty.util.AttributeMap

        +attr
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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

        +
        public java.lang.String findChannelHandlerNameForType(java.lang.Class<? extends io.netty.channel.ChannelHandler> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLEventChannel.html b/javadoc/cpw/mods/fml/common/network/FMLEventChannel.html new file mode 100644 index 0000000..0f3303c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLEventChannel.html @@ -0,0 +1,354 @@ + + + + + +FMLEventChannel (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLEventChannel

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLEventChannel
+extends java.lang.Object
    +
    An event driven network channel, using FMLNetworkEvent.CustomPacketEvent and FMLNetworkEvent.CustomNetworkEvent + to deliver messages to an event listener. There is one "bus" for each channel, due to the + impossibility of filtering a bus for specific events. + + This event driven system completely wraps the netty code. Mod code deals with FMLProxyPackets directly. It is not + possible to enhance the netty pipeline, and I would expect highly unexpected results if it were modified reflectively. + Use a real ChannelHandler if you want to use netty.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        register

        +
        public void register(java.lang.Object object)
        +
        Register an event listener with this channel and bus. See SubscribeEvent
        +
        Parameters:
        object -
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public void unregister(java.lang.Object object)
        +
        Unregister an event listener from the bus.
        +
        Parameters:
        object -
        +
        • +
      + + + +
        +
      • +

        fireUserEvent

        +
        public void fireUserEvent(java.lang.Object evt,
+                 io.netty.channel.ChannelHandlerContext ctx)
        +
        • +
      + + + +
        +
      • +

        sendToAll

        +
        public void sendToAll(FMLProxyPacket pkt)
        +
        Send a packet to all on the server
        +
        Parameters:
        pkt -
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        sendToDimension

        +
        public void sendToDimension(FMLProxyPacket pkt,
+                   int dimensionId)
        +
        Send to all in a dimension
        +
        Parameters:
        pkt -
        dimensionId -
        +
        • +
      + + + +
        +
      • +

        sendToServer

        +
        public void sendToServer(FMLProxyPacket pkt)
        +
        Send to the server
        +
        Parameters:
        pkt -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html b/javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html new file mode 100644 index 0000000..13421da --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html @@ -0,0 +1,527 @@ + + + + + +FMLIndexedMessageToMessageCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLIndexedMessageToMessageCodec<A>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    Direct Known Subclasses:
    +
    FMLHandshakeCodec, FMLRuntimeCodec, ForgeRuntimeCodec, SimpleIndexedCodec
    +
    +
    +
    +
    @ChannelHandler.Sharable
+public abstract class FMLIndexedMessageToMessageCodec<A>
+extends io.netty.handler.codec.MessageToMessageCodec<FMLProxyPacket,A>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static io.netty.util.AttributeKey<java.lang.ThreadLocal<java.lang.ref.WeakReference<FMLProxyPacket>>>INBOUNDPACKETTRACKER +
      Make this accessible to subclasses
      +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      FMLIndexedMessageToMessageCodec<A>addDiscriminator(int discriminator, + java.lang.Class<? extends A> type) 
      protected voiddecode(io.netty.channel.ChannelHandlerContext ctx, + FMLProxyPacket msg, + java.util.List<java.lang.Object> out) 
      abstract voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + A msg) 
      protected voidencode(io.netty.channel.ChannelHandlerContext ctx, + A msg, + java.util.List<java.lang.Object> out) 
      abstract voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + A msg, + io.netty.buffer.ByteBuf target) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voidhandlerAdded(io.netty.channel.ChannelHandlerContext ctx) 
      protected voidtestMessageValidity(FMLProxyPacket msg) +
      Called to verify the message received.
      +
      +
        +
      • + + +

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

        +acceptInboundMessage, acceptOutboundMessage, channelRead, write
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelDuplexHandler

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerRemoved, 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

        +handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INBOUNDPACKETTRACKER

        +
        public static final io.netty.util.AttributeKey<java.lang.ThreadLocal<java.lang.ref.WeakReference<FMLProxyPacket>>> INBOUNDPACKETTRACKER
        +
        Make this accessible to subclasses
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLIndexedMessageToMessageCodec

        +
        public FMLIndexedMessageToMessageCodec()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handlerAdded

        +
        public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
+                  throws java.lang.Exception
        +
        +
        Specified by:
        +
        handlerAdded in interface io.netty.channel.ChannelHandler
        +
        Overrides:
        +
        handlerAdded in class io.netty.channel.ChannelHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + + + + + +
        +
      • +

        encodeInto

        +
        public abstract void encodeInto(io.netty.channel.ChannelHandlerContext ctx,
+              A msg,
+              io.netty.buffer.ByteBuf target)
+                         throws java.lang.Exception
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        encode

        +
        protected final void encode(io.netty.channel.ChannelHandlerContext ctx,
+          A msg,
+          java.util.List<java.lang.Object> out)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        encode in class io.netty.handler.codec.MessageToMessageCodec<FMLProxyPacket,A>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + +
        +
      • +

        decodeInto

        +
        public abstract void decodeInto(io.netty.channel.ChannelHandlerContext ctx,
+              io.netty.buffer.ByteBuf source,
+              A msg)
        +
        • +
      + + + +
        +
      • +

        decode

        +
        protected final void decode(io.netty.channel.ChannelHandlerContext ctx,
+          FMLProxyPacket msg,
+          java.util.List<java.lang.Object> out)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        decode in class io.netty.handler.codec.MessageToMessageCodec<FMLProxyPacket,A>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        testMessageValidity

        +
        protected void testMessageValidity(FMLProxyPacket msg)
        +
        Called to verify the message received. This can be used to hard disconnect in case of an unexpected packet, + say due to a weird protocol mismatch. Use with caution.
        +
        Parameters:
        msg -
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html new file mode 100644 index 0000000..b577767 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientConnectedToServerEvent.html @@ -0,0 +1,328 @@ + + + + + +FMLNetworkEvent.ClientConnectedToServerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ClientConnectedToServerEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        isLocal

        +
        public final boolean isLocal
        +
        • +
      + + + +
        +
      • +

        connectionType

        +
        public final java.lang.String connectionType
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ClientConnectedToServerEvent

        +
        public FMLNetworkEvent.ClientConnectedToServerEvent(NetworkManager manager,
+                                            java.lang.String connectionType)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html new file mode 100644 index 0000000..0426ee9 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientCustomPacketEvent.html @@ -0,0 +1,331 @@ + + + + + +FMLNetworkEvent.ClientCustomPacketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ClientCustomPacketEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html new file mode 100644 index 0000000..030626b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ClientDisconnectionFromServerEvent.html @@ -0,0 +1,285 @@ + + + + + +FMLNetworkEvent.ClientDisconnectionFromServerEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ClientDisconnectionFromServerEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ClientDisconnectionFromServerEvent

        +
        public FMLNetworkEvent.ClientDisconnectionFromServerEvent(NetworkManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html new file mode 100644 index 0000000..65d0ba7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomNetworkEvent.html @@ -0,0 +1,294 @@ + + + + + +FMLNetworkEvent.CustomNetworkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.CustomNetworkEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        wrappedEvent

        +
        public final java.lang.Object wrappedEvent
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.CustomNetworkEvent

        +
        public FMLNetworkEvent.CustomNetworkEvent(java.lang.Object wrappedEvent)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html new file mode 100644 index 0000000..04fab7b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketEvent.html @@ -0,0 +1,329 @@ + + + + + +FMLNetworkEvent.CustomPacketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.CustomPacketEvent<S extends INetHandler>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        packet

        +
        public final FMLProxyPacket packet
        +
        The packet that generated the event
        +
        • +
      + + + +
        +
      • +

        reply

        +
        public FMLProxyPacket reply
        +
        Set this packet to reply to the originator
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        side

        +
        public abstract Side side()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html new file mode 100644 index 0000000..a3cd191 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.CustomPacketRegistrationEvent.html @@ -0,0 +1,348 @@ + + + + + +FMLNetworkEvent.CustomPacketRegistrationEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.CustomPacketRegistrationEvent<S extends INetHandler>

+
+
+ +
+
    +
  • +
    Type Parameters:
    S - The side
    +
    +
    Enclosing class:
    +
    FMLNetworkEvent<T extends INetHandler>
    +
    +
    +
    +
    public static class FMLNetworkEvent.CustomPacketRegistrationEvent<S extends INetHandler>
+extends FMLNetworkEvent<S>
    +
    Fired when the REGISTER/UNREGISTER for custom channels is received.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        registrations

        +
        public final com.google.common.collect.ImmutableSet<java.lang.String> registrations
        +
        • +
      + + + +
        +
      • +

        operation

        +
        public final java.lang.String operation
        +
        • +
      + + + +
        +
      • +

        side

        +
        public final Side side
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.CustomPacketRegistrationEvent

        +
        public FMLNetworkEvent.CustomPacketRegistrationEvent(NetworkManager manager,
+                                             java.util.Set<java.lang.String> registrations,
+                                             java.lang.String operation,
+                                             Side side,
+                                             java.lang.Class<S> type)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html new file mode 100644 index 0000000..a62a67c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerConnectionFromClientEvent.html @@ -0,0 +1,313 @@ + + + + + +FMLNetworkEvent.ServerConnectionFromClientEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ServerConnectionFromClientEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        isLocal

        +
        public final boolean isLocal
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ServerConnectionFromClientEvent

        +
        public FMLNetworkEvent.ServerConnectionFromClientEvent(NetworkManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html new file mode 100644 index 0000000..b40f7f0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerCustomPacketEvent.html @@ -0,0 +1,331 @@ + + + + + +FMLNetworkEvent.ServerCustomPacketEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ServerCustomPacketEvent

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html new file mode 100644 index 0000000..9b0f7a3 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.ServerDisconnectionFromClientEvent.html @@ -0,0 +1,285 @@ + + + + + +FMLNetworkEvent.ServerDisconnectionFromClientEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent.ServerDisconnectionFromClientEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkEvent.ServerDisconnectionFromClientEvent

        +
        public FMLNetworkEvent.ServerDisconnectionFromClientEvent(NetworkManager manager)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html new file mode 100644 index 0000000..0332371 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkEvent.html @@ -0,0 +1,331 @@ + + + + + +FMLNetworkEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkEvent<T extends INetHandler>

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLNetworkException.html b/javadoc/cpw/mods/fml/common/network/FMLNetworkException.html new file mode 100644 index 0000000..37b1b29 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLNetworkException.html @@ -0,0 +1,277 @@ + + + + + +FMLNetworkException (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLNetworkException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FMLNetworkException
+extends java.lang.RuntimeException
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkException

        +
        public FMLNetworkException(java.lang.Exception e)
        +
        • +
      + + + +
        +
      • +

        FMLNetworkException

        +
        public FMLNetworkException()
        +
        • +
      + + + +
        +
      • +

        FMLNetworkException

        +
        public FMLNetworkException(java.lang.String string)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html new file mode 100644 index 0000000..3371531 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.OutboundTarget.html @@ -0,0 +1,484 @@ + + + + + +FMLOutboundHandler.OutboundTarget (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Enum FMLOutboundHandler.OutboundTarget

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      ALL +
      The packet is dispatched to all players connected to the server.
      +
      ALLAROUNDPOINT +
      The packet is sent to all players within range of the NetworkRegistry.TargetPoint argument supplied.
      +
      DIMENSION +
      The packet is sent to all players in the dimension identified by the integer argument.
      +
      DISPATCHER +
      The packet is sent to the NetworkDispatcher supplied as an argument.
      +
      NOWHERE +
      The packet is sent nowhere.
      +
      PLAYER +
      The packet is sent to the EntityPlayerMP supplied as an argument.
      +
      REPLY +
      The packet is sent to the originator of the packet.
      +
      TOSERVER +
      The packet is sent to the server this client is currently conversing with.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      com.google.common.collect.ImmutableSet<Side>allowed 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract java.util.List<NetworkDispatcher>selectNetworks(java.lang.Object args, + io.netty.channel.ChannelHandlerContext context, + FMLProxyPacket packet) 
      abstract voidvalidateArgs(java.lang.Object args) 
      static FMLOutboundHandler.OutboundTargetvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static FMLOutboundHandler.OutboundTarget[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        allowed

        +
        public final com.google.common.collect.ImmutableSet<Side> allowed
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static FMLOutboundHandler.OutboundTarget[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (FMLOutboundHandler.OutboundTarget c : FMLOutboundHandler.OutboundTarget.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static FMLOutboundHandler.OutboundTarget valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        validateArgs

        +
        public abstract void validateArgs(java.lang.Object args)
        +
        • +
      + + + +
        +
      • +

        selectNetworks

        +
        public abstract java.util.List<NetworkDispatcher> selectNetworks(java.lang.Object args,
+                                               io.netty.channel.ChannelHandlerContext context,
+                                               FMLProxyPacket packet)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html new file mode 100644 index 0000000..7b034c7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/FMLOutboundHandler.html @@ -0,0 +1,376 @@ + + + + + +FMLOutboundHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class FMLOutboundHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class FMLOutboundHandler
+extends io.netty.channel.ChannelOutboundHandlerAdapter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class FMLOutboundHandler.OutboundTarget 
      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLOutboundHandler() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidwrite(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object msg, + io.netty.channel.ChannelPromise promise) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +exceptionCaught, handlerAdded, handlerRemoved, 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

        +exceptionCaught, handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        FML_MESSAGETARGETARGS

        +
        public static final io.netty.util.AttributeKey<java.lang.Object> FML_MESSAGETARGETARGS
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLOutboundHandler

        +
        public FMLOutboundHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(io.netty.channel.ChannelHandlerContext ctx,
+         java.lang.Object msg,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        write in interface io.netty.channel.ChannelOutboundHandler
        +
        Overrides:
        +
        write in class io.netty.channel.ChannelOutboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/IGuiHandler.html b/javadoc/cpw/mods/fml/common/network/IGuiHandler.html new file mode 100644 index 0000000..354b448 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/IGuiHandler.html @@ -0,0 +1,249 @@ + + + + + +IGuiHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Interface IGuiHandler

+
+
+
+
    +
  • +
    +
    +
    public interface IGuiHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.ObjectgetClientGuiElement(int ID, + EntityPlayer player, + World world, + int x, + int y, + int z) +
      Returns a Container to be displayed to the user.
      +
      java.lang.ObjectgetServerGuiElement(int ID, + EntityPlayer player, + World world, + int x, + int y, + int z) +
      Returns a Server side Container to be displayed to the user.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getServerGuiElement

        +
        java.lang.Object getServerGuiElement(int ID,
+                                   EntityPlayer player,
+                                   World world,
+                                   int x,
+                                   int y,
+                                   int z)
        +
        Returns a Server side Container to be displayed to the user.
        +
        Parameters:
        ID - The Gui ID Number
        player - The player viewing the Gui
        world - The current world
        x - X Position
        y - Y Position
        z - Z Position
        +
        Returns:
        A GuiScreen/Container to be displayed to the user, null if none.
        +
        • +
      + + + +
        +
      • +

        getClientGuiElement

        +
        java.lang.Object getClientGuiElement(int ID,
+                                   EntityPlayer player,
+                                   World world,
+                                   int x,
+                                   int y,
+                                   int z)
        +
        Returns a Container to be displayed to the user. On the client side, this + needs to return a instance of GuiScreen On the server side, this needs to + return a instance of Container
        +
        Parameters:
        ID - The Gui ID Number
        player - The player viewing the Gui
        world - The current world
        x - X Position
        y - Y Position
        z - Z Position
        +
        Returns:
        A GuiScreen/Container to be displayed to the user, null if none.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html b/javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html new file mode 100644 index 0000000..686f9c4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkCheckHandler.html @@ -0,0 +1,164 @@ + + + + + +NetworkCheckHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Annotation Type NetworkCheckHandler

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface NetworkCheckHandler
    +
    A method annotated with this will be called when a remote network connection is offered. + The method should have two parameters, of types Map and Side. It should return a boolean + true indicating that the remote party is acceptable, or false if not. + +

    + When the method is invoked, the map will contain String keys and values listing all mods and their versions present. + The side represents the side of the remote party. So if you're on the server, it'll be CLIENT, and vice versa. + +

    + This method will be invoked both when querying the status of the remote server, and when connecting to the remote server. + +

    + NOTE: the server will not be setup at any point when this method is called. Do not try and interact with the server + or the client in any way, except to accept or reject the list of mods.

    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html b/javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html new file mode 100644 index 0000000..5955607 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkEventFiringHandler.html @@ -0,0 +1,342 @@ + + + + + +NetworkEventFiringHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class NetworkEventFiringHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    @ChannelHandler.Sharable
+public class NetworkEventFiringHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
    +
    Use this handler as the only thing in your channel, to receive network events + whenever your channel receives a message. + Note: it will not forward on to other handlers.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLProxyPacket msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLProxyPacket msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        userEventTriggered

        +
        public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
+                      java.lang.Object evt)
+                        throws java.lang.Exception
        +
        +
        Specified by:
        +
        userEventTriggered in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html b/javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html new file mode 100644 index 0000000..0d0a9f7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkHandshakeEstablished.html @@ -0,0 +1,298 @@ + + + + + +NetworkHandshakeEstablished (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class NetworkHandshakeEstablished

+
+
+ +
+
    +
  • +
    +
    +
    public class NetworkHandshakeEstablished
+extends java.lang.Object
    +
    This message is sent through all channels affected by a currently occurring handshake. It is guaranteed to + be able to send a custom payload packet, however, interaction with minecraft and world state is NOT assured + as it is likely this is fired on a netty handler thread, not a world processing thread. + + If you wish to send an outbound message through your channel, bind the FMLOutboundHandler.FML_MESSAGETARGET + property of your channel to the supplied dispatcher.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html new file mode 100644 index 0000000..9bd859d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.TargetPoint.html @@ -0,0 +1,331 @@ + + + + + +NetworkRegistry.TargetPoint (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Class NetworkRegistry.TargetPoint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    NetworkRegistry
    +
    +
    +
    +
    public static class NetworkRegistry.TargetPoint
+extends java.lang.Object
    +
    Represents a target point for the ALLROUNDPOINT target.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      intdimension 
      doublerange 
      doublex 
      doubley 
      doublez 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NetworkRegistry.TargetPoint(int dimension, + double x, + double y, + double z, + double range) +
      A target point
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        x

        +
        public final double x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final double y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final double z
        +
        • +
      + + + +
        +
      • +

        range

        +
        public final double range
        +
        • +
      + + + +
        +
      • +

        dimension

        +
        public final int dimension
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NetworkRegistry.TargetPoint

        +
        public NetworkRegistry.TargetPoint(int dimension,
+                           double x,
+                           double y,
+                           double z,
+                           double range)
        +
        A target point
        +
        Parameters:
        dimension - The dimension to target
        x - The X coordinate
        y - The Y coordinate
        z - The Z coordinate
        range - The range
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/NetworkRegistry.html b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.html new file mode 100644 index 0000000..ca7f894 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/NetworkRegistry.html @@ -0,0 +1,726 @@ + + + + + +NetworkRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network
+

Enum NetworkRegistry

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<NetworkRegistry>
    +
    +
    +
    +
    public enum NetworkRegistry
+extends java.lang.Enum<NetworkRegistry>
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        FML_CHANNEL

        +
        public static final io.netty.util.AttributeKey<java.lang.String> FML_CHANNEL
        +
        Set in the ChannelHandlerContext
        +
        • +
      + + + +
        +
      • +

        CHANNEL_SOURCE

        +
        public static final io.netty.util.AttributeKey<Side> CHANNEL_SOURCE
        +
        • +
      + + + +
        +
      • +

        MOD_CONTAINER

        +
        public static final io.netty.util.AttributeKey<ModContainer> MOD_CONTAINER
        +
        • +
      + + + +
        +
      • +

        NET_HANDLER

        +
        public static final io.netty.util.AttributeKey<INetHandler> NET_HANDLER
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NetworkRegistry[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NetworkRegistry c : NetworkRegistry.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NetworkRegistry valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        newChannel

        +
        public java.util.EnumMap<Side,FMLEmbeddedChannel> newChannel(java.lang.String name,
+                                                    io.netty.channel.ChannelHandler... handlers)
        +
        Create a new synchronous message channel pair based on netty. + + There are two preconstructed models available: +
          +
        • newSimpleChannel(String) provides SimpleNetworkWrapper, a simple implementation of a netty handler, suitable for those who don't + wish to dive too deeply into netty. +
        • #newEventChannel(String) provides FMLEventChannel an event driven implementation, with lower level + access to the network data stream, for those with advanced bitbanging needs that don't wish to poke netty too hard. +
        • Alternatively, simply use the netty features provided here and implement the full power of the netty stack. +
        + + There are two channels created : one for each logical side (considered as the source of an outbound message) + The returned map will contain a value for each logical side, though both will only be working in the + integrated server case. + + The channel expects to read and write using FMLProxyPacket. All operation is synchronous, as the + asynchronous behaviour occurs at a lower level in netty. + + The first handler in the pipeline is special and should not be removed or moved from the head - it transforms + packets from the outbound of this pipeline into custom packets, based on the current AttributeKey value + NetworkRegistry#FML_MESSAGETARGET and NetworkRegistry#FML_MESSAGETARGETARGS set on the channel. + For the client to server channel (source side : CLIENT) this is fixed as "TOSERVER". For SERVER to CLIENT packets, + several possible values exist. + + Mod Messages should be transformed using a something akin to a MessageToMessageCodec. FML provides + a utility codec, FMLIndexedMessageToMessageCodec that transforms from FMLProxyPacket to a mod + message using a message discriminator byte. This is optional, but highly recommended for use. + + Note also that the handlers supplied need to be ChannelHandler.Shareable - they are injected into two + channels.
        +
        Parameters:
        name -
        handlers -
        +
        Returns:
        +
        • +
      + + + + + + + +
        +
      • +

        newEventDrivenChannel

        +
        public FMLEventChannel newEventDrivenChannel(java.lang.String name)
        +
        Construct a new FMLEventChannel for the channel.
        +
        Parameters:
        name - The name of the channel
        +
        Returns:
        An FMLEventChannel for handling this channel
        +
        • +
      + + + +
        +
      • +

        newChannel

        +
        public java.util.EnumMap<Side,FMLEmbeddedChannel> newChannel(ModContainer container,
+                                                    java.lang.String name,
+                                                    io.netty.channel.ChannelHandler... handlers)
        +
        INTERNAL Create a new channel pair with the specified name and channel handlers. + This is used internally in forge and FML
        +
        Parameters:
        container - The container to associate the channel with
        name - The name for the channel
        handlers - Some ChannelHandler for the channel
        +
        Returns:
        an EnumMap of the pair of channels. keys are Side. There will always be two entries.
        +
        • +
      + + + + + + + +
        +
      • +

        registerGuiHandler

        +
        public void registerGuiHandler(java.lang.Object mod,
+                      IGuiHandler handler)
        +
        Register an IGuiHandler for the supplied mod object.
        +
        Parameters:
        mod - The mod to handle GUIs for
        handler - A handler for creating GUI related objects
        +
        • +
      + + + +
        +
      • +

        getRemoteGuiContainer

        +
        public Container getRemoteGuiContainer(ModContainer mc,
+                              EntityPlayerMP player,
+                              int modGuiId,
+                              World world,
+                              int x,
+                              int y,
+                              int z)
        +
        INTERNAL method for accessing the Gui registry
        +
        Parameters:
        mc - Mod Container
        player - Player
        modGuiId - guiId
        world - World
        x - X coord
        y - Y coord
        z - Z coord
        +
        Returns:
        The server side GUI object (An instance of Container)
        +
        • +
      + + + +
        +
      • +

        getLocalGuiContainer

        +
        public java.lang.Object getLocalGuiContainer(ModContainer mc,
+                                    EntityPlayer player,
+                                    int modGuiId,
+                                    World world,
+                                    int x,
+                                    int y,
+                                    int z)
        +
        INTERNAL method for accessing the Gui registry
        +
        Parameters:
        mc - Mod Container
        player - Player
        modGuiId - guiId
        world - World
        x - X coord
        y - Y coord
        z - Z coord
        +
        Returns:
        The client side GUI object (An instance of GUI)
        +
        • +
      + + + +
        +
      • +

        hasChannel

        +
        public boolean hasChannel(java.lang.String channelName,
+                 Side source)
        +
        Is there a channel with this name on this side?
        +
        Parameters:
        channelName - The name
        source - the side
        +
        Returns:
        if there's a channel
        +
        • +
      + + + +
        +
      • +

        register

        +
        public void register(ModContainer fmlModContainer,
+            java.lang.Class<?> clazz,
+            java.lang.String remoteVersionRange,
+            ASMDataTable asmHarvestedData)
        +
        INTERNAL method for registering a mod as a network capable thing
        +
        Parameters:
        fmlModContainer - The fml mod container
        clazz - a class
        remoteVersionRange - the acceptable remote range
        asmHarvestedData - internal data
        +
        • +
      + + + +
        +
      • +

        isVanillaAccepted

        +
        public boolean isVanillaAccepted(Side from)
        +
        • +
      + + + + + + + +
        +
      • +

        channelNamesFor

        +
        public java.util.Set<java.lang.String> channelNamesFor(Side side)
        +
        All the valid channel names for a side
        +
        Parameters:
        side - the side
        +
        Returns:
        the set of channel names
        +
        • +
      + + + +
        +
      • +

        fireNetworkHandshake

        +
        public void fireNetworkHandshake(NetworkDispatcher networkDispatcher,
+                        Side origin)
        +
        INTERNAL fire a handshake to all channels
        +
        Parameters:
        networkDispatcher - The dispatcher firing
        origin - which side the dispatcher is on
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html b/javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html new file mode 100644 index 0000000..641658f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/ChannelRegistrationHandler.html @@ -0,0 +1,349 @@ + + + + + +ChannelRegistrationHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class ChannelRegistrationHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class ChannelRegistrationHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLProxyPacket msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChannelRegistrationHandler

        +
        public ChannelRegistrationHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLProxyPacket msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLProxyPacket>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html new file mode 100644 index 0000000..373f6c5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeCodec.html @@ -0,0 +1,386 @@ + + + + + +FMLHandshakeCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class FMLHandshakeCodec
+extends FMLIndexedMessageToMessageCodec<FMLHandshakeMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLHandshakeCodec() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + FMLHandshakeMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + FMLHandshakeMessage msg, + io.netty.buffer.ByteBuf target) 
      + +
        +
      • + + +

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

        +acceptInboundMessage, acceptOutboundMessage, channelRead, write
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelDuplexHandler

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerRemoved, 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

        +handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html new file mode 100644 index 0000000..81a4c2a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ClientHello.html @@ -0,0 +1,319 @@ + + + + + +FMLHandshakeMessage.ClientHello (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ClientHello

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ClientHello

        +
        public FMLHandshakeMessage.ClientHello()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        protocolVersion

        +
        public byte protocolVersion()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html new file mode 100644 index 0000000..4fdf85e --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeAck.html @@ -0,0 +1,323 @@ + + + + + +FMLHandshakeMessage.HandshakeAck (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.HandshakeAck

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.HandshakeAck

        +
        public FMLHandshakeMessage.HandshakeAck()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html new file mode 100644 index 0000000..06d9782 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.HandshakeReset.html @@ -0,0 +1,257 @@ + + + + + +FMLHandshakeMessage.HandshakeReset (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.HandshakeReset

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.HandshakeReset

        +
        public FMLHandshakeMessage.HandshakeReset()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html new file mode 100644 index 0000000..1c7a014 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModIdData.html @@ -0,0 +1,374 @@ + + + + + +FMLHandshakeMessage.ModIdData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ModIdData

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ModIdData

        +
        public FMLHandshakeMessage.ModIdData()
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        dataList

        +
        public java.util.Map<java.lang.String,java.lang.Integer> dataList()
        +
        • +
      + + + +
        +
      • +

        blockSubstitutions

        +
        public java.util.Set<java.lang.String> blockSubstitutions()
        +
        • +
      + + + +
        +
      • +

        itemSubstitutions

        +
        public java.util.Set<java.lang.String> itemSubstitutions()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.lang.Class<? extends java.lang.Enum<?>> side)
        +
        +
        Overrides:
        +
        toString in class FMLHandshakeMessage
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html new file mode 100644 index 0000000..58ccc44 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ModList.html @@ -0,0 +1,374 @@ + + + + + +FMLHandshakeMessage.ModList (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ModList

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ModList

        +
        public FMLHandshakeMessage.ModList()
        +
        • +
      + + + +
        +
      • +

        FMLHandshakeMessage.ModList

        +
        public FMLHandshakeMessage.ModList(java.util.List<ModContainer> modList)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        modListAsString

        +
        public java.lang.String modListAsString()
        +
        • +
      + + + +
        +
      • +

        modListSize

        +
        public int modListSize()
        +
        • +
      + + + +
        +
      • +

        modList

        +
        public java.util.Map<java.lang.String,java.lang.String> modList()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.lang.Class<? extends java.lang.Enum<?>> side)
        +
        +
        Overrides:
        +
        toString in class FMLHandshakeMessage
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html new file mode 100644 index 0000000..e204958 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.ServerHello.html @@ -0,0 +1,319 @@ + + + + + +FMLHandshakeMessage.ServerHello (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage.ServerHello

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage.ServerHello

        +
        public FMLHandshakeMessage.ServerHello()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        protocolVersion

        +
        public byte protocolVersion()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html new file mode 100644 index 0000000..833b7c7 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/FMLHandshakeMessage.html @@ -0,0 +1,336 @@ + + + + + +FMLHandshakeMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class FMLHandshakeMessage

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLHandshakeMessage

        +
        public FMLHandshakeMessage()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        makeCustomChannelRegistration

        +
        public static FMLProxyPacket makeCustomChannelRegistration(java.util.Set<java.lang.String> channels)
        +
        • +
      + + + +
        +
      • +

        fromBytes

        +
        public void fromBytes(io.netty.buffer.ByteBuf buffer)
        +
        • +
      + + + +
        +
      • +

        toBytes

        +
        public void toBytes(io.netty.buffer.ByteBuf buffer)
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.lang.Class<? extends java.lang.Enum<?>> side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html new file mode 100644 index 0000000..c9d6628 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeInjector.html @@ -0,0 +1,316 @@ + + + + + +HandshakeInjector (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class HandshakeInjector

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class HandshakeInjector
+extends io.netty.channel.ChannelOutboundHandlerAdapter
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidwrite(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object msg, + io.netty.channel.ChannelPromise promise) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +exceptionCaught, handlerAdded, handlerRemoved, 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

        +exceptionCaught, handlerAdded, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HandshakeInjector

        +
        public HandshakeInjector(NetworkDispatcher networkDispatcher)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(io.netty.channel.ChannelHandlerContext ctx,
+         java.lang.Object msg,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        write in interface io.netty.channel.ChannelOutboundHandler
        +
        Overrides:
        +
        write in class io.netty.channel.ChannelOutboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html new file mode 100644 index 0000000..f8e9e75 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/HandshakeMessageHandler.html @@ -0,0 +1,393 @@ + + + + + +HandshakeMessageHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class HandshakeMessageHandler<S extends java.lang.Enum<S> & IHandshakeState<S>>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class HandshakeMessageHandler<S extends java.lang.Enum<S> & IHandshakeState<S>>
+extends io.netty.channel.SimpleChannelInboundHandler<FMLHandshakeMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      HandshakeMessageHandler(java.lang.Class<S> stateType) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidchannelActive(io.netty.channel.ChannelHandlerContext ctx) 
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLHandshakeMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HandshakeMessageHandler

        +
        public HandshakeMessageHandler(java.lang.Class<S> stateType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLHandshakeMessage msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLHandshakeMessage>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        channelActive

        +
        public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
+                   throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelActive in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        channelActive in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        userEventTriggered

        +
        public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
+                      java.lang.Object evt)
+                        throws java.lang.Exception
        +
        +
        Specified by:
        +
        userEventTriggered in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html b/javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html new file mode 100644 index 0000000..86a361d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/IHandshakeState.html @@ -0,0 +1,206 @@ + + + + + +IHandshakeState (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Interface IHandshakeState<S>

+
+
+
+
    +
  • +
    +
    +
    public interface IHandshakeState<S>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      Saccept(io.netty.channel.ChannelHandlerContext ctx, + FMLHandshakeMessage msg) 
      +
      • +
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html b/javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html new file mode 100644 index 0000000..729da41 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/NetworkDispatcher.html @@ -0,0 +1,791 @@ + + + + + +NetworkDispatcher (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.handshake
+

Class NetworkDispatcher

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class NetworkDispatcher
+extends io.netty.channel.SimpleChannelInboundHandler<Packet>
+implements io.netty.channel.ChannelOutboundHandler
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidabortClientHandshake(java.lang.String type) 
      static NetworkDispatcherallocAndSet(NetworkManager manager) 
      static NetworkDispatcherallocAndSet(NetworkManager manager, + ServerConfigurationManager scm) 
      voidbind(io.netty.channel.ChannelHandlerContext ctx, + java.net.SocketAddress localAddress, + io.netty.channel.ChannelPromise promise) 
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + Packet msg) 
      voidclientToServerHandshake() 
      voidclose(io.netty.channel.ChannelHandlerContext ctx, + io.netty.channel.ChannelPromise promise) 
      voidcompleteClientHandshake() 
      voidcompleteHandshake(Side target) 
      voidconnect(io.netty.channel.ChannelHandlerContext ctx, + java.net.SocketAddress remoteAddress, + java.net.SocketAddress localAddress, + io.netty.channel.ChannelPromise promise) 
      voidderegister(io.netty.channel.ChannelHandlerContext ctx, + io.netty.channel.ChannelPromise promise) +
      Deprecated. 
      +
      voiddisconnect(io.netty.channel.ChannelHandlerContext ctx, + io.netty.channel.ChannelPromise promise) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      voidflush(io.netty.channel.ChannelHandlerContext ctx) 
      static NetworkDispatcherget(NetworkManager manager) 
      INetHandlergetNetHandler() 
      voidhandlerAdded(io.netty.channel.ChannelHandlerContext ctx) 
      voidread(io.netty.channel.ChannelHandlerContext ctx) 
      voidrejectHandshake(java.lang.String result) 
      voidsendProxy(FMLProxyPacket msg) 
      voidserverToClientHandshake(EntityPlayerMP player) 
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) 
      voidwrite(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object msg, + io.netty.channel.ChannelPromise promise) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerRemoved, 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

        +handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        FML_DISPATCHER

        +
        public static final io.netty.util.AttributeKey<NetworkDispatcher> FML_DISPATCHER
        +
        • +
      + + + +
        +
      • +

        IS_LOCAL

        +
        public static final io.netty.util.AttributeKey<java.lang.Boolean> IS_LOCAL
        +
        • +
      + + + + +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        serverToClientHandshake

        +
        public void serverToClientHandshake(EntityPlayerMP player)
        +
        • +
      + + + +
        +
      • +

        clientToServerHandshake

        +
        public void clientToServerHandshake()
        +
        • +
      + + + +
        +
      • +

        handlerAdded

        +
        public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
+                  throws java.lang.Exception
        +
        +
        Specified by:
        +
        handlerAdded in interface io.netty.channel.ChannelHandler
        +
        Overrides:
        +
        handlerAdded in class io.netty.channel.ChannelHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                Packet msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<Packet>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        getNetHandler

        +
        public INetHandler getNetHandler()
        +
        • +
      + + + +
        +
      • +

        userEventTriggered

        +
        public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
+                      java.lang.Object evt)
+                        throws java.lang.Exception
        +
        +
        Specified by:
        +
        userEventTriggered in interface io.netty.channel.ChannelInboundHandler
        +
        Overrides:
        +
        userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + + + + + +
        +
      • +

        rejectHandshake

        +
        public void rejectHandshake(java.lang.String result)
        +
        • +
      + + + +
        +
      • +

        bind

        +
        public void bind(io.netty.channel.ChannelHandlerContext ctx,
+        java.net.SocketAddress localAddress,
+        io.netty.channel.ChannelPromise promise)
+          throws java.lang.Exception
        +
        +
        Specified by:
        +
        bind in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        connect

        +
        public void connect(io.netty.channel.ChannelHandlerContext ctx,
+           java.net.SocketAddress remoteAddress,
+           java.net.SocketAddress localAddress,
+           io.netty.channel.ChannelPromise promise)
+             throws java.lang.Exception
        +
        +
        Specified by:
        +
        connect in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        disconnect

        +
        public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
+              io.netty.channel.ChannelPromise promise)
+                throws java.lang.Exception
        +
        +
        Specified by:
        +
        disconnect in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close(io.netty.channel.ChannelHandlerContext ctx,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        close in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        deregister

        +
        @Deprecated
+public void deregister(io.netty.channel.ChannelHandlerContext ctx,
+                         io.netty.channel.ChannelPromise promise)
+                throws java.lang.Exception
        +
        Deprecated. 
        +
        +
        Specified by:
        +
        deregister in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        read

        +
        public void read(io.netty.channel.ChannelHandlerContext ctx)
+          throws java.lang.Exception
        +
        +
        Specified by:
        +
        read in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(io.netty.channel.ChannelHandlerContext ctx,
+         java.lang.Object msg,
+         io.netty.channel.ChannelPromise promise)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        write in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush(io.netty.channel.ChannelHandlerContext ctx)
+           throws java.lang.Exception
        +
        +
        Specified by:
        +
        flush in interface io.netty.channel.ChannelOutboundHandler
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        completeHandshake

        +
        public void completeHandshake(Side target)
        +
        • +
      + + + +
        +
      • +

        completeClientHandshake

        +
        public void completeClientHandshake()
        +
        • +
      + + + +
        +
      • +

        abortClientHandshake

        +
        public void abortClientHandshake(java.lang.String type)
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/package-frame.html b/javadoc/cpw/mods/fml/common/network/handshake/package-frame.html new file mode 100644 index 0000000..79ed5f2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/package-frame.html @@ -0,0 +1,34 @@ + + + + + +cpw.mods.fml.common.network.handshake (Forge API) + + + + +

cpw.mods.fml.common.network.handshake

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/package-summary.html b/javadoc/cpw/mods/fml/common/network/handshake/package-summary.html new file mode 100644 index 0000000..10c32ab --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/package-summary.html @@ -0,0 +1,190 @@ + + + + + +cpw.mods.fml.common.network.handshake (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network.handshake

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/handshake/package-tree.html b/javadoc/cpw/mods/fml/common/network/handshake/package-tree.html new file mode 100644 index 0000000..22e73cb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/handshake/package-tree.html @@ -0,0 +1,172 @@ + + + + + +cpw.mods.fml.common.network.handshake Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network.handshake

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html b/javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html new file mode 100644 index 0000000..89e9bdc --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/EntitySpawnHandler.html @@ -0,0 +1,349 @@ + + + + + +EntitySpawnHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class EntitySpawnHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class EntitySpawnHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLMessage.EntityMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      EntitySpawnHandler() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage.EntityMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EntitySpawnHandler

        +
        public EntitySpawnHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLMessage.EntityMessage msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLMessage.EntityMessage>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html new file mode 100644 index 0000000..d6e0eda --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.CompleteHandshake.html @@ -0,0 +1,262 @@ + + + + + +FMLMessage.CompleteHandshake (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.CompleteHandshake

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLMessage
    +
    +
    +
    +
    public static class FMLMessage.CompleteHandshake
+extends FMLMessage
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.CompleteHandshake

        +
        public FMLMessage.CompleteHandshake()
        +
        • +
      + + + +
        +
      • +

        FMLMessage.CompleteHandshake

        +
        public FMLMessage.CompleteHandshake(Side target)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html new file mode 100644 index 0000000..f4c314d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityAdjustMessage.html @@ -0,0 +1,273 @@ + + + + + +FMLMessage.EntityAdjustMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.EntityAdjustMessage

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.EntityAdjustMessage

        +
        public FMLMessage.EntityAdjustMessage()
        +
        • +
      + + + +
        +
      • +

        FMLMessage.EntityAdjustMessage

        +
        public FMLMessage.EntityAdjustMessage(Entity entity,
+                              int serverX,
+                              int serverY,
+                              int serverZ)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html new file mode 100644 index 0000000..10b061f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntityMessage.html @@ -0,0 +1,254 @@ + + + + + +FMLMessage.EntityMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.EntityMessage

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.EntityMessage

        +
        public FMLMessage.EntityMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html new file mode 100644 index 0000000..a0d8f6f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.EntitySpawnMessage.html @@ -0,0 +1,271 @@ + + + + + +FMLMessage.EntitySpawnMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.EntitySpawnMessage

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html new file mode 100644 index 0000000..dcd987b --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.OpenGui.html @@ -0,0 +1,250 @@ + + + + + +FMLMessage.OpenGui (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage.OpenGui

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FMLMessage
    +
    +
    +
    +
    public static class FMLMessage.OpenGui
+extends FMLMessage
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage.OpenGui

        +
        public FMLMessage.OpenGui()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html new file mode 100644 index 0000000..598e720 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLMessage.html @@ -0,0 +1,265 @@ + + + + + +FMLMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLMessage

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLMessage

        +
        public FMLMessage()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html b/javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html new file mode 100644 index 0000000..e91f04f --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLNetworkHandler.html @@ -0,0 +1,454 @@ + + + + + +FMLNetworkHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLNetworkHandler

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLNetworkHandler
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        READ_TIMEOUT

        +
        public static final int READ_TIMEOUT
        +
        • +
      + + + +
        +
      • +

        LOGIN_TIMEOUT

        +
        public static final int LOGIN_TIMEOUT
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLNetworkHandler

        +
        public FMLNetworkHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        fmlClientHandshake

        +
        public static void fmlClientHandshake(NetworkManager field_147393_d)
        +
        • +
      + + + +
        +
      • +

        openGui

        +
        public static void openGui(EntityPlayer entityPlayer,
+           java.lang.Object mod,
+           int modGuiId,
+           World world,
+           int x,
+           int y,
+           int z)
        +
        • +
      + + + +
        +
      • +

        makeEntitySpawnAdjustment

        +
        public static void makeEntitySpawnAdjustment(Entity entity,
+                             EntityPlayerMP player,
+                             int serverX,
+                             int serverY,
+                             int serverZ)
        +
        • +
      + + + +
        +
      • +

        getEntitySpawningPacket

        +
        public static Packet getEntitySpawningPacket(Entity entity)
        +
        • +
      + + + + + + + +
        +
      • +

        checkModList

        +
        public static java.lang.String checkModList(java.util.Map<java.lang.String,java.lang.String> listData,
+                            Side side)
        +
        • +
      + + + +
        +
      • +

        registerChannel

        +
        public static void registerChannel(FMLContainer container,
+                   Side side)
        +
        • +
      + + + + + + + +
        +
      • +

        enhanceStatusQuery

        +
        public static void enhanceStatusQuery(com.google.gson.JsonObject jsonobject)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html b/javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html new file mode 100644 index 0000000..7c88165 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLProxyPacket.html @@ -0,0 +1,464 @@ + + + + + +FMLProxyPacket (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLProxyPacket

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLProxyPacket
+extends Packet
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + + + + + + + + + +
        +
      • +

        FMLProxyPacket

        +
        public FMLProxyPacket(io.netty.buffer.ByteBuf payload,
+              java.lang.String channel)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readPacketData

        +
        public void readPacketData(PacketBuffer packetbuffer)
+                    throws java.io.IOException
        +
        +
        Specified by:
        +
        readPacketData in class Packet
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + +
        +
      • +

        writePacketData

        +
        public void writePacketData(PacketBuffer packetbuffer)
+                     throws java.io.IOException
        +
        +
        Specified by:
        +
        writePacketData in class Packet
        +
        Throws:
        +
        java.io.IOException
        +
        • +
      + + + + + + + +
        +
      • +

        channel

        +
        public java.lang.String channel()
        +
        • +
      + + + +
        +
      • +

        payload

        +
        public io.netty.buffer.ByteBuf payload()
        +
        • +
      + + + + + + + +
        +
      • +

        toC17Packet

        +
        public Packet toC17Packet()
        +
        • +
      + + + +
        +
      • +

        toS3FPacket

        +
        public Packet toS3FPacket()
        +
        • +
      + + + +
        +
      • +

        setTarget

        +
        public void setTarget(Side target)
        +
        • +
      + + + +
        +
      • +

        setDispatcher

        +
        public void setDispatcher(NetworkDispatcher networkDispatcher)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getTarget

        +
        public Side getTarget()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html b/javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html new file mode 100644 index 0000000..8fdea5d --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/FMLRuntimeCodec.html @@ -0,0 +1,408 @@ + + + + + +FMLRuntimeCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class FMLRuntimeCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class FMLRuntimeCodec
+extends FMLIndexedMessageToMessageCodec<FMLMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FMLRuntimeCodec() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + FMLMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage msg, + io.netty.buffer.ByteBuf target) 
      protected voidtestMessageValidity(FMLProxyPacket msg) +
      Called to verify the message received.
      +
      + +
        +
      • + + +

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

        +acceptInboundMessage, acceptOutboundMessage, channelRead, write
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelDuplexHandler

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerRemoved, 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

        +handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html b/javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html new file mode 100644 index 0000000..b2f6f71 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/HandshakeCompletionHandler.html @@ -0,0 +1,350 @@ + + + + + +HandshakeCompletionHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class HandshakeCompletionHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    @ChannelHandler.Sharable
+public class HandshakeCompletionHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLMessage.CompleteHandshake>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage.CompleteHandshake msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HandshakeCompletionHandler

        +
        public HandshakeCompletionHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLMessage.CompleteHandshake msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLMessage.CompleteHandshake>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html new file mode 100644 index 0000000..c6d6dc5 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.NetworkChecker.html @@ -0,0 +1,260 @@ + + + + + +NetworkModHolder.NetworkChecker (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class NetworkModHolder.NetworkChecker

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    NetworkModHolder
    +
    +
    +
    +
    public abstract class NetworkModHolder.NetworkChecker
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      abstract booleancheck(java.util.Map<java.lang.String,java.lang.String> remoteVersions, + Side side) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        NetworkModHolder.NetworkChecker

        +
        public NetworkModHolder.NetworkChecker()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        check

        +
        public abstract boolean check(java.util.Map<java.lang.String,java.lang.String> remoteVersions,
+            Side side)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html new file mode 100644 index 0000000..e0e18e0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/NetworkModHolder.html @@ -0,0 +1,398 @@ + + + + + +NetworkModHolder (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class NetworkModHolder

+
+
+ +
+
    +
  • +
    +
    +
    public class NetworkModHolder
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        acceptVersion

        +
        public boolean acceptVersion(java.lang.String version)
        +
        • +
      + + + +
        +
      • +

        check

        +
        public boolean check(java.util.Map<java.lang.String,java.lang.String> data,
+            Side side)
        +
        • +
      + + + +
        +
      • +

        getLocalId

        +
        public int getLocalId()
        +
        • +
      + + + +
        +
      • +

        getNetworkId

        +
        public int getNetworkId()
        +
        • +
      + + + + + + + +
        +
      • +

        setNetworkId

        +
        public void setNetworkId(int value)
        +
        • +
      + + + +
        +
      • +

        testVanillaAcceptance

        +
        public void testVanillaAcceptance()
        +
        • +
      + + + +
        +
      • +

        acceptsVanilla

        +
        public boolean acceptsVanilla(Side from)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html b/javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html new file mode 100644 index 0000000..a1f7844 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/OpenGuiHandler.html @@ -0,0 +1,349 @@ + + + + + +OpenGuiHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.internal
+

Class OpenGuiHandler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class OpenGuiHandler
+extends io.netty.channel.SimpleChannelInboundHandler<FMLMessage.OpenGui>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      OpenGuiHandler() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + FMLMessage.OpenGui msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OpenGuiHandler

        +
        public OpenGuiHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                FMLMessage.OpenGui msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<FMLMessage.OpenGui>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/package-frame.html b/javadoc/cpw/mods/fml/common/network/internal/package-frame.html new file mode 100644 index 0000000..2b3ed40 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/package-frame.html @@ -0,0 +1,31 @@ + + + + + +cpw.mods.fml.common.network.internal (Forge API) + + + + +

cpw.mods.fml.common.network.internal

+
+

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/internal/package-summary.html b/javadoc/cpw/mods/fml/common/network/internal/package-summary.html new file mode 100644 index 0000000..72c52f4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/package-summary.html @@ -0,0 +1,179 @@ + + + + + +cpw.mods.fml.common.network.internal (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network.internal

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/internal/package-tree.html b/javadoc/cpw/mods/fml/common/network/internal/package-tree.html new file mode 100644 index 0000000..cfb7093 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/internal/package-tree.html @@ -0,0 +1,173 @@ + + + + + +cpw.mods.fml.common.network.internal Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network.internal

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/package-frame.html b/javadoc/cpw/mods/fml/common/network/package-frame.html new file mode 100644 index 0000000..64a33d2 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/package-frame.html @@ -0,0 +1,53 @@ + + + + + +cpw.mods.fml.common.network (Forge API) + + + + +

cpw.mods.fml.common.network

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +

Annotation Types

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/package-summary.html b/javadoc/cpw/mods/fml/common/network/package-summary.html new file mode 100644 index 0000000..891ee59 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/package-summary.html @@ -0,0 +1,295 @@ + + + + + +cpw.mods.fml.common.network (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/package-tree.html b/javadoc/cpw/mods/fml/common/network/package-tree.html new file mode 100644 index 0000000..43065f0 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/package-tree.html @@ -0,0 +1,223 @@ + + + + + +cpw.mods.fml.common.network Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Annotation Type Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html new file mode 100644 index 0000000..913c539 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessage.html @@ -0,0 +1,226 @@ + + + + + +IMessage (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Interface IMessage

+
+
+
+
    +
  • +
    +
    +
    public interface IMessage
    +
    Implement this interface for each message you wish to define.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidfromBytes(io.netty.buffer.ByteBuf buf) +
      Convert from the supplied buffer into your specific message type
      +
      voidtoBytes(io.netty.buffer.ByteBuf buf) +
      Deconstruct your message into the supplied byte buffer
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromBytes

        +
        void fromBytes(io.netty.buffer.ByteBuf buf)
        +
        Convert from the supplied buffer into your specific message type
        +
        Parameters:
        buf -
        +
        • +
      + + + +
        +
      • +

        toBytes

        +
        void toBytes(io.netty.buffer.ByteBuf buf)
        +
        Deconstruct your message into the supplied byte buffer
        +
        Parameters:
        buf -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html new file mode 100644 index 0000000..58c9fb1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/IMessageHandler.html @@ -0,0 +1,219 @@ + + + + + +IMessageHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Interface IMessageHandler<REQ extends IMessage,REPLY extends IMessage>

+
+
+
+
    +
  • +
    Type Parameters:
    REQ - This is the request type - it is the message you expect to receive from remote.
    REPLY - This is the reply type - it is the message you expect to send in reply. You can use IMessage as the type here + if you don't anticipate sending a reply.
    +
    +
    +
    public interface IMessageHandler<REQ extends IMessage,REPLY extends IMessage>
    +
    A message handler based on IMessage. Implement and override #onMessage(IMessage) to + process your packet. Supply the class to SimpleNetworkWrapper#registerMessage(Class, Class, byte, cpw.mods.fml.relauncher.Side) + to register both the message type and it's associated handler.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      REPLYonMessage(REQ message, + MessageContext ctx) +
      Called when a message is received of the appropriate type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        onMessage

        +
        REPLY onMessage(REQ message,
+              MessageContext ctx)
        +
        Called when a message is received of the appropriate type. You can optionally return a reply message, or null if no reply + is needed.
        +
        Parameters:
        message - The message
        +
        Returns:
        an optional return message
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html new file mode 100644 index 0000000..a4c5d2a --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/MessageContext.html @@ -0,0 +1,290 @@ + + + + + +MessageContext (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class MessageContext

+
+
+ +
+
    +
  • +
    +
    +
    public class MessageContext
+extends java.lang.Object
    +
    Context for the IMessageHandler
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        netHandler

        +
        public final INetHandler netHandler
        +
        The INetHandler for this message. It could be a client or server handler, depending + on the side recieved.
        +
        • +
      + + + +
        +
      • +

        side

        +
        public final Side side
        +
        The Side this message has been received on
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html new file mode 100644 index 0000000..4990219 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleChannelHandlerWrapper.html @@ -0,0 +1,371 @@ + + + + + +SimpleChannelHandlerWrapper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class SimpleChannelHandlerWrapper<REQ extends IMessage,REPLY extends IMessage>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    +
    +
    +
    +
    public class SimpleChannelHandlerWrapper<REQ extends IMessage,REPLY extends IMessage>
+extends io.netty.channel.SimpleChannelInboundHandler<REQ>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, + REQ msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) 
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        +acceptInboundMessage, channelRead
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerAdded, handlerRemoved, 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, handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SimpleChannelHandlerWrapper

        +
        public SimpleChannelHandlerWrapper(java.lang.Class<? extends IMessageHandler<? super REQ,? extends REPLY>> handler,
+                           Side side,
+                           java.lang.Class<REQ> requestType)
        +
        • +
      + + + +
        +
      • +

        SimpleChannelHandlerWrapper

        +
        public SimpleChannelHandlerWrapper(IMessageHandler<? super REQ,? extends REPLY> handler,
+                           Side side,
+                           java.lang.Class<REQ> requestType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        channelRead0

        +
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
+                REQ msg)
+                     throws java.lang.Exception
        +
        +
        Specified by:
        +
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<REQ extends IMessage>
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        exceptionCaught

        +
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
+                   java.lang.Throwable cause)
+                     throws java.lang.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:
        +
        java.lang.Exception
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html new file mode 100644 index 0000000..f976ccb --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleIndexedCodec.html @@ -0,0 +1,386 @@ + + + + + +SimpleIndexedCodec (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class SimpleIndexedCodec

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    +
    +
    +
    +
    public class SimpleIndexedCodec
+extends FMLIndexedMessageToMessageCodec<IMessage>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

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

        +io.netty.channel.ChannelHandler.Sharable
        • +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SimpleIndexedCodec() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + IMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, + IMessage msg, + io.netty.buffer.ByteBuf target) 
      + +
        +
      • + + +

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

        +acceptInboundMessage, acceptOutboundMessage, channelRead, write
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelDuplexHandler

        +bind, close, connect, deregister, disconnect, flush, read
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        +channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • +
      +
        +
      • + + +

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        +handlerRemoved, 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

        +handlerRemoved
        • +
      +
      • +
    +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html new file mode 100644 index 0000000..1ba92e8 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/SimpleNetworkWrapper.html @@ -0,0 +1,463 @@ + + + + + +SimpleNetworkWrapper (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common.network.simpleimpl
+

Class SimpleNetworkWrapper

+
+
+ +
+
    +
  • +
    +
    +
    public class SimpleNetworkWrapper
+extends java.lang.Object
    +
    This class is a simplified netty wrapper for those not wishing to deal with the full power of netty. + It provides a simple message driven system, based on a discriminator byte over the custom packet channel. + It assumes that you have a series of unique message types with each having a unique handler. Generally, context should be + derived at message handling time. + + Usage is simple:
      +
    • construct, and store, an instance of this class. It will automatically register and configure your underlying netty channel. + +
    • Then, call #registerMessage(Class, Class, byte, Side) for each message type you want to exchange + providing an IMessageHandler implementation class as well as an IMessage implementation class. The side parameter + to that method indicates which side (server or client) the message processing will occur on. The discriminator byte + should be unique for this channelName - it is used to discriminate between different types of message that might + occur on this channel (a simple form of message channel multiplexing, if you will). +
    • To get a packet suitable for presenting to the rest of minecraft, you can call getPacketFrom(IMessage). The return result + is suitable for returning from things like TileEntity.getDescriptionPacket() for example. +
    • Finally, use the sendXXX to send unsolicited messages to various classes of recipients. +
    + + Example + + 
    +  // Request message
+  public Message1 implements IMessage {
+  // message structure
+   public fromBytes(ByteBuf buf) {
+    // build message from byte array
+   }
+   public toBytes(ByteBuf buf) {
+    // put message content into byte array
+   }
+  }
+  // Reply message
+  public Message2 implements IMessage {
+   // stuff as before
+  }
+  // Message1Handler expects input of type Message1 and returns type Message2
+  public Message1Handler implements IMessageHandler {
+   public Message2 onMessage(Message1 message, MessageContext ctx) {
+    // do something and generate reply message
+    return aMessage2Object;
+   }
+  }
+  // Message2Handler expects input of type Message2 and returns no message (IMessage)
+  public Message2Handler implements IMessageHandler {
+   public IMessage onMessage(Message2 message, MessageContext ctx) {
+    // handle the message 2 response message at the other end
+    // no reply for this message - return null
+    return null;
+   }
+  }
+
+  // Code in a FMLPreInitializationEvent or FMLInitializationEvent handler
+  SimpleNetworkWrapper wrapper = NetworkRegistry.newSimpleChannel("MYCHANNEL");
+  // Message1 is handled by the Message1Handler class, it has discriminator id 1 and it's on the client
+  wrapper.registerMessage(Message1Handler.class, Message1.class, 1, Side.CLIENT);
+  // Message2 is handled by the Message2Handler class, it has discriminator id 2 and it's on the server
+  wrapper.registerMessage(Message2Handler.class, Message2.class, 2, Side.SERVER);
+
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SimpleNetworkWrapper(java.lang.String channelName) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      PacketgetPacketFrom(IMessage message) +
      Construct a minecraft packet from the supplied message.
      +
      <REQ extends IMessage,REPLY extends IMessage> 
      void      		registerMessage(java.lang.Class<? extends IMessageHandler<REQ,REPLY>> messageHandler, + java.lang.Class<REQ> requestMessageType, + int discriminator, + Side side) +
      Register a message and it's associated handler.
      +
      <REQ extends IMessage,REPLY extends IMessage> 
      void      		registerMessage(IMessageHandler<? super REQ,? extends REPLY> messageHandler, + java.lang.Class<REQ> requestMessageType, + int discriminator, + Side side) +
      Register a message and it's associated handler.
      +
      voidsendTo(IMessage message, + EntityPlayerMP player) +
      Send this message to the specified player.
      +
      voidsendToAll(IMessage message) +
      Send this message to everyone.
      +
      voidsendToAllAround(IMessage message, + NetworkRegistry.TargetPoint point) +
      Send this message to everyone within a certain range of a point.
      +
      voidsendToDimension(IMessage message, + int dimensionId) +
      Send this message to everyone within the supplied dimension.
      +
      voidsendToServer(IMessage message) +
      Send this message to the server.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        SimpleNetworkWrapper

        +
        public SimpleNetworkWrapper(java.lang.String channelName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerMessage

        +
        public <REQ extends IMessage,REPLY extends IMessage> void registerMessage(java.lang.Class<? extends IMessageHandler<REQ,REPLY>> messageHandler,
+                                                                 java.lang.Class<REQ> requestMessageType,
+                                                                 int discriminator,
+                                                                 Side side)
        +
        Register a message and it's associated handler. The message will have the supplied discriminator byte. The message handler will + be registered on the supplied side (this is the side where you want the message to be processed and acted upon).
        +
        Parameters:
        messageHandler - the message handler type
        requestMessageType - the message type
        discriminator - a discriminator byte
        side - the side for the handler
        +
        • +
      + + + +
        +
      • +

        registerMessage

        +
        public <REQ extends IMessage,REPLY extends IMessage> void registerMessage(IMessageHandler<? super REQ,? extends REPLY> messageHandler,
+                                                                 java.lang.Class<REQ> requestMessageType,
+                                                                 int discriminator,
+                                                                 Side side)
        +
        Register a message and it's associated handler. The message will have the supplied discriminator byte. The message handler will + be registered on the supplied side (this is the side where you want the message to be processed and acted upon).
        +
        Parameters:
        messageHandler - the message handler instance
        requestMessageType - the message type
        discriminator - a discriminator byte
        side - the side for the handler
        +
        • +
      + + + +
        +
      • +

        getPacketFrom

        +
        public Packet getPacketFrom(IMessage message)
        +
        Construct a minecraft packet from the supplied message. Can be used where minecraft packets are required, such as + TileEntity.getDescriptionPacket().
        +
        Parameters:
        message - The message to translate into packet form
        +
        Returns:
        A minecraft Packet suitable for use in minecraft APIs
        +
        • +
      + + + +
        +
      • +

        sendToAll

        +
        public void sendToAll(IMessage message)
        +
        Send this message to everyone. + The IMessageHandler for this message type should be on the CLIENT side.
        +
        Parameters:
        message - The message to send
        +
        • +
      + + + +
        +
      • +

        sendTo

        +
        public void sendTo(IMessage message,
+          EntityPlayerMP player)
        +
        Send this message to the specified player. + The IMessageHandler for this message type should be on the CLIENT side.
        +
        Parameters:
        message - The message to send
        player - The player to send it to
        +
        • +
      + + + + + + + +
        +
      • +

        sendToDimension

        +
        public void sendToDimension(IMessage message,
+                   int dimensionId)
        +
        Send this message to everyone within the supplied dimension. + The IMessageHandler for this message type should be on the CLIENT side.
        +
        Parameters:
        message - The message to send
        dimensionId - The dimension id to target
        +
        • +
      + + + +
        +
      • +

        sendToServer

        +
        public void sendToServer(IMessage message)
        +
        Send this message to the server. + The IMessageHandler for this message type should be on the SERVER side.
        +
        Parameters:
        message - The message to send
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html new file mode 100644 index 0000000..98a0059 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-frame.html @@ -0,0 +1,27 @@ + + + + + +cpw.mods.fml.common.network.simpleimpl (Forge API) + + + + +

cpw.mods.fml.common.network.simpleimpl

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html new file mode 100644 index 0000000..f8d4222 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-summary.html @@ -0,0 +1,170 @@ + + + + + +cpw.mods.fml.common.network.simpleimpl (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package cpw.mods.fml.common.network.simpleimpl

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html new file mode 100644 index 0000000..dd0391c --- /dev/null +++ b/javadoc/cpw/mods/fml/common/network/simpleimpl/package-tree.html @@ -0,0 +1,158 @@ + + + + + +cpw.mods.fml.common.network.simpleimpl Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package cpw.mods.fml.common.network.simpleimpl

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3