Add a web socket client

runtime/bin/websocket.dart

 // Copyright (c) 2012, 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.
 
 /**
  * The web socket protocol is implemented by a HTTP server handler
  * which can be instantiated like this:
  *
  *     WebSocketHandler wsHandler = new WebSocketHandler();
  *
@@ skipping 16 matching lines @@
 
   /**
    * Sets the callback to be called when a new web socket connection
    * has been established.
    */
   void set onOpen(callback(WebSocketConnection connection));
 }
 
 
 /**
- * Web socket connection.
+ * Server web socket connection.
  */
 interface WebSocketConnection {
   /**
    * Sets the callback to be called when a message have been
    * received. The type on [message] is either [:String:] or
    * [:List<int>:] depending on whether it is a text or binary
    * message. If the message is empty [message] will be [:null:].
    */
   void set onMessage(void callback(message));
 
@@ skipping 16 matching lines @@
   send(Object message);
 
   /**
    * Close the web socket connection. The default value for [status]
    * and [reason] are [:null:].
    */
   close([int status, String reason]);
 }
 
 
+/**
+ * Client web socket connection.
+ */
+interface WebSocketClientConnection default _WebSocketClientConnection {
+  /**
+   * Creates a new web socket client connection based on a HTTP client
+   * connection. The HTTP client connection must be freshly opened.
+   */
+  WebSocketClientConnection(HttpClientConnection conn,

[Anders Johnsen, 2012/05/02 07:51:57]

Should we add a convenient constructor that just takes a WebSocket url and maybe
a HttpHeader object?

[Søren Gjesse, 2012/05/02 10:22:45]

After having discussed this off-line we will make a WebSocket class which have
the same interface as the WebSocket in the browser and keep the
WebSocketClientConnection as is.

+                            [List<String> protocols]);
+
+  /**
+   * Sets the callback to be called when the request object for the
+   * opening handshake request is ready. This callback can be used if
+   * one need to add additional headers to the opening handshake
+   * request.
+   */
+  void set onRequest(void callback(HttpClientRequest request));
+
+  /**
+   * Sets the callback to be called when a web socket connection has
+   * been established.
+   */
+  void set onOpen(void callback());
+
+  /**
+   * Sets the callback to be called when a message have been
+   * received. The type on [message] is either [:String:] or

[Mads Ager (google), 2012/05/02 08:18:17]

The type on -> The type of

[Søren Gjesse, 2012/05/02 10:22:45]

Done.

+   * [:List<int>:] depending on whether it is a text or binary
+   * message. If the message is empty [message] will be [:null:].
+   */
+  void set onMessage(void callback(message));

[Anders Johnsen, 2012/05/02 07:51:57]

Add 'Object' type to match send.

[Søren Gjesse, 2012/05/02 10:22:45]

Removed Object from send instead.

+
+  /**
+   * Sets the callback to be called when the web socket connection is
+   * closed.
+   */
+  void set onClosed(void callback(int status, String reason));
+
+  /**
+   * Sets the callback to be called when the response object for the
+   * opening handshake did not cause a web socket connection
+   * upgrade. This will be called in case the response status code is
+   * not 101 (Switching Protocols). If this callback is not set the
+   * [:onError:] callback will be called if the server did not upgrade
+   * the connection.
+   */
+  void set onNoUpgrade(void callback(HttpClientResponse request));

[Anders Johnsen, 2012/05/02 07:51:57]

request->response.

[Søren Gjesse, 2012/05/02 10:22:45]

Done.

+
+  /**
+   * Sets the callback to be called when the web socket connection
+   * encountered an error.
+   */
+  void set onError(void callback(e));
+
+  /**
+   * Sends a message. The [message] must be a [:String:] a

[Mads Ager (google), 2012/05/02 08:18:17]

[:String:] or a

[Søren Gjesse, 2012/05/02 10:22:45]

Done.

+   * [:List<int>:]. To send an empty message use either an empty
+   * [:String:] or an empty [:List<int>:]. [:null:] cannot be used.
+   */
+  send(Object message);
+
+  /**
+   * Close the web socket connection. The default value for [status]
+   * and [reason] are [:null:].
+   */
+  close([int status, String reason]);
+}
+
+
 class WebSocketException implements Exception {
   const WebSocketException([String this.message = ""]);
   String toString() => "WebSocketException: $message";
   final String message;
 }