win32-service 0.8.10 → 1.0.1

data/examples/demo_daemon.rb

@@ -1,96 +1,96 @@
-LOG_FILE = 'C:\\Tmp\\win32_daemon_test.log'
-
-begin
-  require 'rubygems'
-  require 'win32/daemon'
-  include Win32
-
-  class DemoDaemon < Daemon
-    # This method fires off before the +service_main+ mainloop is entered.
-    # Any pre-setup code you need to run before your service's mainloop
-    # starts should be put here. Otherwise the service might fail with a
-    # timeout error when you try to start it.
-    #
-    def service_init
-      Dir.mkdir("C:/Tmp") unless File.exist?("C:/Tmp")
-      10.times{ |i|
-        File.open(LOG_FILE , 'a'){ |f| f.puts("#{i}") }
-        sleep 1
-      }
-    end
-
-    # This is the daemon's mainloop. In other words, whatever runs here
-    # is the code that runs while your service is running. Note that the
-    # loop is not implicit.
-    #
-    # You must setup a loop as I've done here with the 'while running?'
-    # code, or setup your own loop. Otherwise your service will exit and
-    # won't be especially useful.
-    #
-    # In this particular case, I've setup a loop to append a short message
-    # and timestamp to a file on your C: drive every 20 seconds. Be sure
-    # to stop the service when you're done!
-    #
-    def service_main(*args)
-      msg = 'service_main entered at: ' + Time.now.to_s
-
-      File.open(LOG_FILE, 'a'){ |f|
-        f.puts msg
-        f.puts "Args: " + args.join(',')
-      }
-
-      # While we're in here the daemon is running.
-      while running?
-        if state == RUNNING
-          sleep 20
-          msg = 'Service is running as of: ' + Time.now.to_s
-          File.open(LOG_FILE, 'a'){ |f| f.puts msg }
-        else # PAUSED or IDLE
-          sleep 0.5
-        end
-      end
-
-      # We've left the loop, the daemon is about to exit.
-
-      File.open(LOG_FILE, 'a'){ |f| f.puts "STATE: #{state}" }
-
-      msg = 'service_main left at: ' + Time.now.to_s
-
-      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
-    end
-
-    # This event triggers when the service receives a signal to stop.
-    #
-    # NOTE: Older versions of this code used an explicit exit! call
-    # to force the Ruby interpreter to exit. Don't do that. It is no
-    # longer required and, in fact, may cause issues.
-    #
-    def service_stop
-      msg = 'Received stop signal at: ' + Time.now.to_s
-      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
-    end
-
-    # This event triggers when the service receives a signal to pause.
-    #
-    def service_pause
-      msg = 'Received pause signal at: ' + Time.now.to_s
-      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
-    end
-
-    # This event triggers when the service receives a signal to resume
-    # from a paused state.
-    #
-    def service_resume
-      msg = 'Received resume signal at: ' + Time.now.to_s
-      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
-    end
-  end
-
-  # Create an instance of the Daemon and put it into a loop. I borrowed the
-  # method name 'mainloop' from Tk, btw.
-  #
-  DemoDaemon.mainloop
-rescue Exception => err
-  File.open(LOG_FILE, 'a'){ |fh| fh.puts "Daemon failure: #{err}" }
-  raise
-end
+LOG_FILE = 'C:\\Tmp\\win32_daemon_test.log'
+
+begin
+  require 'rubygems'
+  require 'win32/daemon'
+  include Win32
+
+  class DemoDaemon < Daemon
+    # This method fires off before the +service_main+ mainloop is entered.
+    # Any pre-setup code you need to run before your service's mainloop
+    # starts should be put here. Otherwise the service might fail with a
+    # timeout error when you try to start it.
+    #
+    def service_init
+      Dir.mkdir("C:/Tmp") unless File.exist?("C:/Tmp")
+      10.times{ |i|
+        File.open(LOG_FILE , 'a'){ |f| f.puts("#{i}") }
+        sleep 1
+      }
+    end
+
+    # This is the daemon's mainloop. In other words, whatever runs here
+    # is the code that runs while your service is running. Note that the
+    # loop is not implicit.
+    #
+    # You must setup a loop as I've done here with the 'while running?'
+    # code, or setup your own loop. Otherwise your service will exit and
+    # won't be especially useful.
+    #
+    # In this particular case, I've setup a loop to append a short message
+    # and timestamp to a file on your C: drive every 20 seconds. Be sure
+    # to stop the service when you're done!
+    #
+    def service_main(*args)
+      msg = 'service_main entered at: ' + Time.now.to_s
+
+      File.open(LOG_FILE, 'a'){ |f|
+        f.puts msg
+        f.puts "Args: " + args.join(',')
+      }
+
+      # While we're in here the daemon is running.
+      while running?
+        if state == RUNNING
+          sleep 20
+          msg = 'Service is running as of: ' + Time.now.to_s
+          File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+        else # PAUSED or IDLE
+          sleep 0.5
+        end
+      end
+
+      # We've left the loop, the daemon is about to exit.
+
+      File.open(LOG_FILE, 'a'){ |f| f.puts "STATE: #{state}" }
+
+      msg = 'service_main left at: ' + Time.now.to_s
+
+      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+    end
+
+    # This event triggers when the service receives a signal to stop.
+    #
+    # NOTE: Older versions of this code used an explicit exit! call
+    # to force the Ruby interpreter to exit. Don't do that. It is no
+    # longer required and, in fact, may cause issues.
+    #
+    def service_stop
+      msg = 'Received stop signal at: ' + Time.now.to_s
+      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+    end
+
+    # This event triggers when the service receives a signal to pause.
+    #
+    def service_pause
+      msg = 'Received pause signal at: ' + Time.now.to_s
+      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+    end
+
+    # This event triggers when the service receives a signal to resume
+    # from a paused state.
+    #
+    def service_resume
+      msg = 'Received resume signal at: ' + Time.now.to_s
+      File.open(LOG_FILE, 'a'){ |f| f.puts msg }
+    end
+  end
+
+  # Create an instance of the Daemon and put it into a loop. I borrowed the
+  # method name 'mainloop' from Tk, btw.
+  #
+  DemoDaemon.mainloop
+rescue Exception => err
+  File.open(LOG_FILE, 'a'){ |fh| fh.puts "Daemon failure: #{err}" }
+  raise
+end

