diff options
Diffstat (limited to 'libjava/java/nio/channels/spi')
5 files changed, 220 insertions, 123 deletions
diff --git a/libjava/java/nio/channels/spi/AbstractInterruptibleChannel.java b/libjava/java/nio/channels/spi/AbstractInterruptibleChannel.java index 5d9f886..98eaf48 100644 --- a/libjava/java/nio/channels/spi/AbstractInterruptibleChannel.java +++ b/libjava/java/nio/channels/spi/AbstractInterruptibleChannel.java @@ -1,5 +1,5 @@ /* AbstractInterruptibleChannel.java -- - Copyright (C) 2002 Free Software Foundation, Inc. + Copyright (C) 2002, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -42,6 +42,7 @@ import java.nio.channels.AsynchronousCloseException; import java.nio.channels.Channel; import java.nio.channels.InterruptibleChannel; + /** * @author Michael Koch * @since 1.4 @@ -54,25 +55,25 @@ public abstract class AbstractInterruptibleChannel /** * Initializes the channel. */ - protected AbstractInterruptibleChannel () + protected AbstractInterruptibleChannel() { } /** * Marks the beginning of an I/O operation that might block indefinitely. */ - protected final void begin () + protected final void begin() { } - + /** * Closes the channel. - * + * * @exception IOException If an error occurs */ - public final void close () throws IOException + public final void close() throws IOException { - if (!closed) + if (! closed) { closed = true; implCloseChannel(); @@ -81,29 +82,38 @@ public abstract class AbstractInterruptibleChannel /** * Marks the end of an I/O operation that might block indefinitely. - * + * + * @param completed true if the task completed successfully, + * false otherwise + * + * @exception IOException if an error occurs * @exception AsynchronousCloseException If the channel was asynchronously * closed. * @exception ClosedByInterruptException If the thread blocked in the * I/O operation was interrupted. */ - protected final void end (boolean completed) + protected final void end(boolean completed) throws AsynchronousCloseException { - } + // FIXME: check more here. + + if (closed) throw new AsynchronousCloseException(); + } /** * Closes the channel. - * + * * @exception IOException If an error occurs */ - protected abstract void implCloseChannel () throws IOException; + protected abstract void implCloseChannel() throws IOException; /** * Tells whether or not this channel is open. + * + * @return true if the channel is open, false otherwise */ - public final boolean isOpen () + public final boolean isOpen() { - return !closed; + return ! closed; } } diff --git a/libjava/java/nio/channels/spi/AbstractSelectableChannel.java b/libjava/java/nio/channels/spi/AbstractSelectableChannel.java index a07485d..ccc48c9 100644 --- a/libjava/java/nio/channels/spi/AbstractSelectableChannel.java +++ b/libjava/java/nio/channels/spi/AbstractSelectableChannel.java @@ -43,9 +43,9 @@ import java.nio.channels.SelectableChannel; import java.nio.channels.SelectionKey; import java.nio.channels.Selector; import java.util.LinkedList; -import java.util.List; import java.util.ListIterator; + public abstract class AbstractSelectableChannel extends SelectableChannel { private boolean blocking = true; @@ -55,8 +55,10 @@ public abstract class AbstractSelectableChannel extends SelectableChannel /** * Initializes the channel + * + * @param provider the provider that created this channel */ - protected AbstractSelectableChannel (SelectorProvider provider) + protected AbstractSelectableChannel(SelectorProvider provider) { this.provider = provider; } @@ -64,27 +66,35 @@ public abstract class AbstractSelectableChannel extends SelectableChannel /** * Retrieves the object upon which the configureBlocking and register * methods synchronize. + * + * @return the blocking lock */ - public final Object blockingLock () + public final Object blockingLock() { return LOCK; } - + /** * Adjusts this channel's blocking mode. + * + * @param blocking true if blocking should be enabled, false otherwise + * + * @return this channel + * + * @exception IOException If an error occurs */ - public final SelectableChannel configureBlocking (boolean blocking) + public final SelectableChannel configureBlocking(boolean blocking) throws IOException { synchronized (blockingLock()) { - if (this.blocking != blocking) - { - implConfigureBlocking(blocking); - this.blocking = blocking; - } + if (this.blocking != blocking) + { + implConfigureBlocking(blocking); + this.blocking = blocking; + } } - + return this; } @@ -93,25 +103,34 @@ public abstract class AbstractSelectableChannel extends SelectableChannel * * @exception IOException If an error occurs */ - protected final void implCloseChannel () throws IOException + protected final void implCloseChannel() throws IOException { - implCloseSelectableChannel (); + implCloseSelectableChannel(); } /** * Closes this selectable channel. + * + * @exception IOException If an error occurs */ - protected abstract void implCloseSelectableChannel () throws IOException; - + protected abstract void implCloseSelectableChannel() + throws IOException; + /** * Adjusts this channel's blocking mode. + * + * @param blocking true if blocking should be enabled, false otherwise + * + * @exception IOException If an error occurs */ - protected abstract void implConfigureBlocking (boolean block) + protected abstract void implConfigureBlocking(boolean blocking) throws IOException; /** * Tells whether or not every I/O operation on this channel will block * until it completes. + * + * @return true of this channel is blocking, false otherwise */ public final boolean isBlocking() { @@ -121,87 +140,104 @@ public abstract class AbstractSelectableChannel extends SelectableChannel /** * Tells whether or not this channel is currently registered with * any selectors. + * + * @return true if this channel is registered, false otherwise */ public final boolean isRegistered() { - return !keys.isEmpty(); + return ! keys.isEmpty(); } /** * Retrieves the key representing the channel's registration with the * given selector. + * + * @param selector the selector to get a selection key for + * + * @return the selection key this channel is registered with */ public final SelectionKey keyFor(Selector selector) { if (! isOpen()) return null; - + try { - synchronized(blockingLock()) + synchronized (blockingLock()) { - return locate (selector); + return locate(selector); } } catch (Exception e) { - return null; + return null; } } /** * Returns the provider that created this channel. + * + * @return the selector provider that created this channel */ - public final SelectorProvider provider () + public final SelectorProvider provider() { return provider; } - private SelectionKey locate (Selector selector) + private SelectionKey locate(Selector selector) { - ListIterator it = keys.listIterator (); - - while (it.hasNext ()) + ListIterator it = keys.listIterator(); + + while (it.hasNext()) { - SelectionKey key = (SelectionKey) it.next(); - - if (key.selector() == selector) - return key; + SelectionKey key = (SelectionKey) it.next(); + + if (key.selector() == selector) + return key; } - + return null; } /** * Registers this channel with the given selector, returning a selection key. * + * @param selin the seletor to use + * @param ops the interested operations + * @param att an attachment for the returned selection key + * + * @return the registered selection key + * * @exception ClosedChannelException If the channel is already closed. */ - public final SelectionKey register (Selector selin, int ops, Object att) + public final SelectionKey register(Selector selin, int ops, Object att) throws ClosedChannelException { - if (!isOpen ()) + if (! isOpen()) throw new ClosedChannelException(); + if ((ops & ~validOps()) != 0) + throw new IllegalArgumentException(); + SelectionKey key = null; AbstractSelector selector = (AbstractSelector) selin; synchronized (blockingLock()) { - key = locate (selector); + key = locate(selector); - if (key != null) - { + if (key != null) + { if (att != null) - key.attach (att); - } - else - { - key = selector.register (this, ops, att); - - if (key != null) - addSelectionKey (key); - } + key.attach(att); + } + else + { + key = selector.register(this, ops, att); + + if (key != null) + addSelectionKey(key); + } } return key; diff --git a/libjava/java/nio/channels/spi/AbstractSelectionKey.java b/libjava/java/nio/channels/spi/AbstractSelectionKey.java index 78e0a82..83d6421 100644 --- a/libjava/java/nio/channels/spi/AbstractSelectionKey.java +++ b/libjava/java/nio/channels/spi/AbstractSelectionKey.java @@ -1,4 +1,4 @@ -/* AbstractSelectionKey.java -- +/* AbstractSelectionKey.java -- Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -39,38 +39,40 @@ package java.nio.channels.spi; import java.nio.channels.SelectionKey; + /** * @since 1.4 */ -public abstract class AbstractSelectionKey - extends SelectionKey +public abstract class AbstractSelectionKey extends SelectionKey { - private boolean cancelled = false; + private boolean cancelled; /** * Initializes the key. */ - protected AbstractSelectionKey () + protected AbstractSelectionKey() { } /** * Cancels this key. */ - public final void cancel () + public final void cancel() { if (isValid()) { ((AbstractSelector) selector()).cancelKey(this); - cancelled = true; + cancelled = true; } } /** * Tells whether this key is valid or not. + * + * @return true if this key is valid, false otherwise */ - public final boolean isValid () + public final boolean isValid() { - return !cancelled; + return ! cancelled; } } diff --git a/libjava/java/nio/channels/spi/AbstractSelector.java b/libjava/java/nio/channels/spi/AbstractSelector.java index b657b5e..b1e20613 100644 --- a/libjava/java/nio/channels/spi/AbstractSelector.java +++ b/libjava/java/nio/channels/spi/AbstractSelector.java @@ -1,4 +1,4 @@ -/* AbstractSelector.java -- +/* AbstractSelector.java -- Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -35,49 +35,53 @@ this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version. */ - package java.nio.channels.spi; import java.io.IOException; import java.nio.channels.ClosedSelectorException; import java.nio.channels.SelectionKey; import java.nio.channels.Selector; -import java.util.Set; import java.util.HashSet; +import java.util.Set; + public abstract class AbstractSelector extends Selector { - private boolean closed = false; + private boolean closed; private SelectorProvider provider; private HashSet cancelledKeys; /** * Initializes the slector. + * + * @param provider the provider that created this selector */ - protected AbstractSelector (SelectorProvider provider) + protected AbstractSelector(SelectorProvider provider) { this.provider = provider; this.cancelledKeys = new HashSet(); } - + /** * Closes the channel. - * + * * @exception IOException If an error occurs */ - public final synchronized void close () throws IOException + public final synchronized void close() throws IOException { if (closed) return; - + implCloseSelector(); closed = true; } /** * Tells whether this channel is open or not. + * + * @return true if channel is open, false otherwise. */ - public final boolean isOpen () + public final boolean isOpen() { return ! closed; } @@ -95,21 +99,25 @@ public abstract class AbstractSelector extends Selector protected final void end() { } - + /** * Returns the provider for this selector object. + * + * @return the SelectorProvider object that created this seletor */ - public final SelectorProvider provider () + public final SelectorProvider provider() { return provider; } /** * Returns the cancelled keys set. + * + * @return the cancelled keys set */ protected final Set cancelledKeys() { - if (!isOpen()) + if (! isOpen()) throw new ClosedSelectorException(); return cancelledKeys; @@ -118,8 +126,9 @@ public abstract class AbstractSelector extends Selector /** * Cancels a selection key. */ + // This method is only called by AbstractSelectionKey.cancel(). - final void cancelKey (AbstractSelectionKey key) + final void cancelKey(AbstractSelectionKey key) { synchronized (cancelledKeys) { @@ -129,13 +138,29 @@ public abstract class AbstractSelector extends Selector /** * Closes the channel. + * + * @exception IOException if an error occurs */ - protected abstract void implCloseSelector () throws IOException; + protected abstract void implCloseSelector() throws IOException; - protected abstract SelectionKey register (AbstractSelectableChannel ch, - int ops, Object att); + /** + * Registers a channel for the selection process. + * + * @param ch the channel register + * @param ops the interested operations + * @param att an attachement to the selection key + * + * @return the registered selection key + */ + protected abstract SelectionKey register(AbstractSelectableChannel ch, + int ops, Object att); - protected final void deregister (AbstractSelectionKey key) + /** + * Deregisters the given selection key. + * + * @param key the key to deregister + */ + protected final void deregister(AbstractSelectionKey key) { ((AbstractSelectableChannel) key.channel()).removeSelectionKey(key); } diff --git a/libjava/java/nio/channels/spi/SelectorProvider.java b/libjava/java/nio/channels/spi/SelectorProvider.java index 1de3e4f..ac6e124 100644 --- a/libjava/java/nio/channels/spi/SelectorProvider.java +++ b/libjava/java/nio/channels/spi/SelectorProvider.java @@ -44,6 +44,7 @@ import java.nio.channels.Pipe; import java.nio.channels.ServerSocketChannel; import java.nio.channels.SocketChannel; + /** * @author Michael Koch * @since 1.4 @@ -51,76 +52,99 @@ import java.nio.channels.SocketChannel; public abstract class SelectorProvider { private static SelectorProvider systemDefaultProvider; - + /** * Initializes the selector provider. * * @exception SecurityException If a security manager has been installed and * it denies @see RuntimePermission ("selectorProvider"). */ - protected SelectorProvider () + protected SelectorProvider() { - SecurityManager sm = System.getSecurityManager (); + SecurityManager sm = System.getSecurityManager(); if (sm != null) - sm.checkPermission (new RuntimePermission ("selectorProvider")); + sm.checkPermission(new RuntimePermission("selectorProvider")); } - + /** * Opens a datagram channel. + * + * @return a new datagram channel object + * + * @exception IOException if an error occurs */ - public abstract DatagramChannel openDatagramChannel () throws IOException; - + public abstract DatagramChannel openDatagramChannel() + throws IOException; + /** * Opens a pipe. + * + * @return a new pipe object + * + * @exception IOException if an error occurs */ - public abstract Pipe openPipe () throws IOException; - + public abstract Pipe openPipe() throws IOException; + /** * Opens a selector. + * + * @return a new selector object + * + * @exception IOException if an error occurs */ - public abstract AbstractSelector openSelector () throws IOException; - + public abstract AbstractSelector openSelector() throws IOException; + /** * Opens a server socket channel. + * + * @return a new server socket channel object + * + * @exception IOException if an error occurs */ - public abstract ServerSocketChannel openServerSocketChannel () + public abstract ServerSocketChannel openServerSocketChannel() throws IOException; - + /** * Opens a socket channel. + * + * @return a new socket channel object + * + * @exception IOException if an error occurs */ - public abstract SocketChannel openSocketChannel () throws IOException; - + public abstract SocketChannel openSocketChannel() throws IOException; + /** * Returns the system-wide default selector provider for this invocation * of the Java virtual machine. + * + * @return the default seletor provider */ - public static synchronized SelectorProvider provider () + public static synchronized SelectorProvider provider() { if (systemDefaultProvider == null) { - String propertyValue = - System.getProperty ("java.nio.channels.spi.SelectorProvider"); - - if (propertyValue == null - || propertyValue.equals ("")) - systemDefaultProvider = new SelectorProviderImpl(); - else - { - try - { - systemDefaultProvider = (SelectorProvider) Class.forName - (propertyValue).newInstance(); - } - catch (Exception e) - { - System.err.println ("Could not instantiate class: " - + propertyValue); - systemDefaultProvider = new SelectorProviderImpl(); - } - } + String propertyValue = + System.getProperty("java.nio.channels.spi.SelectorProvider"); + + if (propertyValue == null || propertyValue.equals("")) + systemDefaultProvider = new SelectorProviderImpl(); + else + { + try + { + systemDefaultProvider = + (SelectorProvider) Class.forName(propertyValue) + .newInstance(); + } + catch (Exception e) + { + System.err.println("Could not instantiate class: " + + propertyValue); + systemDefaultProvider = new SelectorProviderImpl(); + } + } } - + return systemDefaultProvider; } } |