Hi,

On Wed, 2005-11-09 at 21:16 +0000, Roman Kennke wrote:
> Ingo has abstracted out the native code from gnu.java.net.PlainSocketImpl
> and gnu.java.net.PlainDatagramSocketImpl into a new VM interface. This
> allows VM implementors to provide a different implementation for the
> native parts of these classes if they wish. Is this ok to commit as it
> is? Do you have any suggestions/improvements to the interface? We would
> like to have a stable VM interface for this area, so maybe it would be
> helpful to discuss this with other VM implementors...

Great idea! This is one area where there is a large divergence between
classpath and libgcj because we never had VMClasses here. IKVM also has
a completely different implementation of these classes. So I hope Jeroen
also can take a look.

I have attached just the VM files to give others an idea what we want to
use. I'll comment some more after I have looked at the libgcj sources. A
first comment is that for the VM reference implementation I would just
make all methods native directly, no need to chain them to some helper
method here. Is there a reason that only nativeLeave() is synchronized?

After we agree on this VM interface (and I think it is good, I just want
to try it out first) we can discuss the rest of the patch. Just one
quick nitpick now already: please keep the boilerplate at the top of the
file intact, some of the files in the patch have the old FSF address.

Cheers,

Mark
/* VMPlainSocketImpl.java -- VM interface for default socket implementation
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
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 gnu.java.net;

import java.io.InputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.SocketException;
import java.net.SocketImpl;
import java.net.SocketOptions;
import gnu.classpath.Configuration;

/**
 * The VM interface for [EMAIL PROTECTED] gnu.java.net.PlainSocketImpl}.
 *
 * @author Ingo Proetel ([EMAIL PROTECTED])
 */
public final class VMPlainSocketImpl
{
  // Static initializer to load native library.
  static
    {
      if (Configuration.INIT_LOAD_LIBRARY)
        {
          System.loadLibrary("javanet");
        }
    }

  /**
   * Sets the specified option on a socket to the passed in object.  For
   * options that take an integer argument, the passed in object is an
   * Integer.  The option_id parameter is one of the defined constants in
   * this interface.
   *
   * @param option_id The identifier of the option
   * @param val The value to set the option to
   *
   * @exception SocketException If an error occurs
   */
  static void setOption(PlainSocketImpl socket, int optID, Object value)
    throws SocketException
  {
    nativeSetOption(socket, optID, value);
  }
  
  private static native void nativeSetOption(PlainSocketImpl socket,int optID,
                                             Object value)
    throws SocketException;

  /**
   * Returns the current setting of the specified option.  The Object returned
   * will be an Integer for options that have integer values.  The option_id
   * is one of the defined constants in this interface.
   *
   * @param option_id The option identifier
   *
   * @return The current value of the option
   *
   * @exception SocketException If an error occurs
   */
  static Object getOption(PlainSocketImpl socket, int optID)
    throws SocketException
  {
    return nativeGetOption(socket,optID);
  }
  
  private static native Object nativeGetOption(PlainSocketImpl socket,
                                               int optID)
    throws SocketException;



  /**
   * Creates a new socket that is not bound to any local address/port and
   * is not connected to any remote address/port.  This will be created as
   * a stream socket if the stream parameter is true, or a datagram socket
   * if the stream parameter is false.
   *
   * @param stream true for a stream socket, false for a datagram socket
   */
  static void create(PlainSocketImpl socket, boolean stream) throws IOException
  {
    nativeCreate(socket, stream);
  }

  private static native void nativeCreate(PlainSocketImpl socket,
                                          boolean stream)
    throws IOException;

  /**
   * Connects to the remote address and port specified as arguments.
   *
   * @param addr The remote address to connect to
   * @param port The remote port to connect to
   *
   * @exception IOException If an error occurs
   */
  static void connect(PlainSocketImpl socket, InetAddress addr, int port)
    throws IOException
  {
    nativeConnect(socket, addr, port);
  }

  private static native void nativeConnect(PlainSocketImpl socket,
                                           InetAddress addr, int port)
    throws IOException;


  /**
   * Binds to the specified port on the specified addr.  Note that this addr
   * must represent a local IP address.  **** How bind to INADDR_ANY? ****
   *
   * @param addr The address to bind to
   * @param port The port number to bind to
   *
   * @exception IOException If an error occurs
   */
  static void bind(PlainSocketImpl socket, InetAddress addr, int port)
    throws IOException
  {
    nativeBind(socket, addr, port);
  }

