Merging Furthest Upstream Content

.gitignore

@@ -0,0 +1,9 @@
+.actionScriptProperties
+.flexLibProperties
+.project
+.settings/*
+.metadata
+
+sample/node_modules
+sample/npm-debug.log
+sample/client.swf

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "library/support/web-socket-js"]
-	path = library/support/web-socket-js
-	url = git://github.com/simb/web-socket-js.git
-[submodule "support/web-socket-js"]
-	path = support/web-socket-js
-	url = git://github.com/simb/web-socket-js.git
+[submodule "libs/AS3WebSocket"]
+	path = libs/AS3WebSocket
+	url = https://github.com/chatziko/AS3WebSocket.git

Makefile

@@ -0,0 +1,24 @@
+find = $(foreach dir,$(1),$(foreach d,$(wildcard $(dir)/*),$(call find,$(d),$(2))) $(wildcard $(dir)/$(strip $(2))))
+
+FLEX_HOME?=/usr/local/apache-flex-sdk
+
+all: bin/Flash-Socket.IO.swc
+sample: sample/client.swf
+
+bin/Flash-Socket.IO.swc: $(call find, src, *.as)
+	@mkdir -p bin
+	$(FLEX_HOME)/bin/compc \
+		--source-path=./src \
+		--source-path=./libs/AS3WebSocket/AS3WebSocket/src \
+		--library-path=./libs \
+		--include-classes=com.pnwrain.flashsocket.FlashSocket \
+		--debug=true \
+		--output=$@
+
+sample/client.swf: sample/client.as bin/Flash-Socket.IO.swc
+	$(FLEX_HOME)/bin/mxmlc \
+		--library-path=bin/Flash-Socket.IO.swc \
+		--debug=true \
+		--output=$@ \
+		sample/client.as
+

README.md

@@ -1,13 +1,55 @@
 # FlashSocket.IO
 
-Flash library to facilitate communication between Flex applications and Socket.IO servers.
+Flash client for [Socket.IO](http://socket.io/) version 1.0 and above. Connects
+solely through WebSocket and supports binary data and native TLS (through
+[SecureSocket](http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/net/SecureSocket.html)).
 
-The actual websocket communication is taken care of by my fork of gimite/web-socket-js project.
+## Notes for this fork
 
-This project wraps that and facilitates the hearbeat and en/decoding of messages so they work with Socket.IO servers
+This fork is based on
+[redannick/FlashSocket.IO](https://github.com/redannick/FlashSocket.IO) (which
+itself is based on
+[jimib/FlashSocket.IO](https://github.com/jimib/FlashSocket.IO)) and contains
+several improvements and bugfixes:
 
-# Checkout
+ * support for both polling and websockets
+ * upgrade support (by default connect with polling and upgrade to websocket later)
+ * support for sending/receiving binary data (as
+   [ByteArray](http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/utils/ByteArray.html))
+ * use [my fork](https://github.com/chatziko/AS3WebSocket) of
+   [AS3WebSocket](https://github.com/theturtle32/AS3WebSocket), with the following improvements:
+   * use native SecureSocket for TLS (faster, more sucure, reduces swc size by 86%)
+   * limited support for [permessage-deflate](https://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-19) compression
+     (accept compressed messages from the server, although the client never compresses itself)
+ * separate engine.io client code
+ * add ERROR event for handling server-side errors
+ * bugfix: propertly add callback to messages for sending ACK
+ * bugfix: properly clean ACK callbacks
+ * bugfix: emit buffered message after dispatching the CONNECT event
+ * bugfix: stop heartbeat timer when socket abruptly closes
+ * bugfix: dispatch DISCONNECT when connecting is manually close()ed
+ * use native [JSON](http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/JSON.html)
+ * remove CLOSE event (unclear semantics), use DISCONNECT instead
+ * add destroy() method (similar to the js socket.io-client)
 
-Because this project makes use of git submodules you must make use of the recursive clone.
+Tested with Socket.IO 1.4.
+
+## Sample client and server
+
+A sample [client](./sample/client.as) and [server](./sample/server.js) are provided.
+To try them:
+
+ * Install dependencies and start server
+ ```
+ cd sample
+ npm install
+ npm start
+ ```
+
+ * Compile the client, eg with ```mxmlc```:
+ ```
+ mxmlc --library-path=bin/Flash-Socket.IO.swc sample/client.as
+ ```
+
+ * Open [http://localhost:3000/](http://localhost:3000/)
 
-git clone --recursive git://github.com/simb/FlashSocket.IO.git

sample/client.as

@@ -0,0 +1,88 @@
+package {
+
+import flash.display.Sprite;
+import flash.external.ExternalInterface;
+import flash.text.TextField;
+import flash.utils.ByteArray;
+
+import com.pnwrain.flashsocket.FlashSocket;
+import com.pnwrain.flashsocket.events.FlashSocketEvent;
+
+
+public class client extends Sprite {
+
+	public var socket:FlashSocket;
+	public var txt:TextField;
+
+	// log in the TextField, via trace, and with console.log
+	//
+	public function log(...args):void {
+		if(socket)
+			args.unshift(socket.transport)
+
+		txt.appendText(args.join(' ') + "\n")
+
+		trace(args.join(' '))
+
+		if(ExternalInterface.available) {
+			args.unshift('console.log');
+			ExternalInterface.call.apply(ExternalInterface, args)
+		}
+	}
+
+
+	public function client() {
+		txt = new TextField();
+		txt.width = 1000;
+		txt.height = 1000;
+		addChild(txt);
+
+		FlashSocket.debug = true;
+
+		// connect to the same url as the page we're in
+		var url:String = ExternalInterface.call("window.location.href.toString");
+		log("connecting to: " + url);
+
+		socket = new FlashSocket(url);
+
+		socket.addEventListener(FlashSocketEvent.CONNECT, function(e:FlashSocketEvent):void {
+			log("connected");
+
+			log("sending bar")
+			socket.emit('bar', 'foo', function(ba:ByteArray):void {
+				log('bar: got back ByteArray: ', ba[0], ba[1]);
+			});
+		});
+
+		socket.addEventListener('foo', function(e:FlashSocketEvent):void {
+			var s:String = e.data[0];
+			var cb:Function = e.data[1];
+
+			log("got 'foo' from server with data: " + s);
+			log("sending back ByteArray with 2 bytes");
+
+			var ba:ByteArray = new ByteArray();
+			ba[0] = 1;
+			ba[1] = 2;
+			cb(ba);
+		})
+
+		socket.addEventListener(FlashSocketEvent.DISCONNECT, function(e:FlashSocketEvent):void {
+			log("disconnect");
+		});
+		socket.addEventListener(FlashSocketEvent.SECURITY_ERROR, function(e:FlashSocketEvent):void {
+			log("security error");
+		});
+		socket.addEventListener(FlashSocketEvent.CONNECT_ERROR, function(e:FlashSocketEvent):void {
+			log("connect error");
+		});
+		socket.addEventListener(FlashSocketEvent.IO_ERROR, function(e:FlashSocketEvent):void {
+			log("io error");
+		});
+		socket.addEventListener(FlashSocketEvent.ERROR, function(e:FlashSocketEvent):void {
+			log("error");
+		});
+	}
+
+} // class
+} // package

sample/client.html

@@ -0,0 +1,15 @@
+<!doctype html>
+
+<html>
+<head>
+	<style>
+		html, body, #swf { width: 100%; height: 100%; margin: 0; }
+		object { display:block; }
+	</style>
+</head>
+<body>
+	<object type="application/x-shockwave-flash" data="client.swf" id="swf">
+		<param name="allowScriptAccess" value="always"/>
+	</object>
+</body>
+</html>

sample/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "flashsocket-sample",
+  "version": "0.1.0",
+  "description": "A sample server to connect using FlashSocket.IO",
+  "dependencies": {
+    "express": "^4.13.4",
+    "policyfile": "chatziko/FlashPolicyFileServer",
+    "socket.io": "^1.4.0"
+  }
+}

sample/server.js

@@ -0,0 +1,75 @@
+
+var fs = require('fs')
+var http = require('http')
+var https = require('https')
+var express = require('express')
+var policyfile = require('policyfile')
+var ioServer = require('socket.io')
+
+
+// CONFIGURATION. Set key/cert to enable https
+var httpPort = 3000
+var httpsPort = 3001
+var key		// = "...path to key file..."
+var cert	// = "...path to cert file..."
+
+// basic express app to serve client.html and client.swf
+var expressApp = express()
+expressApp.use('/', express.static('.', { index: 'client.html' }))
+
+// http server
+var masterHttp = http.Server(expressApp)
+masterHttp.listen(httpPort, function() {
+	console.log('listening to port', httpPort)
+	console.log('open http://localhost:'+httpPort+'/ in your browser')
+})
+
+// https server (if key/cert are set)
+if(cert) {
+	var credentials = {
+		key: fs.readFileSync(key),
+		cert: fs.readFileSync(cert),
+	}
+	var masterHttps = https.Server(credentials, expressApp)
+	masterHttps.listen(httpsPort)
+}
+
+// serve policy file on httpPort, and also on port 843 if we can
+var canOpenLowPorts = !process.getuid || process.getuid() == 0
+var policyPort = canOpenLowPorts ? 843 : -1
+
+policyfile.createServer().listen(policyPort, masterHttp)
+if(cert)
+	policyfile.createServer().listen(-1, masterHttps)
+
+// socket.io server
+var io = new ioServer(masterHttp, {
+	pingInterval: 5000,
+	pingTimeout: 5000,
+})
+if(cert)
+	io.attach(masterHttps)
+
+io.on('connection', function(socket) {
+	console.log('client connected')
+
+	setTimeout(function() {
+		console.log('sending foo')
+		socket.emit('foo', 'bar', function(buf) {
+			console.log('foo: got back', buf)
+		})
+	}, 1000)
+
+	socket.on('bar', function(s, cb) {
+		console.log("got 'bar' from client with data: " + s)
+		console.log("sending back Buffer with 2 bytes")
+
+		cb(new Buffer([1, 2]))
+	})
+
+	socket.on('disconnect', function() {
+		console.log('client disconnected');
+	})
+})
+
+