Improve documentation on address for socket bind

sdk/lib/io/socket.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 part of dart.io;
 
 /**
  * The RawServerSocket is a server socket, providing a stream of low-level
  * [RawSocket]s.
  *
  * See [RawSocket] for more info.
  */
 abstract class RawServerSocket implements Stream<RawSocket> {
   /**
    * Returns a future for a [:RawServerSocket:]. When the future
    * completes the server socket is bound to the given [address] and
    * [port] and has started listening on it.
    *
+   * The default value for [address] is 127.0.0.1, which will allow
+   * only incoming connections from the local host. To allow for
+   * incoming connection from the network use either the value 0.0.0.0
+   * to bind to all interfaces or the IP address of a specific
+   * interface.
+   *
    * If [port] has the value [:0:] (the default) an ephemeral port will
    * be chosen by the system. The actual port used can be retrieved
    * using the [:port:] getter.
    *
-   * If [backlog] has the value of [:0:] a reasonable value will be
-   * chosen by the system.
+   * The optional argument [backlog] can be used to specify the listen
+   * backlog for the underlying OS listen setup. If [backlog] has the
+   * value of [:0:] (the default) a reasonable value will be chosen by
+   * the system.
    */
   external static Future<RawServerSocket> bind([String address = "127.0.0.1",
                                                int port = 0,
                                                int backlog = 0]);
 
   /**
    * Returns the port used by this socket.
    */
   int get port;
 
   /**
    * Closes the socket.
    */
   void close();
 }
 
 
 /**
  * The [ServerSocket] is server socket, providing a stream of high-level
  * [Socket]s.
  *
  * See [Socket] for more info.
  */
 abstract class ServerSocket implements Stream<Socket> {
   /**
    * Returns a future for a [:ServerSocket:]. When the future
    * completes the server socket is bound to the given [address] and
    * [port] and has started listening on it.
    *
+   * The default value for [address] is 127.0.0.1, which will allow
+   * only incoming connections from the local host. To allow for
+   * incoming connection from the network use either the value 0.0.0.0
+   * to bind to all interfaces or the IP address of a specific
+   * interface.
+   *
    * If [port] has the value [:0:] (the default) an ephemeral port will
    * be chosen by the system. The actual port used can be retrieved
    * using the [port] getter.
    *
-   * If [backlog] has the value of [:0:] a reasonable value will be
-   * chosen by the system.
+   * The optional argument [backlog] can be used to specify the listen
+   * backlog for the underlying OS listen setup. If [backlog] has the
+   * value of [:0:] (the default) a reasonable value will be chosen by
+   * the system.
    */
   external static Future<ServerSocket> bind([String address = "127.0.0.1",
                                              int port = 0,
                                              int backlog = 0]);
 
   /**
    * Returns the port used by this socket.
    */
   int get port;
 
@@ skipping 186 matching lines @@
         sb.write(" ($osError)");
       }
     } else if (osError != null) {
       sb.write(": $osError");
     }
     return sb.toString();
   }
   final String message;
   final OSError osError;
 }