gomp-20050608-branch/libjava/classpath/java/nio/channels/SelectableChannel.java

   1 /* SelectableChannel.java --
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.nio.channels;
  39
  40 import java.io.IOException;
  41 import java.nio.channels.spi.AbstractInterruptibleChannel;
  42 import java.nio.channels.spi.SelectorProvider;
  43
  44
  45 /**
  46  * @author Michael Koch
  47  * @since 1.4
  48  */
  49 public abstract class SelectableChannel extends AbstractInterruptibleChannel
  50 {
  51   /**
  52    * Initializes the channel.
  53    */
  54   protected SelectableChannel()
  55   {
  56   }
  57
  58   /**
  59    * Returns the lock of this channel.
  60    */
  61   public abstract Object blockingLock();
  62
  63   /**
  64    * Adjusts this channel's blocking mode.
  65    *
  66    * @exception ClosedChannelException If this channel is closed.
  67    * @exception IllegalBlockingModeException If block is true and this channel
  68    * is registered with one or more selectors.
  69    * @exception IOException If an error occurs.
  70    */
  71   public abstract SelectableChannel configureBlocking(boolean block)
  72     throws IOException;
  73
  74   /**
  75    * Tells whether this channel is blocking or not.
  76    */
  77   public abstract boolean isBlocking();
  78
  79   /**
  80    * Tells whether or not this channel is currently registered with
  81    * any selectors.
  82    */
  83   public abstract boolean isRegistered();
  84
  85   /**
  86    * Retrieves the key representing the channel's registration with
  87    * the given selector.
  88    */
  89   public abstract SelectionKey keyFor(Selector sel);
  90
  91   /**
  92    * Returns the provider that created this channel.
  93    */
  94   public abstract SelectorProvider provider();
  95
  96   /**
  97    * Registers this channel with the given selector,
  98    * returning a selection key.
  99    *
 100    * @exception CancelledKeyException If this channel is currently registered
 101    * with the given selector but the corresponding key has already been cancelled
 102    * @exception ClosedChannelException If this channel is closed.
 103    * @exception IllegalArgumentException If a bit in ops does not correspond
 104    * to an operation that is supported by this channel, that is, if
 105    * set &amp; ~validOps() != 0.
 106    * @exception IllegalBlockingModeException If block is true and this channel
 107    * is registered with one or more selectors.
 108    * @exception IllegalSelectorException If this channel was not created by
 109    * the same provider as the given selector.
 110    */
 111   public final SelectionKey register(Selector sel, int ops)
 112     throws ClosedChannelException
 113   {
 114     return register(sel, ops, null);
 115   }
 116
 117   /**
 118    * Registers this channel with the given selector,
 119    * returning a selection key.
 120    *
 121    * @exception CancelledKeyException If this channel is currently registered
 122    * with the given selector but the corresponding key has already been
 123    * cancelled.
 124    * @exception ClosedChannelException If this channel is closed.
 125    * @exception IllegalArgumentException If a bit in ops does not correspond
 126    * to an operation that is supported by this channel, that is, if
 127    * set &amp; ~validOps() != 0.
 128    * @exception IllegalBlockingModeException If block is true and this channel
 129    * is registered with one or more selectors.
 130    * @exception IllegalSelectorException If this channel was not created by
 131    * the same provider as the given selector.
 132    */
 133   public abstract SelectionKey register(Selector sel, int ops, Object att)
 134     throws ClosedChannelException;
 135
 136   /**
 137    * Returns a set of valid operations on this channel.
 138    */
 139   public abstract int validOps();
 140 }