  private static native void nativeBind(PlainSocketImpl socket,
                                        InetAddress addr, int port)
    throws IOException;

  /**
   * Starts listening for connections on a socket. The queuelen parameter
   * is how many pending connections will queue up waiting to be serviced
   * before being accept'ed.  If the queue of pending requests exceeds this
   * number, additional connections will be refused.
   *
   * @param queuelen The length of the pending connection queue
   * 
   * @exception IOException If an error occurs
   */
  static void listen(PlainSocketImpl socket, int queuelen) throws IOException
  {
    nativeListen(socket,queuelen);
  }

  private static native void nativeListen(PlainSocketImpl socket, int queuelen)
    throws IOException;

  /**
   * Accepts a new connection on this socket and returns in in the 
   * passed in SocketImpl.
   *
   * @param impl The SocketImpl object to accept this connection.
   */
  static void accept(PlainSocketImpl socket, SocketImpl impl)
    throws IOException
  {
    nativeAccept(socket,impl);
  }

  private static native synchronized void nativeAccept(PlainSocketImpl socket,
                                                       SocketImpl impl)
    throws IOException;

  /**
   * Returns the number of bytes that the caller can read from this socket
   * without blocking. 
   *
   * @return The number of readable bytes before blocking
   *
   * @exception IOException If an error occurs
   */
  static int available(PlainSocketImpl socket) throws IOException
  {
    return nativeAvailable(socket);
  }

  private static native int nativeAvailable(PlainSocketImpl socket)
    throws IOException;

  /**
   * Closes the socket.  This will cause any InputStream or OutputStream
   * objects for this Socket to be closed as well.
   * <p>
   * Note that if the SO_LINGER option is set on this socket, then the
   * operation could block.
   *
   * @exception IOException If an error occurs
   */
  static void close(PlainSocketImpl socket) throws IOException
  {
    nativeClose(socket);
  }

  private static native void nativeClose(PlainSocketImpl socket)
    throws IOException;

  /**
   * Internal method used by SocketInputStream for reading data from
   * the connection.  Reads up to len bytes of data into the buffer
   * buf starting at offset bytes into the buffer.
   *
   * @return The actual number of bytes read or -1 if end of stream.
   *
   * @exception IOException If an error occurs
   */
  static int read(PlainSocketImpl socket, byte[] buf, int offset, int len)
    throws IOException
  {
    return nativeRead(socket, buf, offset, len);
  }

  private static native int nativeRead(PlainSocketImpl socket, byte[] buf,
                                       int offset, int len)
    throws IOException;

  /**
   * Internal method used by SocketOuputStream for writing data to
   * the connection.  Writes up to len bytes of data from the buffer
   * buf starting at offset bytes into the buffer.
   *
   * @exception IOException If an error occurs
   */
  static void write(PlainSocketImpl socket, byte[] buf, int offset, int len)
    throws IOException
  {
    nativeWrite(socket, buf, offset, len);
  }

  private static native void nativeWrite(PlainSocketImpl socket, byte[] buf,
                                         int offset, int len)
    throws IOException;

}
/* PlainDatagramSocketImpl.java -- VM interface for DatagramSocket impl
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
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 gnu.java.net;

import gnu.classpath.Configuration;

import java.io.IOException;
import java.net.DatagramPacket;
import java.net.DatagramSocketImpl;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketAddress;
import java.net.SocketException;

/**
 * The VM interface for [EMAIL PROTECTED] gnu.java.net.PlainDatagramSocketImpl}.
 *
 * @author Ingo Proetel ([EMAIL PROTECTED])
 */
public final class VMPlainDatagramSocketImpl
{
  // Static initializer to load native library
  static
  {
    if (Configuration.INIT_LOAD_LIBRARY)
      {
        System.loadLibrary("javanet");
      }
  }
  
  /**
   * Binds this socket to a particular port and interface
   *
   * @param port The port to bind to
   * @param addr The address to bind to
   *
   * @exception SocketException If an error occurs
   */  
  static void bind(PlainDatagramSocketImpl socket, int port, InetAddress addr) 
    throws SocketException
  {
    nativeBind(socket,port,addr);
  }

  private static native void nativeBind(PlainDatagramSocketImpl socket,
                                        int port, InetAddress addr)
    throws SocketException;

