ruby-watchcat 1.0.0 → 1.0.1

data/README

@@ -0,0 +1,64 @@
+== Introduction
+
+Ruby/Watchcat allows the development of watchcatd-aware applications in
+Ruby.
+
+Watchcatd is a watchdog-like daemon in the sense that it takes actions
+in situations where a machine is under heavy load and/or unresponsive.
+However, watchcatd isn't as drastic as the usual watchdog systems, which
+generally reboot the machine. Instead, all it does is sending a signal to
+a registered process (which by default is SIGKILL) if the process doesn't
+send it a heartbeat before a user-specified timeout.
+
+Ruby/Watchcatd allows a Ruby application to register itself with watchcatd.
+
+
+== Requirements
+
+Ruby/Watchcatd was tested with Ruby versions >= 1.8.4 and requires watchcatd
+version 1.1 and libwcat version 1.0 to be installed (see References below).
+
+
+== Installation
+
+The easiest way to install Ruby/Watchcat is to use rubygems:
+
+* For the C extension:
+ gem install ruby-watchcat
+
+* For the pure-Ruby version:
+ gem install ruby-watchcat-pure
+
+The C extension requires you to have the libwcat development package
+installed.
+
+== License
+
+Copyright (c) 2006, 2007, 2008 Andre Nathan <andre@digirati.com.br>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+== Author
+
+Ruby/Watchcat was developed by Andre Nathan.
+
+
+== References
+
+* Ruby/Watchcat homepage:
+  http://oss.digirati.com.br/ruby-watchcat/
+* Rubyforge project home:
+  http://www.rubyforge.org/projects/watchcat
+* Watchcatd and libwcat:
+  http://oss.digirati.com.br/watchcatd/

data/examples/example.rb

@@ -4,6 +4,8 @@ require 'watchcat'
 cat = Watchcat.new(:timeout => 5, :signal => 'KILL', :info => 'rubykill!')
 loop do
   # Do something that might be slow.
+  sleep 4 + rand(3)
+  puts 'survived'
   cat.heartbeat
 end
 cat.close # clean cat's litter box.
@@ -12,6 +14,8 @@ cat.close # clean cat's litter box.
 Watchcat.new do |cat|
   loop do
     # Do something that might be slow.
+    sleep 4 + rand(3)
+    puts 'survived'
     cat.heartbeat
   end
 end

data/ext/extconf.rb

@@ -1,5 +1,6 @@
 require 'mkmf'
 
 if find_library('wcat', 'cat_open') and have_header('watchcat.h')
+  $CFLAGS += " -Wall #{ENV['CFLAGS']}"
   create_makefile('watchcat')
 end

data/ext/watchcat.c

@@ -1,5 +1,5 @@
-/*
- * Copyright (c) 2006 Andre Nathan <andre@digirati.com.br>
+/*--
+ * Copyright (c) 2006, 2007, 2008 Andre Nathan <andre@digirati.com.br>
  * 
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -13,111 +13,162 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *
- * $Id: watchcat.c 6 2006-04-21 02:19:26Z andre $
+ * $Id: watchcat.c 21 2008-08-04 14:04:04Z andre $
+ *++
+ */
+
+/*
+ * Document-class: Watchcat
+ *
+ * == Overview
+ *
+ * Ruby/Watchcat is a library for the development of watchcatd-aware
+ * applications. It requires watchcatd to be installed and running, and
+ * communicates with it via UNIX sockets.
  *
  */
+
 #include <ruby.h>
 #include <watchcat.h>
 
