libjava/java/nio/channels/spi/AbstractSelectableChannel.java

   1 /* AbstractSelectableChannel.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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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.spi;
  39
  40 import java.io.IOException;
  41 import java.nio.channels.ClosedChannelException;
  42 import java.nio.channels.SelectableChannel;
  43 import java.nio.channels.SelectionKey;
  44 import java.nio.channels.Selector;
  45 import java.util.LinkedList;
  46 import java.util.List;
  47 import java.util.ListIterator;
  48
  49 public abstract class AbstractSelectableChannel extends SelectableChannel
  50 {
  51   int registered;
  52   boolean blocking = true;
  53   Object LOCK = new Object ();
  54   SelectorProvider provider;
  55   List keys;
  56
  57   /**
  58    * Initializes the channel
  59    */
  60   protected AbstractSelectableChannel (SelectorProvider provider)
  61   {
  62     this.provider = provider;
  63   }
  64
  65   /**
  66    * Retrieves the object upon which the configureBlocking and register
  67    * methods synchronize.
  68    */
  69   public final Object blockingLock ()
  70   {
  71     return LOCK;
  72   }
  73
  74   /**
  75    * Adjusts this channel's blocking mode.
  76    */
  77   public final SelectableChannel configureBlocking (boolean block)
  78     throws IOException
  79   {
  80     synchronized (LOCK)
  81       {
  82         blocking = true;
  83         implConfigureBlocking (block);
  84       }
  85
  86     return this;
  87   }
  88
  89   /**
  90    * Closes this channel.
  91    *
  92    * @exception IOException If an error occurs
  93    */
  94   protected final void implCloseChannel () throws IOException
  95   {
  96     implCloseSelectableChannel ();
  97   }
  98
  99   /**
 100    * Closes this selectable channel.
 101    */
 102   protected abstract void implCloseSelectableChannel () throws IOException;
 103
 104   /**
 105    * Adjusts this channel's blocking mode.
 106    */
 107   protected abstract void implConfigureBlocking (boolean block)
 108     throws IOException;
 109
 110   /**
 111    * Tells whether or not every I/O operation on this channel will block
 112    * until it completes.
 113    */
 114   public final boolean isBlocking()
 115   {
 116     return blocking;
 117   }
 118
 119   /**
 120    * Tells whether or not this channel is currently registered with
 121    * any selectors.
 122    */
 123   public final boolean isRegistered()
 124   {
 125     return registered > 0;
 126   }
 127
 128   /**
 129    * Retrieves the key representing the channel's registration with the
 130    * given selector.
 131    */
 132   public final SelectionKey keyFor(Selector selector)
 133   {
 134     try
 135       {
 136         return register (selector, 0, null);
 137       }
 138     catch (Exception e)
 139       {
 140         return null;
 141       }
 142   }
 143
 144   /**
 145    * Returns the provider that created this channel.
 146    */
 147   public final SelectorProvider provider ()
 148   {
 149     return provider;
 150   }
 151
 152   private SelectionKey locate (Selector selector)
 153   {
 154     if (keys == null)
 155       return null;
 156
 157     SelectionKey k = null;
 158     ListIterator it = keys.listIterator ();
 159
 160     while (it.hasNext ())
 161       {
 162         k = (SelectionKey) it.next ();
 163         if (k.selector () == selector)
 164           {
 165             return k;
 166           }
 167       }
 168
 169     return k;
 170   }
 171
 172   private void add (SelectionKey key)
 173   {
 174     if (keys == null)
 175       {
 176         keys = new LinkedList ();
 177       }
 178
 179     keys.add (key);
 180   }
 181
 182   /**
 183    * Registers this channel with the given selector, returning a selection key.
 184    *
 185    * @exception ClosedChannelException If the channel is already closed.
 186    */
 187   public final SelectionKey register (Selector selin, int ops, Object att)
 188     throws ClosedChannelException
 189   {
 190     if (!isOpen ())
 191       throw new ClosedChannelException();
 192
 193     SelectionKey k = null;
 194     AbstractSelector selector = (AbstractSelector) selin;
 195
 196     synchronized (LOCK)
 197       {
 198         k = locate (selector);
 199
 200         if (k != null)
 201           {
 202             k.attach (att);
 203           }
 204         else
 205           {
 206             k = selector.register (this, ops, att);
 207
 208             if (k != null)
 209               add (k);
 210           }
 211       }
 212
 213     return k;
 214   }
 215 }