better documentation

This commit is contained in:
Trustin Lee 2010-01-08 23:12:00 +00:00
parent a8d9e044d2
commit 6e228216b4

View File

@ -17,6 +17,7 @@ package org.jboss.netty.channel;
import java.net.InetSocketAddress; import java.net.InetSocketAddress;
import java.net.SocketAddress; import java.net.SocketAddress;
import java.nio.channels.NotYetConnectedException;
import java.nio.channels.SelectionKey; import java.nio.channels.SelectionKey;
import org.jboss.netty.channel.socket.DatagramChannel; import org.jboss.netty.channel.socket.DatagramChannel;
@ -205,9 +206,10 @@ public interface Channel extends Comparable<Channel> {
/** /**
* Sends a message to this channel asynchronously. If this channel was * Sends a message to this channel asynchronously. If this channel was
* created by a connectionless transport (e.g. {@link DatagramChannel}) * created by a connectionless transport (e.g. {@link DatagramChannel})
* and is not connected yet, you call {@link #write(Object, SocketAddress)} * and is not connected yet, you have to call {@link #write(Object, SocketAddress)}
* instead. Otherwise, the write request will fail and an * instead. Otherwise, the write request will fail with
* {@code 'exceptionCaught'} event will be triggered. * {@link NotYetConnectedException} and an {@code 'exceptionCaught'} event
* will be triggered.
* *
* @param message the message to write * @param message the message to write
* *
@ -224,8 +226,8 @@ public interface Channel extends Comparable<Channel> {
* message instead of this channel's current remote address. If this * message instead of this channel's current remote address. If this
* channel was created by a connectionless transport (e.g. {@link DatagramChannel}) * channel was created by a connectionless transport (e.g. {@link DatagramChannel})
* and is not connected yet, you must specify non-null address. Otherwise, * and is not connected yet, you must specify non-null address. Otherwise,
* the write request will fail and an {@code 'exceptionCaught'} will be * the write request will fail with {@link NotYetConnectedException} and
* triggered. * an {@code 'exceptionCaught'} event will be triggered.
* *
* @param message the message to write * @param message the message to write
* @param remoteAddress where to send the specified message. * @param remoteAddress where to send the specified message.