andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

More Javadoc

Browse Source
This commit is contained in:
Trustin Lee 2009-07-23 08:26:54 +00:00
parent 31bf9fd706
commit 6321bb406f
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/main/java/org/jboss/netty/channel/Channel.java
View File

@ -26,6 +26,8 @@ import java.net.InetSocketAddress;
import java.net.SocketAddress; import java.net.SocketAddress;
import org.jboss.netty.channel.socket.DatagramChannel; import org.jboss.netty.channel.socket.DatagramChannel;
import org.jboss.netty.channel.socket.ServerSocketChannel;
import org.jboss.netty.channel.socket.SocketChannel;
/** /**
@ -42,13 +44,26 @@ import org.jboss.netty.channel.socket.DatagramChannel;
* </ul> * </ul>
* *
* <h3>All I/O operations are asynchronous.</h3> * <h3>All I/O operations are asynchronous.</h3>
* * <p>
* All I/O operations in Netty are asynchronous. It means any I/O calls will * All I/O operations in Netty are asynchronous. It means any I/O calls will
* return immediately with no guarantee that the requested I/O operation has * return immediately with no guarantee that the requested I/O operation has
* been completed at the end of the call. Instead, you will be returned with * been completed at the end of the call. Instead, you will be returned with
* a {@link ChannelFuture} instance which tells you when the requested I/O * a {@link ChannelFuture} instance which will notify you when the requested I/O
* operation has succeeded, failed, or canceled. * operation has succeeded, failed, or canceled.
* *
* <h3>Channels are hierarchical</h3>
* <p>
* A {@link Channel} can have a {@linkplain #getParent() parent} depending on
* how it was created. For instance, a {@link SocketChannel}, that was accepted
* by {@link ServerSocketChannel}, will return the {@link ServerSocketChannel}
* as its parent on {@link #getParent()}.
* <p>
* The semantics of the hierarchical structure depends on the transport
* implementation where the {@link Channel} belongs to. For example, you could
* write a new {@link Channel} implementation that creates the sub-channels that
* share one socket connection, as <a href="http://beepcore.org/">BEEP</a> and
* <a href="http://en.wikipedia.org/wiki/Secure_Shell">SSH</a> do.
*
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* *