Socket.IO 0.7-pre

History.md

@@ -0,0 +1,5 @@
+
+0.0.1 / 2010-01-03
+==================
+
+  * Initial release

Makefile

@@ -0,0 +1,15 @@
+
+ALL_TESTS = $(shell find test/ -name '*.test.js')
+
+run-tests:
+	@./support/expresso/bin/expresso \
+		-I support/should.js/lib \
+		-I support \
+		-I lib \
+		--serial \
+		$(TESTS)
+
+test:
+	@$(MAKE) TESTS="$(ALL_TESTS)" run-tests
+
+.PHONY: test

Readme.md

@@ -0,0 +1,283 @@
+
+# Socket.IO
+
+Socket.IO is a Node.JS project that makes WebSockets and realtime possible in
+all browsers. It also enhances WebSockets by providing built-in multiplexing,
+horizontal scalability, automatic JSON encoding/decoding, and more.
+
+## How to Install
+
+    npm install socket.io
+
+## How to use
+
+First, require `socket.io`:
+
+    var io = require('socket.io');
+
+Next, attach it to a HTTP/HTTPS server. If you're using the fantastic `express`
+web framework:
+
+    var app = express.createServer();
+      , sockets = io.listen(app);
+
+    app.listen(80);
+
+    sockets.on('connection', function (socket) {
+      socket.send({ hello: 'world' });
+    });
+
+Finally, load it from the client side code:
+
+    <script src="/socket.io/socket.io.js"></script>
+    <script>
+      var socket = io.connect('http://localhost');
+      socket.on('news', function () {
+        socket.emit('myOtherEvent', { my: 'data' });
+      });
+    </script>
+
+For more thorough examples, look at the `examples/` directory.
+
+## Short recipes
+
+### Sending and receiving events.
+
+Socket.IO allows you to emit and receive custom events.
+Besides `connect`, `message` and `disconnect`, you can emit custom events:
+
+    // note, io.listen(<port>) will create a http server for you
+    var io = require('socket.io');
+      , sockets = io.listen(80);
+
+    sockets.on('connection', function (socket) {
+      sockets.emit('this', { will: 'be received by everyone');
+
+      socket.on('private message', function (from, msg) {
+        console.log('I received a private message by ', from, ' saying ', msg);
+      });
+
+      socket.on('disconnect', function () {
+        sockets.emit('user disconnected');
+      });
+    });
+
+### Storing data associated to a client
+
+Sometimes it's necessary to store data associated with a client that's
+necessary for the duration of the session.
+
+#### Server side
+
+    var io = require('socket.io')
+      , sockets = io.listen(80);
+
+    sockets.on('connection', function (socket) {
+      socket.on('set nickname', function (name) {
+        socket.set('nickname', name, function () { socket.emit('ready'); });
+      });
+
+      socket.on('msg', function () {
+        socket.get('nickname', function (name) {
+          console.log('Chat message by ', name);
+        });
+      });
+    });
+
+#### Client side
+
+    <script>
+      var socket = io.connect('http://localhost');
+
+      socket.on('connect', function () {
+        socket.emit('set nickname', confirm('What is your nickname?'));
+        socket.on('ready', function () {
+          console.log('Connected !');
+          socket.emit('msg', confirm('What is your message?'));
+        });
+      });
+    </script>
+
+### Restricting yourself to a namespace
+
+If you have control over all the messages and events emitted for a particular
+application, using the default `/` namespace works.
+
+If you want to leverage 3rd-party code, or produce code to share with others,
+socket.io provides a way of namespacing a `socket`.
+
+This has the benefit of `multiplexing` a single connection. Instead of
+socket.io using two `WebSocket` connections, it'll use one.
+
+The following example defines a socket that listens on '/chat' and one for
+'/news':
+
+#### Server side
+
+    var io = require('socket.io')
+      , sockets = io.listen(80);
+
+    var chat = sockets
+      .for('/chat');
+      .on('connection', function (socket) {
+        socket.emit('a message', { that: 'only', '/chat': 'will get' });
+        chat.emit('a message', { everyone: 'in', '/chat': 'will get' });
+      });
+
+    var news = sockets
+      .for('/news');
+      .on('connection', function (socket) {
+        socket.emit('item', { news: 'item' });
+      });
+
+#### Client side:
+
+    <script>
+      var socket = io.connect('http://localhost/')
+        , chat = socket.for('/chat')
+        , news = socket.for('/news');
+
+      chat.on('connect', function () {
+        chat.emit('hi!');
+      });
+
+      news.on('news', function () {
+        news.emit('woot');
+      });
+    </script>
+
+### Sending volatile messages.
+
+Sometimes certain messages can be dropped. Let's say you have an app that
+shows realtime tweets for the keyword `bieber`. 
+
+If a certain client is not ready to receive messages (because of network slowness
+or other issues, or because he's connected through long polling and is in the
+middle of a request-response cycle), if he doesn't receive ALL the tweets related
+to bieber your application won't suffer.
+
+In that case, you might want to send those messages as volatile messages.
+
+#### Server side
+
+    var io = require('socket.io')
+      , sockets = io.listen(80);
+
+    sockets.on('connection', function (socket) {
+      var tweets = setInterval(function () {
+        getBieberTweet(function (tweet) {
+          socket.volatile.emit('bieber tweeet', tweet);
+        });
+      }, 100);
+
+      socket.on('disconnect', function () {
+        clearInterval(tweets);
+      });
+    });
+
+#### Client side
+
+In the client side, messages are received the same way whether they're volatile
+or not.
+
+### Getting acknowledgements
+
+Sometimes, you might want to get a callback when the client confirmed the message
+receiption.
+
+To do this, simply pass a function as the last parameter of `.send` or `.emit`.
+What's more, you can also perform a manual acknowledgement, like in the example
+below. Socket.IO won't perform a manual acknowledgement when the arity of the
+function is `0` when you `emit` or `send`.
+
+#### Server side
+
+    var io = require('socket.io')
+      , sockets = io.listen(80);
+
+    sockets.on('connection', function (socket) {
+      socket.on('ferret', function (name, fn) {
+        fn('woot');
+      });
+    });
+
+#### Client side
+
+    <script>
+      var socket = io.connect(); // TIP: .connect with no args does auto-discovery
+      socket.on('connection', function () {
+        socket.emit('ferret', 'tobi', function (data) {
+          // if the funtion arity here was 0 (ie: if no parameters were defined),
+          // socket.io would handle the acknowledgement automatically.
+          console.log(data); // data will be 'woot'
+        });
+      });
+    </script>
+
+### Using it just as a cross-browser WebSocket
+
+If you just want the WebSocket semantics, you can do that too.
+Simply leverage `send` and listen on the `message` event:
+
+#### Server side
+
+    var io = require('socket.io')
+      , sockets = io.listen(80);
+
+#### Client side
+
+    <script>
+      var socket = io.connect('http://localhost/');
+      socket.on('connect', function () {
+        socket.send('hi');
+
+        socket.on('message', function (msg) {
+          // my msg
+        });
+      });
+    </script>
+
+### Changing configuration
+
+Configuration in socket.io is TJ-style:
+
+#### Server side
+
+    var io = require('socket.io')
+      , sockets = io.listen(80);
+
+    sockets.configure(function () {
+      sockets.set('transports', ['websocket', 'flashsocket', 'xhr-polling']);
+    });
+
+    sockets.configure('development', function () {
+      sockets.set('transports', ['websocket', 'xhr-polling']);
+      sockets.enable('log');
+    });
+
+## [API docs](http://socket.io/api.html)
+
+## License 
+
+(The MIT License)
+
+Copyright (c) 2011 Guillermo Rauch &lt;[email protected]&gt;
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

index.js

@@ -0,0 +1,8 @@
+
+/*!
+ * socket.io-node
+ * Copyright(c) 2011 LearnBoost <[email protected]>
+ * MIT Licensed
+ */
+
+module.exports = require('./lib/socket.io');