  /**
   * Creates a new datagram socket
   *
   * @exception SocketException If an error occurs
   */
  static void create(PlainDatagramSocketImpl socket) throws SocketException
  {
    nativeCreate(socket);
  }

  private static native void nativeCreate(PlainDatagramSocketImpl socket);

  /**
   * Connects to the remote address and port specified as arguments.
   *
   * @param addr The remote address to connect to
   * @param port The remote port to connect to
   *
   * @exception SocketException If an error occurs
   */
  static void connect(PlainDatagramSocketImpl socket, InetAddress addr,
                      int port) throws SocketException
  {
    nativeConnect(socket,addr,port);
  }

  private static native void nativeConnect(PlainDatagramSocketImpl socket,
                                           InetAddress addr, int port)
    throws SocketException;


  /**
   * Sends a packet of data to a remote host
   *
   * @param packet The packet to send
   *
   * @exception IOException If an error occurs
   */
  static void send(PlainDatagramSocketImpl socket, DatagramPacket packet)
    throws IOException
  {
    nativeSendTo(socket, packet.getAddress(), packet.getPort(),
                 packet.getData(), packet.getOffset(), packet.getLength());
  }


  /**
   * Sends a packet of data to a remote host
   *
   * @param addr The address to send to
   * @param port The port to send to 
   * @param buf The buffer to send
   * @param offset The offset of the data in the buffer to send
   * @param len The length of the data to send
   *
   * @exception IOException If an error occurs
   */
  private static native void nativeSendTo(PlainDatagramSocketImpl socket,
                                          InetAddress addr, int port,
                                          byte[] buf, int offset, int len)
    throws IOException;


  /**
   * Receives a UDP packet from the network
   *
   * @param packet The packet to fill in with the data received
   *
   * @exception IOException IOException If an error occurs
   */
  static void receive(PlainDatagramSocketImpl socket, DatagramPacket packet)
    throws IOException
  {
    nativeReceive(socket,packet);
  }

  private static native void nativeReceive(PlainDatagramSocketImpl socket,
                                           DatagramPacket packet)
    throws IOException;


  /**
   * Sets the value of an option on the socket
   *
   * @param option_id The identifier of the option to set
   * @param val The value of the option to set
   *
   * @exception SocketException If an error occurs
   */
  static void setOption(PlainDatagramSocketImpl socket, int option_id,
                        Object val)
    throws SocketException
  {
    nativeSetOption(socket, option_id, val);
  }

  private static native void nativeSetOption(PlainDatagramSocketImpl socket,
                                             int option_id, Object val);

  /**
   * Retrieves the value of an option on the socket
   *
   * @param option_id The identifier of the option to retrieve
   *
   * @return The value of the option
   *
   * @exception SocketException If an error occurs
   */
  static Object getOption(PlainDatagramSocketImpl socket, int option_id)
    throws SocketException
  {
    return nativeGetOption(socket, option_id);
  }

  private static native Object nativeGetOption(PlainDatagramSocketImpl socket,
                                               int option_id)
    throws SocketException;

  /**
   * Closes the socket
   */
  static void close(PlainDatagramSocketImpl socket)
  {
    nativeClose(socket);
  }

  private static native void nativeClose(PlainDatagramSocketImpl socket);


  /**
   * Joins a multicast group
   *
   * @param addr The group to join
   *
   * @exception IOException If an error occurs
   */
  static void join(PlainDatagramSocketImpl socket, InetAddress addr)
    throws IOException
  {
    nativeJoin(socket,addr);
  }

  private static native void nativeJoin(PlainDatagramSocketImpl socket,
                                        InetAddress addr)
    throws IOException;

  /**
   * Leaves a multicast group
   *
   * @param addr The group to leave
   *
   * @exception IOException If an error occurs
   */
  static void leave(PlainDatagramSocketImpl socket, InetAddress addr)
    throws IOException
  {
    nativeLeave(socket,addr);
  }

  private static native synchronized void nativeLeave
  (PlainDatagramSocketImpl socket, InetAddress addr) throws IOException;

}

Attachment: signature.asc
Description: This is a digitally signed message part

_______________________________________________
Classpath-patches mailing list
Classpath-patches@gnu.org
http://lists.gnu.org/mailman/listinfo/classpath-patches

Reply via email to