Skip to content

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

License

Notifications You must be signed in to change notification settings

Michieljoris/serf-rpc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Forked and completed implementation of the serf rpc.

First run a serf agent as described in the serf docs.

serf-rpc

##About

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

###Author Norman Joyner - [email protected]

##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
});

All operations are supported, but not rigorously tested yet.

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

There are two more convenience functions, listen and log, easing the use of stream and monitor.

###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(err, response){
        if(err)
            throw err;
        else
            console.log("Triggered the event!");
    });
});

serf.listen("user", function(data, stop) {
	console.log('listen event!!', data);
	// serf.stop();
	// serf.leave(function(data) { console.log('leaving', data); });
}); 

serf.listen("query", function(data, stop) {
	console.log('query event!!', data);
	serf.respond({ ID: data.ID, Payload: "my response" }, function(err, data) {
		if(err)
			console.log("Error", err);
		else
			console.log("Response...\n", data);

	});
});

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%