ruby-watchcat-pure 1.0.0

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

@@ -0,0 +1,21 @@
+require 'watchcat'
+
+# Create a new cat.
+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.
+
+# If you call it with a block, the cat cleans its own 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/lib/watchcat.rb

@@ -0,0 +1,142 @@
+#--
+# Copyright (c) 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.
+#
+# $Id: watchcat.rb 24 2008-08-04 14:47:08Z andre $
+#++
+
+# Pure-ruby version of libwcat.
+
+require 'fcntl'
+require 'socket'
+
+#
+# == 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.
+#
+class Watchcat
+  DEFAULT_TIMEOUT = 60
+  DEFAULT_DEVICE  = '/dev/watchcat'
+  DEFAULT_SIGNAL  = Signal.list['KILL']
+
+  # 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.
+  def initialize(args = {}) # :yield:
+    timeout = args[:timeout] || DEFAULT_TIMEOUT
+    device  = args[:device] || DEFAULT_DEVICE
+    info    = args[:info] ? args[:info].to_s : ''
+
+    unless timeout.is_a? Fixnum
+      raise ArgumentError, 'timeout must be an integer'
+    end
+
+    case args[:signal]
+    when nil
+      signal = DEFAULT_SIGNAL
+    when String
+      signal = Signal.list[args[:signal].sub(/^SIG/, '')]
+      raise ArgumentError, "invalid signal name" if signal.nil?
+    when Fixnum
+      signal = args[:signal]
+    else
+      raise ArgumentError, "signal must be an integer or a string"
+    end
+
+    @sock = UNIXSocket.new(device)
+    if Fcntl.const_defined? :F_SETFD
+      @sock.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+    end
+
+    msg = "version: 1\ntimeout: #{timeout}\nsignal: #{signal}"
+    if info.nil?
+      msg << "\n\n"
+    else
+      info.gsub!(/\n/, '_')
+      msg << "\ninfo: #{info}\n\n"
+    end
+
+    safe_write(@sock, msg)
+    if safe_read(@sock, 256) == "ok\n"
+      if  block_given?
+        begin
+          yield(self)
+        ensure
+          @sock.close
+        end
+      end
+      return self
+    else
+      @sock.close
+      # Probably not the best error, but it matches the C library.
+      raise Errno::EPERM
+    end
+  end
+
+  # Send a heartbeat to watchcatd, telling it we're still alive.
+  def heartbeat
+    safe_write(@sock, '.')
+    return nil
+  end
+
+  # Close communication with watchcatd.
+  def close
+    begin
+      @sock.close
+    rescue Errno::EINTR
+      retry
+    end
+    return nil
+  end
+
+private
+
+  def safe_write(fd, buf)
+    act = Signal.trap('PIPE', 'IGN')
+    begin
+      fd.syswrite(buf)
+    rescue Errno::EINTR
+      retry
+    end
+    Signal.trap('PIPE', act)
+  end
+
+  def safe_read(fd, len)
+    buf = ''
+    begin
+      buf = fd.sysread(len)
+    rescue Errno::EINTR
+      retry
+    end
+    return buf
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-watchcat-pure
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andre Nathan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-06 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Ruby/Watchcat-Pure is a pure-ruby implementation of libwatchcat for the development of watchcatd-aware applications.
+email: andre@digirati.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/watchcat.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: 
+- watchcatd
+rubyforge_project: ruby-watchcat
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: A pure-ruby implementation of libwatchcat
+test_files: []
+