auto-peer

auto-peer.js

Abstract

auto-peer.js automates the peer.js connection establishment and connects all auto-peer.js clients with each other using webRTC.

The auto-peer.js library is an experimental webRTC client/server library which relies heavily on peerjs and socket.io

Motivation

The idea auto-peer.js was developed when creating a multi media installation for a couple of tablets. It should allow to communicate from tablet to tablet as fast as possible.

from http://engineering.spilgames.com/mastering-webrtc/

How does it work?

auto-peer.js core consists of a node websocket backend and a client side script. When the user opens the application a new client is created. This client asks the backend to tell all existing clients to establish a new webRTC connection.

Example

Take a look at the example directory.

Server

var app = require('express')();
var http = require('http').Server(app);
var autoPeer = require('auto-peer')(http);

app.get('/', function (req, res) {
  res.sendFile(__dirname + '/index.html');
});

http.listen(3000, function () {
  console.log('listening on *:3000');
});

Client

<script src="/auto-peer.min.js"></script>
<script>
  // Please get your own free key at http://peerjs.com/
  var autoPeer = new AutoPeer({key: 'lwjd5qra8257b9'});
  autoPeer.on('example-message', function(data){
    console.log('received data', data);
  });
  autoPeer.send('example-message', 'This is a message to all connected peers');
</script>

Events

Client

• autoPeer:connected
• autoPeer:data

Server

• autoPeer:newClient

Security

auto-peer.js is an experimental library and was not meant to be used in productive environment. As a client is able to send commands to any other client you should never evaluate html or javascript code transmitted by auto-peer.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

Copyright (c) 2014 Jan Nicklas. Licensed under the MIT license.