data/examples/demo_daemon_ctl.rb

@@ -1,123 +1,123 @@
-############################################################################
-# demo_daemon_ctl.rb
-#
-# This is a command line script for installing and/or running a small
-# Ruby program as a service. The service will simply write a small bit
-# of text to a file every 20 seconds. It will also write some text to the
-# file during the initialization (service_init) step.
-#
-# It should take about 10 seconds to start, which is intentional - it's a test
-# of the service_init hook, so don't be surprised if you see "one moment,
-# start pending" about 10 times on the command line.
-#
-# The file in question is C:\Tmp\win32_daemon_test.log. Feel free to delete
-# it when you're finished.
-#
-# To run the service, you must install it first.
-#
-# Usage: ruby demo_daemon_ctl.rb <option>
-#
-# Note that you *must* pass this program an option
-#
-# Options:
-#    install    - Installs the service.  The service name is "DemoSvc"
-#                 and the display name is "Demo".
-#    start      - Starts the service.  Make sure you stop it at some point or
-#                 you will eventually fill up your filesystem!.
-#    stop       - Stops the service.
-#    pause      - Pauses the service.
-#    resume     - Resumes the service.
-#    uninstall  - Uninstalls the service.
-#    delete     - Same as uninstall.
-#
-# You can also used the Windows Services GUI to start and stop the service.
-#
-# To get to the Windows Services GUI just follow:
-#    Start -> Control Panel -> Administrative Tools -> Services
-############################################################################
-require 'win32/service'
-require 'rbconfig'
-include Win32
-include RbConfig
-
-# Make sure you're using the version you think you're using.
-puts 'VERSION: ' + Service::VERSION
-
-SERVICE_NAME = 'DemoSvc'
-SERVICE_DISPLAYNAME = 'Demo'
-
-# Quote the full path to deal with possible spaces in the path name.
-ruby = File.join(CONFIG['bindir'], CONFIG['ruby_install_name']).tr('/', '\\')
-path = ' "' + File.dirname(File.expand_path($0)).tr('/', '\\')
-path += '\demo_daemon.rb"'
-cmd = ruby + path
-
-# You must provide at least one argument.
-raise ArgumentError, 'No argument provided' unless ARGV[0]
-
-case ARGV[0].downcase
-   when 'install'
-      Service.new(
-         :service_name     => SERVICE_NAME,
-         :display_name     => SERVICE_DISPLAYNAME,
-         :description      => 'Sample Ruby service',
-         :binary_path_name => cmd
-      )
-      puts 'Service ' + SERVICE_NAME + ' installed'
-   when 'start'
-      if Service.status(SERVICE_NAME).current_state != 'running'
-         Service.start(SERVICE_NAME, nil, 'hello', 'world')
-         while Service.status(SERVICE_NAME).current_state != 'running'
-            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
-            sleep 1
-         end
-         puts 'Service ' + SERVICE_NAME + ' started'
-      else
-         puts 'Already running'
-      end
-   when 'stop'
-      if Service.status(SERVICE_NAME).current_state != 'stopped'
-         Service.stop(SERVICE_NAME)
-         while Service.status(SERVICE_NAME).current_state != 'stopped'
-            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
-            sleep 1
-         end
-         puts 'Service ' + SERVICE_NAME + ' stopped'
-      else
-         puts 'Already stopped'
-      end
-   when 'uninstall', 'delete'
-      if Service.status(SERVICE_NAME).current_state != 'stopped'
-         Service.stop(SERVICE_NAME)
-      end
-      while Service.status(SERVICE_NAME).current_state != 'stopped'
-         puts 'One moment...' + Service.status(SERVICE_NAME).current_state
-         sleep 1
-      end
-      Service.delete(SERVICE_NAME)
-      puts 'Service ' + SERVICE_NAME + ' deleted'
-   when 'pause'
-      if Service.status(SERVICE_NAME).current_state != 'paused'
-         Service.pause(SERVICE_NAME)
-         while Service.status(SERVICE_NAME).current_state != 'paused'
-            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
-            sleep 1
-         end
-         puts 'Service ' + SERVICE_NAME + ' paused'
-      else
-         puts 'Already paused'
-      end
-   when 'resume'
-      if Service.status(SERVICE_NAME).current_state != 'running'
-         Service.resume(SERVICE_NAME)
-         while Service.status(SERVICE_NAME).current_state != 'running'
-            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
-            sleep 1
-         end
-         puts 'Service ' + SERVICE_NAME + ' resumed'
-      else
-         puts 'Already running'
-      end
-   else
-      raise ArgumentError, 'unknown option: ' + ARGV[0]
-end
+############################################################################
+# demo_daemon_ctl.rb
+#
+# This is a command line script for installing and/or running a small
+# Ruby program as a service. The service will simply write a small bit
+# of text to a file every 20 seconds. It will also write some text to the
+# file during the initialization (service_init) step.
+#
+# It should take about 10 seconds to start, which is intentional - it's a test
+# of the service_init hook, so don't be surprised if you see "one moment,
+# start pending" about 10 times on the command line.
+#
+# The file in question is C:\Tmp\win32_daemon_test.log. Feel free to delete
+# it when you're finished.
+#
+# To run the service, you must install it first.
+#
+# Usage: ruby demo_daemon_ctl.rb <option>
+#
+# Note that you *must* pass this program an option
+#
+# Options:
+#    install    - Installs the service.  The service name is "DemoSvc"
+#                 and the display name is "Demo".
+#    start      - Starts the service.  Make sure you stop it at some point or
+#                 you will eventually fill up your filesystem!.
+#    stop       - Stops the service.
+#    pause      - Pauses the service.
+#    resume     - Resumes the service.
+#    uninstall  - Uninstalls the service.
+#    delete     - Same as uninstall.
+#
+# You can also used the Windows Services GUI to start and stop the service.
+#
+# To get to the Windows Services GUI just follow:
+#    Start -> Control Panel -> Administrative Tools -> Services
+############################################################################
+require 'win32/service'
+require 'rbconfig'
+include Win32
+include RbConfig
+
+# Make sure you're using the version you think you're using.
+puts 'VERSION: ' + Service::VERSION
+
+SERVICE_NAME = 'DemoSvc'
+SERVICE_DISPLAYNAME = 'Demo'
+
+# Quote the full path to deal with possible spaces in the path name.
+ruby = File.join(CONFIG['bindir'], CONFIG['ruby_install_name']).tr('/', '\\')
+path = ' "' + File.dirname(File.expand_path($0)).tr('/', '\\')
+path += '\demo_daemon.rb"'
+cmd = ruby + path
+
+# You must provide at least one argument.
+raise ArgumentError, 'No argument provided' unless ARGV[0]
+
+case ARGV[0].downcase
+   when 'install'
+      Service.new(
+         :service_name     => SERVICE_NAME,
+         :display_name     => SERVICE_DISPLAYNAME,
+         :description      => 'Sample Ruby service',
+         :binary_path_name => cmd
+      )
+      puts 'Service ' + SERVICE_NAME + ' installed'
+   when 'start'
+      if Service.status(SERVICE_NAME).current_state != 'running'
+         Service.start(SERVICE_NAME, nil, 'hello', 'world')
+         while Service.status(SERVICE_NAME).current_state != 'running'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' started'
+      else
+         puts 'Already running'
+      end
+   when 'stop'
+      if Service.status(SERVICE_NAME).current_state != 'stopped'
+         Service.stop(SERVICE_NAME)
+         while Service.status(SERVICE_NAME).current_state != 'stopped'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' stopped'
+      else
+         puts 'Already stopped'
+      end
+   when 'uninstall', 'delete'
+      if Service.status(SERVICE_NAME).current_state != 'stopped'
+         Service.stop(SERVICE_NAME)
+      end
+      while Service.status(SERVICE_NAME).current_state != 'stopped'
+         puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+         sleep 1
+      end
+      Service.delete(SERVICE_NAME)
+      puts 'Service ' + SERVICE_NAME + ' deleted'
+   when 'pause'
+      if Service.status(SERVICE_NAME).current_state != 'paused'
+         Service.pause(SERVICE_NAME)
+         while Service.status(SERVICE_NAME).current_state != 'paused'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' paused'
+      else
+         puts 'Already paused'
+      end
+   when 'resume'
+      if Service.status(SERVICE_NAME).current_state != 'running'
+         Service.resume(SERVICE_NAME)
+         while Service.status(SERVICE_NAME).current_state != 'running'
+            puts 'One moment...' + Service.status(SERVICE_NAME).current_state
+            sleep 1
+         end
+         puts 'Service ' + SERVICE_NAME + ' resumed'
+      else
+         puts 'Already running'
+      end
+   else
+      raise ArgumentError, 'unknown option: ' + ARGV[0]
+end

