public_radio
v0.0.4
Published
Build highly distributed services by allowing your node applications to share emitted events over tcp socket connections.
Downloads
7
Readme
Build highly distributed services by allowing your node applications to share emitted events over tcp socket connections.
How it works and what its for
Applications can act as a server (allowing for incoming connections) or a client (connecting to a server). When a connection is made the stream is then converted to an event emitter using @substack's emit-stream. The advantage of Public Radio is that it allows you to create a graph of nodes made up of server and clients that can emit events that will be received by all the other nodes, as well as allowing them to bind callbacks to specific events they are interested in.
Usage
Creating a server that will listen for incoming connections
var Server = require('public_radio').PublicRadio;
var server = new Server(5000);
server.listen();
Creating a client to connect to a server
var Client = require('public_radio').PublicRadioClient;
var client = new Client('localhost', 5000);
client.on('connected', function(conn) {
// do something with connection
});
client.connect();
Connect servers to other servers to share your events with them and their clients
server.linkTo('localhost', 5001);
Setting up a listener for an event on a server
server.events().on('stock_update', function(symbol, price) {
// work with stock update
});
Emitting an event from a server
server.broadcast('stock_update', 'GOOG', 15.43);
Setting up a listener for an event on a client
client.on('connected', function(conn) {
conn.on('stock_update', function(symbol, price) {
// work with stock update
});
});
Emitting an event from the client
client.on('connected', function(conn) {
conn.emit('stock_update', 'GOOG', 15.43);
});
or
client.connection.emit('stock_update', 'GOOG', 15.43);
Bigger Picture
Setting up this network
var Server = require('public_radio').PublicRadio,
Client = require('public_radio').PublicRadioClient;
var server1 = (new Server(5000)).listen(),
server2 = (new Server(5001)).listen();
server1.linkTo('localhost', 5001);
var client1 = (new Client('localhost', 5000)),
client2 = (new Client('localhost', 5000)),
client3 = (new Client('localhost', 5001));
client1.on('connected', function(conn) {
});
client1.connect();
client2.on('connected', function(conn) {
});
client2.connect();
client3.on('connected', function(conn) {
});
client3.connect();