AS3 WebSocket Client 技术文档

1. 安装指南

在开始使用 AS3 WebSocket Client 之前，请确保您已经安装了以下环境：

• Flash Builder 4.6 或更高版本
• Adobe Air SDK

接下来，您可以按照以下步骤进行安装：

1. 下载 AS3 WebSocket Client 的源代码。
2. 将 AS3WebSocket 目录中的库项目导入到 Flash Builder 中。
3. 将 testApp 目录中的 Adobe Air 项目也导入到 Flash Builder 中。
4. 确保您的项目构建路径中包含了 AS3WebSocket 库项目。

2. 项目使用说明

AS3 WebSocket Client 是一个基于 RFC6455 标准的 WebSocket 客户端库的实现。以下是一个简单的使用示例：

var websocket:WebSocket = new WebSocket("wss://localhost:4321/foo?bing=baz", "*", "my-chat-protocol");
websocket.enableDeflateStream = true;
websocket.addEventListener(WebSocketEvent.CLOSED, handleWebSocketClosed);
websocket.addEventListener(WebSocketEvent.OPEN, handleWebSocketOpen);
websocket.addEventListener(WebSocketEvent.MESSAGE, handleWebSocketMessage);
websocket.addEventListener(WebSocketErrorEvent.CONNECTION_FAIL, handleConnectionFail);
websocket.connect();

function handleWebSocketOpen(event:WebSocketEvent):void {
  trace("Connected");
  websocket.sendUTF("Hello World!\n");
  
  var binaryData:ByteArray = new ByteArray();
  binaryData.writeUTF("Hello as Binary Message!");
  websocket.sendBytes(binaryData);
}

function handleWebSocketClosed(event:WebSocketEvent):void {
  trace("Disconnected");
}

private function handleConnectionFail(event:WebSocketErrorEvent):void {
  trace("Connection Failure: " + event.text);
}

function handleWebSocketMessage(event:WebSocketEvent):void {
  if (event.message.type === WebSocketMessage.TYPE_UTF8) {
    trace("Got message: " + event.message.utf8Data);
  }
  else if (event.message.type === WebSocketMessage.TYPE_BINARY) {
    trace("Got binary message of length " + event.message.binaryData.length);
  }
}

在这个例子中，我们创建了一个 WebSocket 对象，并注册了几个事件监听器来处理连接开启、消息接收、连接关闭和连接失败的情况。

3. 项目API使用文档

以下是 AS3 WebSocket Client 的一些主要 API：

• WebSocket(url:String, protocols:Array, subprotocol:String): 创建一个新的 WebSocket 对象。
• connect(): 连接到服务器。
• addEventListener(type:String, listener:Function): 添加事件监听器。
• sendUTF(message:String): 发送 UTF-8 编码的文本消息。
• sendBytes(data:ByteArray): 发送二进制数据。

更多 API 详细信息，请参考项目源代码中的注释。

4. 项目安装方式

AS3 WebSocket Client 的安装方式已在“安装指南”一节中说明。简要概括，您需要：

• 下载源代码。
• 将库项目导入到 Flash Builder 中。
• 将 Adobe Air 项目导入到 Flash Builder 中。
• 确保构建路径中包含了库项目。