serf-rpc

A simple nodejs module for interacting with the Serf RPC protocol.

serf-rpc

##About

###Description A simple nodejs module for interacting with the Serf RPC protocol.

###Author Norman Joyner - norman.joyner@gmail.com

##Getting Started

###Installation npm install serf-rpc

###Configuration Simply require the serf-rpc module, instantiate a new Serf object, and call the .connect() method to start interacting with Serf's RPC protocol.

An optional object can be passed to the .connect([OPTIONS], fn) method to configure the RPC address. If ommitted, serf-rpc defaults to 127.0.0.1:7373. The object can be configured as follows:

 
var options = {
    rpc_host: "127.0.0.1",
    rpc_port: 7070
}
 
serf.connect(options, function(err){
    // interact with the RPC protocol 
});

###Supported Operations

  • event
  • join
  • leave
  • members

For specific details about these operations, consult the official Serf RPC docs.

###Examples Example using the default RPC address, triggering a custom user event:

var SerfRPC = require("serf-rpc");
var serf = new SerfRPC();
 
serf.connect(function(err){
    if(err)
        throw err;
 
    serf.event({"Name": "deploy", "Payload": "4f33de567283e4a456539b8dc493ae8a853a93f6", "Coalesce": false}, function(errresponse){
        if(err)
            throw err;
        else
            console.log("Triggered the event!");
    });
});