+#define SYMBOL(s) ID2SYM(rb_intern(s))
+
+/*
+ * call-seq:
+ *   Watchcat.new([options])                      => watchcat_obj
+ *   Watchcat.new([options]) { |watchcat| block } => watchcat_obj
+ *
+ * Create a new Watchcat object. The parameter hash may have the following
+ * symbols:
+ * +timeout+::
+ *   If watchcatd doesn't receive a heartbeat after this period (in seconds),
+ *   it will signal the process. (default: 60)
+ * +signal+::
+ *   Defines which signal will be sent to the process after the timeout
+ *   expires. Can be a string like 'HUP' or 'SIGHUP' or an integer like 9.
+ *   (default: 9)
+ * +info+::
+ *   Should be a string which is added to the log generated by watchcatd
+ *   when it signals a process. (default: nil)
+ * +device+::
+ *   The watchcat device. (default: +/dev/watchcat+). Use for debugging
+ *   purposes.
+ *
+ * If a block is given, the Watchcat object will be yielded and automatically
+ * closed on block termination.
+ */
 static VALUE
 rb_wcat_open(int argc, VALUE *argv, VALUE self)
 {
-	int cat, id, timeout, signal;
-	char *signame;
-	const char *info;
-	VALUE opt, vtimeout, vsignal, vinfo, vsiglist, mSignal;
-
-	rb_scan_args(argc, argv, "01", &opt);
-	if (NIL_P(opt)) {
-		cat = cat_open();
-		if (cat == -1)
-			rb_sys_fail("cat_open");
-		rb_iv_set(self, "@cat", INT2NUM(cat));
-		return(self);
-	}
-
-	/* Defaults. */
-	timeout = 60;
-	signal = SIGKILL;
-	info = NULL;
-	
-	vtimeout = rb_hash_aref(opt, ID2SYM(rb_intern("timeout")));
-	if (!NIL_P(vtimeout)) {
-		if (FIXNUM_P(vtimeout))
-			timeout = NUM2INT(vtimeout);
-		else
-			rb_raise(rb_eTypeError, "timeout must be an integer");
-	}
-
-	vsignal = rb_hash_aref(opt, ID2SYM(rb_intern("signal")));
-	if (!NIL_P(vsignal)) {
-		switch (TYPE(vsignal)) {
-		case T_FIXNUM:
-			signal = NUM2INT(vsignal);
-			break;
-		case T_STRING:
-			signame = StringValuePtr(vsignal);
-			if (strncmp("SIG", signame, 3) == 0) {
-				signame += 3;
-				vsignal = rb_str_new2(signame);
-			}
-			id = rb_intern("Signal");
-			mSignal = rb_const_get(rb_cObject, id);
-			id = rb_intern("list");
-			vsiglist = rb_funcall(mSignal, id, 0);
-			id = rb_intern("fetch");
-			vsignal = rb_funcall(vsiglist, id, 1, vsignal);
-			signal = NUM2INT(vsignal);
-			break;
-		default:
-			rb_raise(rb_eTypeError,
-				 "signal must be an integer or a string");
-		}
-	}
-
-	vinfo = rb_hash_aref(opt, ID2SYM(rb_intern("info")));
-	if (!NIL_P(vinfo))
-		info = StringValuePtr(vinfo);
-
-	cat = cat_open1(timeout, signal, info);
-	if (cat == -1)
-		rb_sys_fail("cat_open");
-
-	rb_iv_set(self, "@cat", INT2NUM(cat));
-
-	if (rb_block_given_p()) {
-		rb_yield(self);
-		cat_close(cat);
-	}
-
-	return(self);
+    int sock, timeout, signal;
+    char *signame;
+    const char *info;
+    VALUE opt, vtimeout, vsignal, vinfo, vdevice, vsiglist, mSignal;
+
+    rb_scan_args(argc, argv, "01", &opt);
+    if (NIL_P(opt)) {
+        sock = cat_open();
+        if (sock == -1)
+            rb_sys_fail("cat_open");
+        rb_iv_set(self, "@sock", INT2NUM(sock));
+        return(self);
+    }
+
+    /* Defaults. */
+    timeout = 60;
+    signal = SIGKILL;
+    info = NULL;
+    
+    vtimeout = rb_hash_aref(opt, SYMBOL("timeout"));
+    if (!NIL_P(vtimeout)) {
+        if (FIXNUM_P(vtimeout))
+            timeout = NUM2INT(vtimeout);
+        else
+            rb_raise(rb_eArgError, "timeout must be an integer");
+    }
+
+    vsignal = rb_hash_aref(opt, SYMBOL("signal"));
+    if (!NIL_P(vsignal)) {
+        switch (TYPE(vsignal)) {
+        case T_FIXNUM:
+            signal = NUM2INT(vsignal);
+            break;
+        case T_STRING:
+            signame = StringValuePtr(vsignal);
+            if (strncmp("SIG", signame, 3) == 0) {
+                signame += 3;
+                vsignal = rb_str_new2(signame);
+            }
+            mSignal = rb_const_get(rb_cObject, rb_intern("Signal"));
+            vsiglist = rb_funcall(mSignal, rb_intern("list"), 0);
+            vsignal = rb_hash_aref(vsiglist, vsignal);
+            if (NIL_P(vsignal))
+                rb_raise(rb_eArgError, "invalid signal name");
+            else
+                signal = NUM2INT(vsignal);
+            break;
+        default:
+            rb_raise(rb_eArgError, "signal must be an integer or a string");
+        }
+    }
+
+    vinfo = rb_hash_aref(opt, SYMBOL("info"));
+    if (!NIL_P(vinfo))
+        info = StringValuePtr(vinfo);
+
+    vdevice = rb_hash_aref(opt, SYMBOL("device"));
+    if (!NIL_P(vdevice))
+        cat_set_device(StringValuePtr(vdevice));
+
+    sock = cat_open1(timeout, signal, info);
+    if (sock == -1)
+        rb_sys_fail("cat_open");
+
+    rb_iv_set(self, "@sock", INT2NUM(sock));
+
+    if (rb_block_given_p())
+        rb_ensure(rb_yield, self, (void *)cat_close, sock);
+
+    return(self);
 }
 
