libjava/java/nio/channels/DatagramChannel.java

   1 /* DatagramChannel.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;
  39
  40 import java.io.IOException;
  41 import java.net.DatagramSocket;
  42 import java.net.SocketAddress;
  43 import java.nio.ByteBuffer;
  44 import java.nio.channels.spi.AbstractSelectableChannel;
  45 import java.nio.channels.spi.SelectorProvider;
  46
  47 /**
  48  * @since 1.4
  49  */
  50 public abstract class DatagramChannel
  51   extends AbstractSelectableChannel
  52   implements ByteChannel, ScatteringByteChannel, GatheringByteChannel
  53 {
  54   /**
  55    * Initializes the channel.
  56    */
  57   protected DatagramChannel (SelectorProvider provider)
  58   {
  59     super (provider);
  60   }
  61
  62   /**
  63    * Opens a datagram channel.
  64    *
  65    * @exception IOException If an error occurs
  66    */
  67   public static DatagramChannel open () throws IOException
  68   {
  69     return SelectorProvider.provider ().openDatagramChannel ();
  70   }
  71
  72   /**
  73    * Reads data from this channel.
  74    */
  75   public final long read (ByteBuffer[] dsts) throws IOException
  76   {
  77     long b = 0;
  78
  79     for (int i = 0; i < dsts.length; i++)
  80       b += read (dsts[i]);
  81
  82     return b;
  83   }
  84
  85   /**
  86    * Writes data to this channel.
  87    *
  88    * @exception IOException If an error occurs
  89    * @exception NotYetConnectedException The channel's socket is not connected.
  90    */
  91   public final long write (ByteBuffer[] srcs) throws IOException
  92   {
  93     long b = 0;
  94
  95     for (int i = 0;i < srcs.length; i++)
  96       b += write (srcs[i]);
  97
  98     return b;
  99   }
 100
 101   /**
 102    * Connects this channel's socket.
 103    *
 104    * @exception AsynchronousCloseException If another thread closes this channel
 105    * while the connect operation is in progress.
 106    * @exception ClosedByInterruptException If another thread interrupts the
 107    * current thread while the read operation is in progress, thereby closing the
 108    * channel and setting the current thread's interrupt status.
 109    * @exception ClosedChannelException If this channel is closed.
 110    * @exception IOException If an error occurs.
 111    * @exception SecurityException If a security manager has been installed and
 112    * it does not permit datagrams to be sent to the given address.
 113    */
 114   public abstract DatagramChannel connect (SocketAddress remote)
 115     throws IOException;
 116
 117   /**
 118    * Disonnects this channel's socket.
 119    *
 120    * @exception IOException If an error occurs
 121    */
 122   public abstract DatagramChannel disconnect () throws IOException;
 123
 124   /**
 125    * Tells whether or not this channel's socket is connected.
 126    *
 127    * @exception IOException If an error occurs.
 128    * @exception NotYetConnectedException The channel's socket is not connected.
 129    */
 130   public abstract boolean isConnected ();
 131
 132   /**
 133    * Reads data from this channel.
 134    */
 135   public abstract int read (ByteBuffer dst) throws IOException;
 136
 137   /**
 138    * Reads data from this channel.
 139    *
 140    * @exception IOException If an error occurs.
 141    * @exception NotYetConnectedException The channel's socket is not connected.
 142    */
 143   public abstract long read (ByteBuffer[] dsts, int offset, int length)
 144     throws IOException;
 145
 146   /**
 147    * Receives a datagram via this channel.
 148    *
 149    * @exception AsynchronousCloseException If another thread closes this channel
 150    * while the connect operation is in progress.
 151    * @exception ClosedByInterruptException If another thread interrupts the
 152    * current thread while the read operation is in progress, thereby closing the
 153    * channel and setting the current thread's interrupt status.
 154    * @exception ClosedChannelException If this channel is closed.
 155    * @exception IOException If an error occurs
 156    * @exception SecurityException If a security manager has been installed and
 157    * it does not permit datagrams to be sent to the given address.
 158    */
 159   public abstract SocketAddress receive (ByteBuffer dst) throws IOException;
 160
 161   /**
 162    * Sends a datagram via this channel.
 163    *
 164    * @exception AsynchronousCloseException If another thread closes this channel
 165    * while the connect operation is in progress.
 166    * @exception ClosedByInterruptException If another thread interrupts the
 167    * current thread while the read operation is in progress, thereby closing the
 168    * channel and setting the current thread's interrupt status.
 169    * @exception ClosedChannelException If this channel is closed.
 170    * @exception IOException If an error occurs
 171    * @exception SecurityException If a security manager has been installed and
 172    * it does not permit datagrams to be sent to the given address.
 173    */
 174   public abstract int send (ByteBuffer src, SocketAddress target)
 175     throws IOException;
 176
 177   /**
 178    * Retrieves the channel's socket.
 179    */
 180   public abstract DatagramSocket socket ();
 181
 182   /**
 183    * Writes data to this channel.
 184    *
 185    * @exception IOException If an error occurs.
 186    * @exception NotYetConnectedException The channel's socket is not connected.
 187    */
 188   public abstract int write (ByteBuffer src) throws IOException;
 189
 190   /**
 191    * Writes data to this channel.
 192    *
 193    * @exception IOException If an error occurs.
 194    * @exception NotYetConnectedException The channel's socket is not connected.
 195    */
 196   public abstract long write (ByteBuffer[] srcs, int offset, int length)
 197     throws IOException;
 198
 199   /**
 200    * Retrieves the valid operations for this channel.
 201    *
 202    * @exception IOException If an error occurs.
 203    * @exception NotYetConnectedException The channel's socket is not connected.
 204    */
 205   public final int validOps ()
 206   {
 207     return SelectionKey.OP_READ | SelectionKey.OP_WRITE;
 208   }
 209 }