libjava/gnu/java/net/PlainDatagramSocketImpl.java

   1 /* PlainDatagramSocketImpl.java -- Default DatagramSocket implementation
   2    Copyright (C) 1998, 1999, 2001, 2003 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
  39 package gnu.java.net;
  40
  41 import java.io.IOException;
  42 import java.net.DatagramPacket;
  43 import java.net.DatagramSocketImpl;
  44 import java.net.InetAddress;
  45 import java.net.InetSocketAddress;
  46 import java.net.NetworkInterface;
  47 import java.net.SocketAddress;
  48 import java.net.SocketException;
  49 import java.net.SocketOptions;
  50 import gnu.classpath.Configuration;
  51
  52 /**
  53  * Written using on-line Java Platform 1.2 API Specification, as well
  54  * as "The Java Class Libraries", 2nd edition (Addison-Wesley, 1998).
  55  * Status:  Believed complete and correct.
  56  */
  57
  58 /**
  59  * This is the default socket implementation for datagram sockets.
  60  * It makes native calls to C routines that implement BSD style
  61  * SOCK_DGRAM sockets in the AF_INET family.
  62  *
  63  * @author Aaron M. Renn <arenn@urbanophile.com>
  64  * @author Warren Levy <warrenl@cygnus.com>
  65  */
  66 public final class PlainDatagramSocketImpl extends DatagramSocketImpl
  67 {
  68   // Static initializer to load native library
  69   static
  70   {
  71     if (Configuration.INIT_LOAD_LIBRARY)
  72       {
  73         System.loadLibrary("javanet");
  74       }
  75   }
  76
  77   // These fields are mirrored for use in native code to avoid cpp conflicts
  78   // when the #defines in system header files are the same as the public fields.
  79   static final int _Jv_TCP_NODELAY_ = SocketOptions.TCP_NODELAY,
  80                    _Jv_SO_BINDADDR_ = SocketOptions.SO_BINDADDR,
  81                    _Jv_SO_REUSEADDR_ = SocketOptions.SO_REUSEADDR,
  82                    _Jv_SO_BROADCAST_ = SocketOptions.SO_BROADCAST,
  83                    _Jv_SO_OOBINLINE_ = SocketOptions.SO_OOBINLINE,
  84                    _Jv_IP_MULTICAST_IF_ = SocketOptions.IP_MULTICAST_IF,
  85                    _Jv_IP_MULTICAST_IF2_ = SocketOptions.IP_MULTICAST_IF2,
  86                    _Jv_IP_MULTICAST_LOOP_ = SocketOptions.IP_MULTICAST_LOOP,
  87                    _Jv_IP_TOS_ = SocketOptions.IP_TOS,
  88                    _Jv_SO_LINGER_ = SocketOptions.SO_LINGER,
  89                    _Jv_SO_TIMEOUT_ = SocketOptions.SO_TIMEOUT,
  90                    _Jv_SO_SNDBUF_ = SocketOptions.SO_SNDBUF,
  91                    _Jv_SO_RCVBUF_ = SocketOptions.SO_RCVBUF,
  92                    _Jv_SO_KEEPALIVE_ = SocketOptions.SO_KEEPALIVE;
  93
  94   /**
  95    * This is the actual underlying file descriptor
  96    */
  97   int native_fd = -1;
  98
  99   // FIXME: Is this necessary?  Could it help w/ DatagramSocket.getLocalAddress?
 100   // InetAddress address;
 101
 102   // localAddress cache
 103   InetAddress localAddress;
 104
 105   // 'timeout' is set/read by setOption/getOption.
 106   int timeout = 0;
 107
 108   /**
 109    * Default do nothing constructor
 110    */
 111   public PlainDatagramSocketImpl()
 112   {
 113   }
 114
 115   protected void finalize() throws Throwable
 116   {
 117     synchronized (this)
 118       {
 119         if (native_fd != -1)
 120           close();
 121       }
 122     super.finalize();
 123   }
 124
 125   public int getNativeFD()
 126   {
 127     return native_fd;
 128   }
 129
 130   /**
 131    * Binds this socket to a particular port and interface
 132    *
 133    * @param port The port to bind to
 134    * @param addr The address to bind to
 135    *
 136    * @exception SocketException If an error occurs
 137    */
 138   protected native void bind(int lport, InetAddress laddr)
 139         throws SocketException;
 140
 141   protected native void connect (InetAddress i, int port)
 142         throws SocketException;
 143
 144   protected native void disconnect ();
 145
 146   /**
 147    * Creates a new datagram socket
 148    *
 149    * @exception SocketException If an error occurs
 150    */
 151   protected native void create() throws SocketException;
 152
 153   protected native int peek(InetAddress i) throws IOException;
 154
 155   protected native int peekData (DatagramPacket dp) throws IOException;
 156
 157   /**
 158    * Sets the Time to Live value for the socket
 159    *
 160    * @param ttl The new TTL value
 161    *
 162    * @exception IOException If an error occurs
 163    */
 164   protected native void setTimeToLive(int ttl) throws IOException;
 165
 166   /**
 167    * Gets the Time to Live value for the socket
 168    *
 169    * @return The TTL value
 170    *
 171    * @exception IOException If an error occurs
 172    */
 173   protected native int getTimeToLive() throws IOException;
 174
 175   /**
 176    * Sends a packet of data to a remote host
 177    *
 178    * @param packet The packet to send
 179    *
 180    * @exception IOException If an error occurs
 181    */
 182   protected native void send(DatagramPacket p) throws IOException;
 183
 184   /**
 185    * Receives a UDP packet from the network
 186    *
 187    * @param packet The packet to fill in with the data received
 188    *
 189    * @exception IOException IOException If an error occurs
 190    */
 191   protected native void receive(DatagramPacket p) throws IOException;
 192
 193   /**
 194    * Sets the value of an option on the socket
 195    *
 196    * @param option_id The identifier of the option to set
 197    * @param val The value of the option to set
 198    *
 199    * @exception SocketException If an error occurs
 200    */
 201   public native void setOption(int optID, Object value) throws SocketException;
 202
 203   /**
 204    * Retrieves the value of an option on the socket
 205    *
 206    * @param option_id The identifier of the option to retrieve
 207    *
 208    * @return The value of the option
 209    *
 210    * @exception SocketException If an error occurs
 211    */
 212   public native Object getOption(int optID) throws SocketException;
 213
 214   /**
 215    * Joins or leaves a broadcasting group on a given network interface.
 216    * If the network interface is <code>null</code> the group is join/left on
 217    * all locale network interfaces.
 218    *
 219    * @param inetAddr The broadcast address.
 220    * @param netIf The network interface to join the group on.
 221    * @param join True to join a broadcasting group, fals to leave it.
 222    *
 223    * @exception IOException If an error occurs.
 224    */
 225   private native void mcastGrp(InetAddress inetAddr,
 226                                NetworkInterface netIf,
 227                                boolean join)
 228     throws IOException;
 229
 230   /**
 231    * Closes the socket
 232    */
 233   protected native void close();
 234
 235   /**
 236    * Gets the Time to Live value for the socket
 237    *
 238    * @return The TTL value
 239    *
 240    * @exception IOException If an error occurs
 241    *
 242    * @deprecated 1.2
 243    */
 244   protected byte getTTL() throws IOException
 245   {
 246     return (byte) getTimeToLive();
 247   }
 248
 249   /**
 250    * Sets the Time to Live value for the socket
 251    *
 252    * @param ttl The new TTL value
 253    *
 254    * @exception IOException If an error occurs
 255    *
 256    * @deprecated 1.2
 257    */
 258   protected void setTTL(byte ttl) throws IOException
 259   {
 260     setTimeToLive(((int) ttl) & 0xFF);
 261   }
 262
 263   /**
 264    * Joins a multicast group
 265    *
 266    * @param addr The group to join
 267    *
 268    * @exception IOException If an error occurs
 269    */
 270   protected void join(InetAddress inetaddr) throws IOException
 271   {
 272     mcastGrp(inetaddr, null, true);
 273   }
 274
 275   /**
 276    * Leaves a multicast group
 277    *
 278    * @param addr The group to leave
 279    *
 280    * @exception IOException If an error occurs
 281    */
 282   protected void leave(InetAddress inetaddr) throws IOException
 283   {
 284     mcastGrp(inetaddr, null, false);
 285   }
 286
 287   protected void joinGroup (SocketAddress mcastaddr, NetworkInterface netIf)
 288           throws IOException
 289   {
 290     mcastGrp(((InetSocketAddress)mcastaddr).getAddress(), netIf, true);
 291   }
 292
 293   protected void leaveGroup (SocketAddress mcastaddr, NetworkInterface netIf)
 294           throws IOException
 295   {
 296     mcastGrp(((InetSocketAddress)mcastaddr).getAddress(), netIf, false);
 297   }
 298 }