+/*
+ * call-seq:
+ *   cat.heartbeat
+ *
+ * Send a heartbeat to watchcatd, telling it we're still alive.
+ */
 static VALUE
 rb_wcat_heartbeat(VALUE self)
 {
-	VALUE cCat = rb_iv_get(self, "@cat");
-	if (cat_heartbeat(NUM2INT(cCat)) == -1)
-		rb_sys_fail("cat_heartbeat");
-	return(Qnil);
+    VALUE sock = rb_iv_get(self, "@sock");
+    if (cat_heartbeat(NUM2INT(sock)) == -1)
+        rb_sys_fail("cat_heartbeat");
+    return(Qnil);
 }
 
+/*
+ * call-seq:
+ *   cat.close
+ *
+ * Close communication with watchcatd.
+ */
 static VALUE
 rb_wcat_close(VALUE self)
 {
-	VALUE cCat = rb_iv_get(self, "@cat");
-	if (cat_close(NUM2INT(cCat)) == -1)
-		rb_sys_fail("cat_close");
-	return(Qnil);
+    VALUE sock = rb_iv_get(self, "@sock");
+    if (cat_close(NUM2INT(sock)) == -1)
+        rb_sys_fail("cat_close");
+    return(Qnil);
 }
 
 void
 Init_watchcat(void)
 {
-	VALUE cWCat = rb_define_class("Watchcat", rb_cObject);
+    VALUE cWCat = rb_define_class("Watchcat", rb_cObject);
 
-	rb_define_method(cWCat, "initialize", rb_wcat_open, -1);
-	rb_define_alias(cWCat, "open", "initialize");
-	rb_define_method(cWCat, "heartbeat", rb_wcat_heartbeat, 0);
-	rb_define_method(cWCat, "close", rb_wcat_close, 0);
+    rb_define_method(cWCat, "initialize", rb_wcat_open, -1);
+    rb_define_alias(cWCat, "open", "initialize");
+    rb_define_method(cWCat, "heartbeat", rb_wcat_heartbeat, 0);
+    rb_define_method(cWCat, "close", rb_wcat_close, 0);
 }

metadata

@@ -1,47 +1,58 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
-specification_version: 1
 name: ruby-watchcat
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-04-20 00:00:00 -03:00
-summary: A Ruby extension for libwatchcat
-require_paths: 
-- lib
-email: andre@digirati.com.br
-homepage: http://watchcat.rubyforge.org
-rubyforge_project: ruby-watchcat
-description: Ruby/Watchcat is an extension for the Ruby programming language for the development of watchcatd-aware applications.
-autorequire: watchcat
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.0.1
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
 - Andre Nathan
-files: 
-- ext/watchcat.c
-- ext/extconf.rb
-- examples/example.rb
-test_files: []
-
-rdoc_options: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2008-08-06 00:00:00 -03:00
+default_executable: 
+dependencies: []
 
+description: Ruby/Watchcat is an extension for the Ruby programming language for the development of watchcatd-aware applications.
+email: andre@digirati.com.br
 executables: []
 
 extensions: 
 - ext/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- README
+- ext/watchcat.c
+- ext/extconf.rb
+- examples/example.rb
+has_rdoc: true
+homepage: http://watchcat.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- Ruby/Watchcat--main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: 
 - libwcat and watchcatd.
-dependencies: []
+rubyforge_project: ruby-watchcat
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: A Ruby extension for libwatchcat
+test_files: []