diff options
author | mkoch <mkoch@138bc75d-0d04-0410-961f-82ee72b054a4> | 2003-06-21 14:02:10 +0000 |
---|---|---|
committer | mkoch <mkoch@138bc75d-0d04-0410-961f-82ee72b054a4> | 2003-06-21 14:02:10 +0000 |
commit | d926d2de2536dbca4af0ae6cb38815ae8333cd10 (patch) | |
tree | 5f317b890de40a395878d133d21ab2af7eee4049 /libjava | |
parent | a29c72148170892b66721a6b6f85251c01e56718 (diff) | |
download | gcc-d926d2de2536dbca4af0ae6cb38815ae8333cd10.tar.gz |
2003-06-21 Michael Koch <konqueror@gmx.de>
* java/net/PlainSocketImpl.java:
Reformatted.
(PlainSocketImpl): Merged class documentaion with classpath.
(in): Moved.
(out): Moved.
(PlainSocketImpl): New empty constructor.
(finalize): Moved.
(setOption): Merged documentation from classpath.
(getOption): Likewise.
(create): Likewise.
(connect): Likewise.
(bind): Likewise.
(listen): Likewise.
(accept): Likewise.
(available): Likewise.
(close): Likewise.
(read): Likewise.
(write): Likewise.
(getInputStream): Made synchronozed to get sure that only one stream
object can be created for this socket, merged documentation from
classpath.
(getOutputStream): Likewise.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@68305 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libjava')
-rw-r--r-- | libjava/ChangeLog | 25 | ||||
-rw-r--r-- | libjava/java/net/PlainSocketImpl.java | 197 |
2 files changed, 187 insertions, 35 deletions
diff --git a/libjava/ChangeLog b/libjava/ChangeLog index c927a6b9afe..2386d53a01b 100644 --- a/libjava/ChangeLog +++ b/libjava/ChangeLog @@ -1,6 +1,31 @@ 2003-06-21 Michael Koch <konqueror@gmx.de> * java/net/PlainSocketImpl.java: + Reformatted. + (PlainSocketImpl): Merged class documentaion with classpath. + (in): Moved. + (out): Moved. + (PlainSocketImpl): New empty constructor. + (finalize): Moved. + (setOption): Merged documentation from classpath. + (getOption): Likewise. + (create): Likewise. + (connect): Likewise. + (bind): Likewise. + (listen): Likewise. + (accept): Likewise. + (available): Likewise. + (close): Likewise. + (read): Likewise. + (write): Likewise. + (getInputStream): Made synchronozed to get sure that only one stream + object can be created for this socket, merged documentation from + classpath. + (getOutputStream): Likewise. + +2003-06-21 Michael Koch <konqueror@gmx.de> + + * java/net/PlainSocketImpl.java: Reformatting. (static): New implicit method. (read): Made package private. diff --git a/libjava/java/net/PlainSocketImpl.java b/libjava/java/net/PlainSocketImpl.java index 36fe26cb156..ad0ce46c7ea 100644 --- a/libjava/java/net/PlainSocketImpl.java +++ b/libjava/java/net/PlainSocketImpl.java @@ -50,8 +50,14 @@ import gnu.classpath.Configuration; */ /** + * Unless the application installs its own SocketImplFactory, this is the + * default socket implemetation that will be used. It simply uses a + * combination of Java and native routines to implement standard BSD + * style sockets of family AF_INET and types SOCK_STREAM and SOCK_DGRAM + * * @author Per Bothner <bothner@cygnus.com> * @author Nic Ferrier <nferrier@tapsellferrier.co.uk> + * @author Aaron M. Renn <arenn@urbanophile.com> */ class PlainSocketImpl extends SocketImpl { @@ -96,21 +102,101 @@ class PlainSocketImpl extends SocketImpl // localAddress cache InetAddress localAddress; + /** + * A cached copy of the in stream for reading from the socket. + */ + private InputStream in; + + /** + * A cached copy of the out stream for writing to the socket. + */ + private OutputStream out; + + /** + * Default do nothing constructor + */ + public PlainSocketImpl() + { + } + + protected void finalize() throws Throwable + { + synchronized (this) + { + if (fnum != -1) + try + { + close(); + } + catch (IOException ex) + { + // ignore + } + } + super.finalize(); + } + + /** + * 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 + */ public native void setOption(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 + */ public native Object getOption(int optID) throws SocketException; public native void shutdownInput () throws IOException; public native void shutdownOutput () throws IOException; + /** + * 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 + */ protected native void create (boolean stream) throws IOException; + /** + * Connects to the remote hostname and port specified as arguments. + * + * @param hostname The remote hostname to connect to + * @param port The remote port to connect to + * + * @exception IOException If an error occurs + */ protected void connect (String host, int port) throws IOException { connect (new InetSocketAddress (InetAddress.getByName(host), port), 0); } + /** + * 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 + */ protected void connect (InetAddress host, int port) throws IOException { connect (new InetSocketAddress (host, port), 0); @@ -119,80 +205,121 @@ class PlainSocketImpl extends SocketImpl protected native void connect (SocketAddress addr, int timeout) 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 + */ protected native void bind (InetAddress host, 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 + */ protected native void listen (int backlog) throws IOException; private native void accept (PlainSocketImpl s) 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. + */ protected void accept (SocketImpl s) throws IOException { accept((PlainSocketImpl) s); } + /** + * 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 + */ protected native int available() 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 + */ protected native void close () throws IOException; protected native void sendUrgentData(int data) throws IOException; - // Stream handling. - - /** A cached copy of the in stream for reading from the socket. */ - private InputStream in; - - /** A cached copy of the out stream for writing to the socket. */ - private OutputStream out; - - - // The native read methods. - native int read() 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 + */ native int read(byte[] buffer, int offset, int count) throws IOException; - - // The native write methods. - native void write(int c) 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 + */ native void write(byte[] buffer, int offset, int count) throws IOException; - protected void finalize() throws Throwable - { - synchronized (this) - { - if (fnum != -1) - try - { - close(); - } - catch (IOException ex) - { - // ignore - } - } - super.finalize(); - } - - /** @return the input stream attached to the socket. + /** + * Returns an InputStream object for reading from this socket. This will + * be an instance of SocketInputStream. + * + * @return An input stream attached to the socket. + * + * @exception IOException If an error occurs */ - protected InputStream getInputStream() throws IOException + protected synchronized InputStream getInputStream() throws IOException { if (in == null) in = new SocketInputStream(); + return in; } - /** @return the output stream attached to the socket. + /** + * Returns an OutputStream object for writing to this socket. This will + * be an instance of SocketOutputStream. + * + * @return An output stream attached to the socket. + * + * @exception IOException If an error occurs */ - protected OutputStream getOutputStream() throws IOException + protected synchronized OutputStream getOutputStream() throws IOException { if (out == null) out = new SocketOutputStream(); + return out; } |