nio/channels/package-info.java

27  * Defines channels, which represent connections to entities that are capable of
31  * <a id="channels"></a>
34  *     <caption style="display:none">Lists channels and their descriptions</caption>
40  * <tr><th scope="row"><i>{@link java.nio.channels.Channel}</i></th>
43  *     <span style="padding-left:1em"><i>{@link java.nio.channels.ReadableByteChannel}</i></span></th>
46  *     <span style="padding-left:2em"><i>{@link java.nio.channels.ScatteringByteChannel}</i></span></th>
49  *     <span style="padding-left:1em"><i>{@link java.nio.channels.WritableByteChannel}</i></span></th>
52  *     <span style="padding-left:2em"><i>{@link java.nio.channels.GatheringByteChannel}</i></span></th>
55  *     <span style="padding-left:1em"><i>{@link java.nio.channels.ByteChannel}</i></span></th>
58  *     <span style="padding-left:2em"><i>{@link java.nio.channels.SeekableByteChannel}</i></span></th>
62  *     <span style="padding-left:1em"><i>{@link java.nio.channels.AsynchronousChannel}</i></span></th>
65  *     <span style="padding-left:2em"><i>{@link java.nio.channels.AsynchronousByteChannel}</i></span></th>
68  *     <span style="padding-left:1em"><i>{@link java.nio.channels.NetworkChannel}</i></span></th>
71  *     <span style="padding-left:2em"><i>{@link java.nio.channels.MulticastChannel}</i></span></th>
73  * <tr><th scope="row">{@link java.nio.channels.Channels}</th>
81  * or writing.  As specified in the {@link java.nio.channels.Channel} interface,
82  * channels are either open or closed, and they are both <i>asynchronously
85  * <p> The {@link java.nio.channels.Channel} interface is extended by several
88  * <p> The {@link java.nio.channels.ReadableByteChannel} interface specifies a
89  * {@link java.nio.channels.ReadableByteChannel#read read} method that reads bytes
91  * java.nio.channels.WritableByteChannel} interface specifies a {@link
92  * java.nio.channels.WritableByteChannel#write write} method that writes bytes
93  * from a buffer to the channel. The {@link java.nio.channels.ByteChannel}
94  * interface unifies these two interfaces for the common case of channels that can
95  * both read and write bytes. The {@link java.nio.channels.SeekableByteChannel}
97  * java.nio.channels.SeekableByteChannel#position() query} and {@link
98  * java.nio.channels.SeekableByteChannel#position(long) modify} the channel's
99  * current position, and its {@link java.nio.channels.SeekableByteChannel#size
102  * <p> The {@link java.nio.channels.ScatteringByteChannel} and {@link
103  * java.nio.channels.GatheringByteChannel} interfaces extend the {@link
104  * java.nio.channels.ReadableByteChannel} and {@link
105  * java.nio.channels.WritableByteChannel} interfaces, respectively, adding {@link
106  * java.nio.channels.ScatteringByteChannel#read read} and {@link
107  * java.nio.channels.GatheringByteChannel#write write} methods that take a
110  * <p> The {@link java.nio.channels.NetworkChannel} interface specifies methods
111  * to {@link java.nio.channels.NetworkChannel#bind bind} the channel's socket,
113  * java.nio.channels.NetworkChannel#getOption get} and {@link
114  * java.nio.channels.NetworkChannel#setOption set} socket options. The {@link
115  * java.nio.channels.MulticastChannel} interface specifies methods to join
118  * <p> The {@link java.nio.channels.Channels} utility class defines static methods
131  *         Lists file channels and their descriptions</caption>
133  * <tr><th scope="col">File channels</th>
138  *     {@link java.nio.channels.FileChannel}</th>
141  *     {@link java.nio.channels.FileLock}</th>
149  * <p> The {@link java.nio.channels.FileChannel} class supports the usual
154  * instances of the {@link java.nio.channels.FileLock} class.  Finally, it defines
157  * channels, and for mapping a region of the file directly into memory.
160  * java.nio.channels.FileChannel#open open} methods, or by invoking the {@code
169  *         Lists multiplexed, non-blocking channels and their descriptions</caption>
175  * <tr><th scope="row">{@link java.nio.channels.SelectableChannel}</th>
178  *     <span style="padding-left:2em">{@link java.nio.channels.DatagramChannel}</span></th>
181  *     <span style="padding-left:2em">{@link java.nio.channels.Pipe.SinkChannel}</span></th>
184  *     <span style="padding-left:2em">{@link java.nio.channels.Pipe.SourceChannel}</span></th>
187  *     <span style="padding-left:2em">{@link java.nio.channels.ServerSocketChannel}</span></th>
190  *     <span style="padding-left:2em">{@link java.nio.channels.SocketChannel}</span></th>
192  * <tr><th scope="row">{@link java.nio.channels.Selector}</th>
193  *     <td>A multiplexor of selectable channels</td></tr>
194  * <tr><th scope="row">{@link java.nio.channels.SelectionKey}</th>
197  * <tr><th scope="row">{@link java.nio.channels.Pipe}</th>
198  *     <td>Two channels that form a unidirectional pipe</td></tr>
204  * channels</i>, and <i>selection keys</i>.
207  * href="SelectableChannel.html"><i>selectable channels</i></a>, which in turn are
210  * multiplexed I/O operations, one or more selectable channels are first created,
212  * java.nio.channels.SelectableChannel#register <i>registered</i>}
218  * <p> Once some channels have been registered with a selector, a <a
220  * order to discover which channels, if any, have become ready to perform one or
238  * are associated with channels.  This package also defines a simple class that
244  * <p> The implementation of selectors, selectable channels, and selection keys
246  * {@link java.nio.channels.spi.SelectorProvider} class defined in the {@link
247  * java.nio.channels.spi} package.  It is not expected that many developers
254  * java.nio.channels.spi.AbstractInterruptibleChannel}, {@link
255  * java.nio.channels.spi.AbstractSelectableChannel}, {@link
256  * java.nio.channels.spi.AbstractSelectionKey}, and {@link
257  * java.nio.channels.spi.AbstractSelector} classes in the {@link
258  * java.nio.channels.spi} package.  When defining a custom selector provider,
259  * only the {@link java.nio.channels.spi.AbstractSelector} and {@link
260  * java.nio.channels.spi.AbstractSelectionKey} classes should be subclassed
262  * java.nio.channels.SelectableChannel} subclasses defined in this package.
268  *         Lists asynchronous channels and their descriptions</caption>
275  *     {@link java.nio.channels.AsynchronousFileChannel}</th>
278  *     {@link java.nio.channels.AsynchronousSocketChannel}</th>
281  *     {@link java.nio.channels.AsynchronousServerSocketChannel}</th>
284  *     {@link java.nio.channels.CompletionHandler}</th>
287  *     {@link java.nio.channels.AsynchronousChannelGroup}</th>
288  *     <td>A grouping of asynchronous channels for the purpose of resource sharing</td></tr>
292  * <p> {@link java.nio.channels.AsynchronousChannel Asynchronous channels} are a
294  * channels are non-blocking and define methods to initiate asynchronous
298  * specify a {@link java.nio.channels.CompletionHandler} to invoke when the
304  * It also defines the {@link java.nio.channels.AsynchronousFileChannel} class
306  * java.nio.channels.FileChannel} it supports operations to truncate the file
313  * <p> Asynchronous channels are bound to an asynchronous channel group for the
317  * asynchronous operations performed on channels in the group. The group can
323  * <p> As with selectors, the implementation of asynchronous channels can be
325  * java.nio.channels.spi.AsynchronousChannelProvider} class defined in the
326  * {@link java.nio.channels.spi} package.  It is not expected that many
340 package java.nio.channels;