skateboard's Introduction

skateboard

Quickly create a stream from the browser to the server with engine.io

Use

npm install skateboard

// server.js
var skateboard = require('skateboard');
skateboard({
  dir: __dirname + '/public',          // default (optional)
  port : 8080,                         // default (optional)
  transports: ['polling', 'websocket'] // default (optional)
  // requestHandler: function(req, res) {} -- fallback request handler
}, function(stream) {
  var start = Date.now();
  stream.write('ping');

  stream.on('data', function() {
    console.log('latency:', (Date.now() - start) + 'ms');
  });
});

skateboard([wshref [, fn]])

wshref - optional cross domain skateboard to connect to
fn - optional connection handler. first argument is a duplex stream

<!-- public/index.html -->
<html>
<head>
  <script type="text/javascript" src="skateboard.min.js"></script>
</head>
<body>

<script type="text/javascript">
  skateboard().on('data', function(d) {
    this.write(d);
  });

  // or
  // skateboard(function(stream) {
  //   stream.on('data', function(d) {
  //     stream.write(d);
  //   });
  // });
  //
</script>

</body>
</html>

client events

connection - emitted on the first connection
disconnection - emitted whenever the connection disconnects
reconnection - emitted whenever a new connection is established

License

MIT

skateboard's People

Contributors

Stargazers

Watchers

skateboard's Issues

need fallbacks

Instead of using websocket directly use engine.io or primus.

add 'disconnected' when the underlying socket loses the connection

Currently there is no good way to detect if the ws connection has been severed, adding this will provide a mechanism for notifying users that they are no longer connected.

Recommend Projects