diff options
Diffstat (limited to 'libjava/java/net/ServerSocket.java')
| -rw-r--r-- | libjava/java/net/ServerSocket.java | 226 |
1 files changed, 190 insertions, 36 deletions
diff --git a/libjava/java/net/ServerSocket.java b/libjava/java/net/ServerSocket.java index bc1b072..23792a9 100644 --- a/libjava/java/net/ServerSocket.java +++ b/libjava/java/net/ServerSocket.java @@ -1,111 +1,265 @@ -// ServerSocket.java +/* ServerSocket.java -- Class for implementing server side sockets + Copyright (C) 1998, 1999, 2000, 2002 Free Software Foundation, Inc. -/* Copyright (C) 1999 Free Software Foundation +This file is part of GNU Classpath. - This file is part of libgcj. +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. -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -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., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. -/** - * @author Per Bothner <bothner@cygnus.com> - * @date January 6, 1999. - */ - -/** Written using on-line Java Platform 1.2 API Specification. - * Status: I believe all methods are implemented. - */ +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ package java.net; -import java.io.*; +import java.io.IOException; + +/* Written using on-line Java Platform 1.2 API Specification. + * Status: I believe all methods are implemented. + */ + +/** + * This class models server side sockets. The basic model is that the + * server socket is created and bound to some well known port. It then + * listens for and accepts connections. At that point the client and + * server sockets are ready to communicate with one another utilizing + * whatever application layer protocol they desire. + * <p> + * As with the <code>Socket</code> class, most instance methods of this class + * simply redirect their calls to an implementation class. + * + * @author Aaron M. Renn (arenn@urbanophile.com) + * @author Per Bothner (bothner@cygnus.com) + */ public class ServerSocket { - static SocketImplFactory factory; - SocketImpl impl; - static final byte[] zeros = {0,0,0,0}; - /* dummy InetAddress, used to bind socket to any (all) network interfaces */ - static final InetAddress ANY_IF = new InetAddress(zeros, null); + // Class Variables + + /** + * This is the user defined SocketImplFactory, if one is supplied + */ + private static SocketImplFactory factory; + // Instance Variables + + /** + * This is the SocketImp object to which most instance methods in this + * class are redirected + */ + private SocketImpl impl; + + /** + * Private constructor that simply sets the implementation. + */ + private ServerSocket() + { + if (factory != null) + impl = factory.createSocketImpl(); + else + impl = new PlainSocketImpl(); + } + + /** + * Creates a server socket and binds it to the specified port. If the + * port number is 0, a random free port will be chosen. The pending + * connection queue on this socket will be set to 50. + * + * @param port The port number to bind to + * + * @exception IOException If an error occurs + */ public ServerSocket (int port) throws java.io.IOException { this(port, 50); } + /** + * Creates a server socket and binds it to the specified port. If the + * port number is 0, a random free port will be chosen. The pending + * connection queue on this socket will be set to the value passed as + * arg2. + * + * @param port The port number to bind to + * @param backlog The length of the pending connection queue + * + * @exception IOException If an error occurs + */ public ServerSocket (int port, int backlog) throws java.io.IOException { - this(port, backlog, ANY_IF); + this(port, backlog, null); } + /** + * Creates a server socket and binds it to the specified port. If the + * port number is 0, a random free port will be chosen. The pending + * connection queue on this socket will be set to the value passed as + * backlog. The third argument specifies a particular local address to + * bind t or null to bind to all local address. + * + * @param port The port number to bind to + * @param backlog The length of the pending connection queue + * @param bindAddr The address to bind to, or null to bind to all addresses + * + * @exception IOException If an error occurs + */ public ServerSocket (int port, int backlog, InetAddress bindAddr) throws java.io.IOException { - if (factory == null) - this.impl = new PlainSocketImpl(); - else - this.impl = factory.createSocketImpl(); + this(); + if (impl == null) + throw new IOException("Cannot initialize Socket implementation"); + SecurityManager s = System.getSecurityManager(); if (s != null) s.checkListen(port); + + if (bindAddr == null) + bindAddr = InetAddress.ANY_IF; + impl.create(true); - impl.bind(bindAddr == null ? ANY_IF : bindAddr, port); + impl.bind(bindAddr, port); impl.listen(backlog); } + /** + * This method returns the local address to which this socket is bound + * + * @return The socket's local address + */ public InetAddress getInetAddress() { return impl.getInetAddress(); } + /** + * This method returns the local port number to which this socket is bound + * + * @return The socket's port number + */ public int getLocalPort() { return impl.getLocalPort(); } + /** + * Accepts a new connection and returns a connected <code>Socket</code> + * instance representing that connection. This method will block until a + * connection is available. + * + * @exception IOException If an error occurs + */ public Socket accept () throws IOException { - Socket s = new Socket(Socket.factory == null ? new PlainSocketImpl() - : Socket.factory.createSocketImpl()); + Socket s = new Socket(); implAccept (s); + return s; } + /** + * This protected method is used to help subclasses override + * <code>ServerSocket.accept()</code>. The passed in socket will be + * connected when this method returns. + * + * @param socket The socket that is used for the accepted connection + * + * @exception IOException If an error occurs + */ protected final void implAccept (Socket s) throws IOException { impl.accept(s.impl); } + /** + * Closes this socket and stops listening for connections + * + * @exception IOException If an error occurs + */ public void close () throws IOException { impl.close(); } - public synchronized void setSoTimeout (int timeout) throws SocketException + /** + * Sets the value of SO_TIMEOUT. A value of 0 implies that SO_TIMEOUT is + * disabled (ie, operations never time out). This is the number of + * milliseconds a socket operation can block before an + * InterruptedIOException is thrown. + * + * @param timeout The new SO_TIMEOUT value + * + * @exception IOException If an error occurs + */ + public void setSoTimeout (int timeout) throws SocketException { if (timeout < 0) - throw new IllegalArgumentException("Invalid timeout: " + timeout); + throw new IllegalArgumentException("SO_TIMEOUT value must be >= 0"); impl.setOption(SocketOptions.SO_TIMEOUT, new Integer(timeout)); } - public synchronized int getSoTimeout () throws SocketException + /** + * Retrieves the current value of the SO_TIMEOUT setting. A value of 0 + * implies that SO_TIMEOUT is disabled (ie, operations never time out). + * This is the number of milliseconds a socket operation can block before + * an InterruptedIOException is thrown. + * + * @return The value of SO_TIMEOUT + * + * @exception IOException If an error occurs + */ + public int getSoTimeout () throws IOException { Object timeout = impl.getOption(SocketOptions.SO_TIMEOUT); - if (timeout instanceof Integer) - return ((Integer)timeout).intValue(); - else - return 0; + + if (!(timeout instanceof Integer)) + throw new IOException("Internal Error"); + + return ((Integer)timeout).intValue(); } + /** + * Returns the value of this socket as a <code>String</code>. + * + * @return This socket represented as a <code>String</code>. + */ public String toString () { - return "ServerSocket" + impl.toString(); + return "ServerSocket " + impl.toString(); } + // Class methods + + /** + * Sets the <code>SocketImplFactory</code> for all + * <code>ServerSocket</code>'s. This may only be done + * once per virtual machine. Subsequent attempts will generate an + * exception. Note that a <code>SecurityManager</code> check is made prior + * to setting the factory. If insufficient privileges exist to set the + * factory, an exception will be thrown + * + * @exception SecurityException If this operation is not allowed by the + * <code>SecurityManager</code>. + * @exception SocketException If the factory object is already defined + * @exception IOException If any other error occurs + */ public static synchronized void setSocketFactory (SocketImplFactory fac) throws IOException { |