diff --git a/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java b/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java index 6dffb90807..3e0db60fae 100644 --- a/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java +++ b/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java @@ -25,6 +25,8 @@ import org.jboss.netty.channel.ChannelPipeline; import org.jboss.netty.channel.ChannelSink; /** + * The default {@link LocalClientChannelFactory} implementation. + * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Andy Taylor (andy.taylor@jboss.org) * @author Trustin Lee (tlee@redhat.com) @@ -34,6 +36,9 @@ public class DefaultLocalClientChannelFactory implements LocalClientChannelFacto private final ChannelSink sink; + /** + * Creates a new instance. + */ public DefaultLocalClientChannelFactory() { sink = new LocalClientChannelSink(); } @@ -42,6 +47,10 @@ public class DefaultLocalClientChannelFactory implements LocalClientChannelFacto return new DefaultLocalChannel(null, this, pipeline, sink, null); } + /** + * Does nothing because this implementation does not require any external + * resources. + */ public void releaseExternalResources() { // No external resources. } diff --git a/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java b/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java index 869f7f54d4..8152b685c8 100644 --- a/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java +++ b/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java @@ -25,6 +25,8 @@ import org.jboss.netty.channel.ChannelPipeline; import org.jboss.netty.channel.ChannelSink; /** + * The default {@link LocalServerChannelFactory} implementation. + * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Andy Taylor (andy.taylor@jboss.org) * @author Trustin Lee (tlee@redhat.com) @@ -34,6 +36,9 @@ public class DefaultLocalServerChannelFactory implements LocalServerChannelFacto private final ChannelSink sink = new LocalServerChannelSink(); + /** + * Creates a new instance. + */ public DefaultLocalServerChannelFactory() { super(); } @@ -42,6 +47,10 @@ public class DefaultLocalServerChannelFactory implements LocalServerChannelFacto return new DefaultLocalServerChannel(this, pipeline, sink); } + /** + * Does nothing because this implementation does not require any external + * resources. + */ public void releaseExternalResources() { // Unused } diff --git a/src/main/java/org/jboss/netty/channel/local/LocalAddress.java b/src/main/java/org/jboss/netty/channel/local/LocalAddress.java index bdea49047f..96956f2de9 100644 --- a/src/main/java/org/jboss/netty/channel/local/LocalAddress.java +++ b/src/main/java/org/jboss/netty/channel/local/LocalAddress.java @@ -24,6 +24,16 @@ package org.jboss.netty.channel.local; import java.net.SocketAddress; /** + * Represents an endpoint in the local transport. Each endpoint is identified + * by a unique case-insensitive string, except for the pre-defined value called + * {@code "ephemeral"}. + * + *

Ephemeral Address

+ * + * An ephemeral address is an anonymous address which is assigned temporarily + * and is released as soon as the connection is closed. All ephemeral addresses + * have the same ID, {@code "ephemeral"}, but they are not equals to each other. + * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Andy Taylor (andy.taylor@jboss.org) * @author Trustin Lee (tlee@redhat.com) @@ -38,10 +48,16 @@ public final class LocalAddress extends SocketAddress implements Comparable