data/examples/demo_services.rb

@@ -1,30 +1,30 @@
-#######################################################################
-# demo_services.rb
-#
-# Test script for general futzing that shows off the basic
-# capabilities of this library. Modify as you see fit.
-#
-# You can run this sample program via the "example:services" task.
-#######################################################################
-require 'win32/service'
-include Win32
-
-puts "VERSION: " + Service::VERSION
-
-p Service.exists?('Schedule')
-p Service.exists?('bogusxxx')
-
-status = Service.status('Schedule')
-p status
-
-info = Service.config_info('Schedule')
-
-print "\n\nShowing config info for Schedule service\n\n"
-p info
-
-print "\n\nAbout to show all services\n\n"
-sleep 10
-
-Service.services{ |struct|
-  p struct
-}
+#######################################################################
+# demo_services.rb
+#
+# Test script for general futzing that shows off the basic
+# capabilities of this library. Modify as you see fit.
+#
+# You can run this sample program via the "example:services" task.
+#######################################################################
+require 'win32/service'
+include Win32
+
+puts "VERSION: " + Service::VERSION
+
+p Service.exists?('Schedule')
+p Service.exists?('bogusxxx')
+
+status = Service.status('Schedule')
+p status
+
+info = Service.config_info('Schedule')
+
+print "\n\nShowing config info for Schedule service\n\n"
+p info
+
+print "\n\nAbout to show all services\n\n"
+sleep 10
+
+Service.services{ |struct|
+  p struct
+}