Make WebSocket.fromSocket public.

sdk/lib/io/websocket.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;
 
 /**
  * Web socket status codes used when closing a web socket connection.
  */
 abstract class WebSocketStatus {
@@ skipping 116 matching lines @@
   /**
    * Create a new web socket connection. The URL supplied in [url]
    * must use the scheme [:ws:] or [:wss:]. The [protocols] argument is
    * specifying the subprotocols the client is willing to speak.
    */
   static Future<WebSocket> connect(String url,
                                    {List<String> protocols: const []}) =>
       _WebSocketImpl.connect(url, protocols);
 
   /**
+   * Creates a WebSocket from an existing socket.

[Anders Johnsen, 2014/04/29 10:43:44]

[...] an already upgraded socket.

[nweiz, 2014/04/29 19:56:39]

Done.

+   *
+   * The initial WebSocket handshake must have occurred prior to this call.

[Anders Johnsen, 2014/04/29 10:43:44]

This comment should be expanded to include references to:

  WebSocket.connect

and
  
  WebSocketTransformer.upgrade & HttpResponse.detachSocket

To be sure we point people to where a upgraded socket is easily created from.

[nweiz, 2014/04/29 19:56:39]

Done.

+   * [protocol] should be the protocol negotiated by this handshake, if any.

[Anders Johnsen, 2014/04/29 10:43:44]

protocol and serverSide should be in separate paragraphs. Mention what happens
if serverSide is either true or false (e.g. frame masking is performed in the
direction of client->server).

[nweiz, 2014/04/29 19:56:39]

Done.

+   * [serverSide] indicates whether this is a server socket or a client socket.
+   */
+  factory WebSocket.fromSocket(Socket socket, {String protocol,

[Anders Johnsen, 2014/04/29 10:43:44]

Please change the name to something along the lines of:

  WebSocket.fromUpgradedSocket
  WebSocket.fromDetachedSocket

or something else.

fromSocket is too generic, and the user may be tempted to do:

Socket.connect(...).then((socket) => new WebSocket.fromSocket(socket))

which will not work.

[nweiz, 2014/04/29 19:56:39]

Done.

+        bool serverSide: true}) =>
+      new _WebSocketImpl._fromSocket(socket, protocol, serverSide);
+
+  /**
    * Returns the current state of the connection.
    */
   int get readyState;
 
   /**
    * The extensions property is initially the empty string. After the
    * web socket connection is established this string reflects the
    * extensions used by the server.
    */
   String get extensions;
@@ skipping 39 matching lines @@
    */
   Future addStream(Stream stream);
 }
 
 
 class WebSocketException implements IOException {
   final String message;
   const WebSocketException([this.message = ""]);
   String toString() => "WebSocketException: $message";
 }