win32-service 0.8.6 → 0.8.7

data/MANIFEST

@@ -1,18 +1,18 @@
-* MANIFEST
-* CHANGES
-* README
-* Rakefile
-* win32-service.gemspec
-* doc/daemon.txt
-* doc/service.txt
-* examples/demo_daemon.rb
-* examples/demo_daemon_ctl.rb
-* examples/demo_services.rb
-* lib/win32/service.rb
-* lib/win32/daemon.rb
-* test/test_win32_daemon.rb
-* test/test_win32_service_configure.rb
-* test/test_win32_service_create.rb
-* test/test_win32_service_info.rb
-* test/test_win32_service_status.rb
-* test/test_win32_service.rb
+* MANIFEST
+* CHANGES
+* README
+* Rakefile
+* win32-service.gemspec
+* doc/daemon.txt
+* doc/service.txt
+* examples/demo_daemon.rb
+* examples/demo_daemon_ctl.rb
+* examples/demo_services.rb
+* lib/win32/service.rb
+* lib/win32/daemon.rb
+* test/test_win32_daemon.rb
+* test/test_win32_service_configure.rb
+* test/test_win32_service_create.rb
+* test/test_win32_service_info.rb
+* test/test_win32_service_status.rb
+* test/test_win32_service.rb

data/README

@@ -1,77 +1,77 @@
-== Description
-  The win32-service library allows you to control or create MS Windows services.
-
-== Installation
-  gem install win32-service
-
-== Synopsis
-  require 'win32/service'
-
-  # Iterate over the available services
-  Service.services do |service|
-    p service
-  end
-
-== More Documentation
-  Please see the documentation in the 'doc' directory, or the gem documentation
-  that was installed when you installed this library as a gem.
-
-== Known Issues
-=== Problem:
-  Service.delete causes "Unable to delete: The specified service has been
-  marked for deletion."
- 
-=== Troubleshooting:
-  This can be caused by one of two things. Either you attempted to delete a
-  running service without stopping it first, or you have the Services
-  Administrative Tool (GUI) open. In the former case, the solution is to first
-  stop the service if it's running. In the latter, close the Services GUI
-  admin tool before deleting.
-	
-=== Problem:
-  Service.start causes, "The service did not respond to the start or control
-  request in a timely fashion."
-
-=== Troubleshooting:
-  The best way to debug your services is to wrap your entire Daemon subclass
-  in a begin/end block and send error messages to a file. That should give a
-  good clue as to the nature of the problem. The most probable culprits are:
-
-  * You forgot to require 'win32/daemon' in your Daemon code.
-
-  * You've tried to require a library that's not in your $LOAD_PATH. Make sure
-  that your require statements are inside the begin/rescue block so that you can
-  easily find those mistakes.
-
-  * Your have a bad binary path name. Be sure to use an absolute path name for
-  the binary path name, including the full path to the Ruby interpreter, e.g.
-  'c:\ruby\bin\ruby' instead of just 'ruby'.
-
-  * You've got a syntax error in your code somewhere.
-
-== See Also
-  ruby-wmi
-
-== Future Plans
-  Add service_session_change hook
-
-== Copyright
-  (C) 2003-2014, Daniel J. Berger, All Rights Reserved
-    
-== License
-  Artistic 2.0
-
-== Contributions
-  Although this library is free, please consider having your company
-  setup a gittip if used by your company professionally.
-
-  http://www.gittip.com/djberg96/
-    
-== Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-    
-== Authors
-  Daniel J. Berger   
-  Park Heesob
+== Description
+  The win32-service library allows you to control or create MS Windows services.
+
+== Installation
+  gem install win32-service
+
+== Synopsis
+  require 'win32/service'
+
+  # Iterate over the available services
+  Win32::Service.services do |service|
+    p service
+  end
+
+== More Documentation
+  Please see the documentation in the 'doc' directory, or the gem documentation
+  that was installed when you installed this library as a gem.
+
+== Known Issues
+=== Problem:
+  Service.delete causes "Unable to delete: The specified service has been
+  marked for deletion."
+ 
+=== Troubleshooting:
+  This can be caused by one of two things. Either you attempted to delete a
+  running service without stopping it first, or you have the Services
+  Administrative Tool (GUI) open. In the former case, the solution is to first
+  stop the service if it's running. In the latter, close the Services GUI
+  admin tool before deleting.
+	
+=== Problem:
+  Service.start causes, "The service did not respond to the start or control
+  request in a timely fashion."
+
+=== Troubleshooting:
+  The best way to debug your services is to wrap your entire Daemon subclass
+  in a begin/end block and send error messages to a file. That should give a
+  good clue as to the nature of the problem. The most probable culprits are:
+
+  * You forgot to require 'win32/daemon' in your Daemon code.
+
+  * You've tried to require a library that's not in your $LOAD_PATH. Make sure
+  that your require statements are inside the begin/rescue block so that you can
+  easily find those mistakes.
+
+  * Your have a bad binary path name. Be sure to use an absolute path name for
+  the binary path name, including the full path to the Ruby interpreter, e.g.
+  'c:\ruby\bin\ruby' instead of just 'ruby'.
+
+  * You've got a syntax error in your code somewhere.
+
+== See Also
+  ruby-wmi
+
+== Future Plans
+  Add service_session_change hook
+
+== Copyright
+  (C) 2003-2014, Daniel J. Berger, All Rights Reserved
+    
+== License
+  Artistic 2.0
+
+== Contributions
+  Although this library is free, please consider having your company
+  setup a gittip if used by your company professionally.
+
+  http://www.gittip.com/djberg96/
+    
+== Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+    
+== Authors
+  Daniel J. Berger   
+  Park Heesob

data/Rakefile

@@ -1,101 +1,101 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rbconfig'
-include RbConfig
-
-CLEAN.include(
-  '**/*.gem', # Gem files
-  '**/*.rbc'  # Rubinius
-)
-
-namespace 'gem' do
-  desc "Create the win32-service gem"
-  task :create => [:clean] do
-    spec = eval(IO.read('win32-service.gemspec'))
-    if Gem::VERSION.to_f < 2.0
-      Gem::Builder.new(spec).build
-    else
-      require 'rubygems/package'
-      Gem::Package.build(spec)
-    end
-  end
-
-  desc "Install the win32-service gem"
-  task :install => [:create] do
-    file = Dir['*.gem'].first
-    sh "gem install -l #{file}"
-  end
-end
-
-namespace :example do
-  desc "Run the services example program."
-  task :services do
-    sh "ruby -Ilib examples/demo_services.rb"
-  end
-end
-
-namespace 'test' do
-  desc 'Run all tests for the win32-service library'
-  Rake::TestTask.new('all') do |t|
-    t.verbose = true
-    t.warning = true
-  end
-
-  desc 'Run the tests for the Win32::Daemon class'
-  Rake::TestTask.new('daemon') do |t|
-    task :daemon
-    t.verbose = true
-    t.warning = true
-    t.test_files = FileList['test/test_win32_daemon.rb']
-  end
-
-  namespace 'service' do
-    desc 'Run the tests for the Win32::Service class'
-    Rake::TestTask.new('all') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service*.rb']
-    end
-
-    Rake::TestTask.new('configure') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_configure.rb']
-    end
-
-    Rake::TestTask.new('control') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service.rb']
-    end
-
-    Rake::TestTask.new('create') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_create.rb']
-    end
-
-    Rake::TestTask.new('info') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_info.rb']
-    end
-
-    Rake::TestTask.new('status') do |t|
-      t.verbose = true
-      t.warning = true
-      t.test_files = FileList['test/test_win32_service_status.rb']
-    end
-  end
-
-  task :all do
-    Rake.application[:clean].execute
-  end
-
-  task :daemon do
-    Rake.application[:clean].execute
-  end
-end
-
-task :default => 'test:all'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include RbConfig
+
+CLEAN.include(
+  '**/*.gem', # Gem files
+  '**/*.rbc'  # Rubinius
+)
+
+namespace 'gem' do
+  desc "Create the win32-service gem"
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-service.gemspec'))
+    if Gem::VERSION.to_f < 2.0
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
+  end
+
+  desc "Install the win32-service gem"
+  task :install => [:create] do
+    file = Dir['*.gem'].first
+    sh "gem install -l #{file}"
+  end
+end
+
+namespace :example do
+  desc "Run the services example program."
+  task :services do
+    sh "ruby -Ilib examples/demo_services.rb"
+  end
+end
+
+namespace 'test' do
+  desc 'Run all tests for the win32-service library'
+  Rake::TestTask.new('all') do |t|
+    t.verbose = true
+    t.warning = true
+  end
+
+  desc 'Run the tests for the Win32::Daemon class'
+  Rake::TestTask.new('daemon') do |t|
+    task :daemon
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_win32_daemon.rb']
+  end
+
+  namespace 'service' do
+    desc 'Run the tests for the Win32::Service class'
+    Rake::TestTask.new('all') do |t|
+      t.verbose = true
+      t.warning = true
+      t.test_files = FileList['test/test_win32_service*.rb']
+    end
+
+    Rake::TestTask.new('configure') do |t|
+      t.verbose = true
+      t.warning = true
+      t.test_files = FileList['test/test_win32_service_configure.rb']
+    end
+
+    Rake::TestTask.new('control') do |t|
+      t.verbose = true
+      t.warning = true
+      t.test_files = FileList['test/test_win32_service.rb']
+    end
+
+    Rake::TestTask.new('create') do |t|
+      t.verbose = true
+      t.warning = true
+      t.test_files = FileList['test/test_win32_service_create.rb']
+    end
+
+    Rake::TestTask.new('info') do |t|
+      t.verbose = true
+      t.warning = true
+      t.test_files = FileList['test/test_win32_service_info.rb']
+    end
+
+    Rake::TestTask.new('status') do |t|
+      t.verbose = true
+      t.warning = true
+      t.test_files = FileList['test/test_win32_service_status.rb']
+    end
+  end
+
+  task :all do
+    Rake.application[:clean].execute
+  end
+
+  task :daemon do
+    Rake.application[:clean].execute
+  end
+end
+
+task :default => 'test:all'

data/doc/daemon.txt

@@ -1,157 +1,157 @@
-= Description
-  The Daemon class is a wrapper class that allows you to run your code as a
-  Windows service.
-
-= Synopsis
-  class Daemon
-    def service_main
-      while running?
-        sleep 3
-        File.open("c:\\test.log", "a"){ |f| f.puts "service is running" }
-      end
-    end
-  end
-
-  Daemon.mainloop
-    
-= Singleton Methods
-Daemon.mainloop
-  This is the method that actually puts your code into a loop and allows it
-  to run as a service. The code that is actually run while in the mainloop
-  is what you defined in the Daemon#service_main method.
-
-= Instance Methods 
-Daemon#running?
-  Returns whether or not the daemon is running. This is just a shortcut
-  for checking if the state is RUNNING, PAUSED or IDLE.
-   
-  This is typically used within your service_main method. See the
-  demo_daemon.rb file in the 'examples' directory for an example of how it's
-  used in practice.
-   
-Daemon#service_init
-  Any code defined defined within this method occurs before service_main is
-  reached. Any initialization code that takes more than two seconds to
-  execute should be placed here. Otherwise, your service may timeout when
-  you try to start it.
-  
-Daemon#service_main(*args)
-  You are expected to define your own service_main() method. The code
-  defined in this method is the code that will run while running as a
-  service.
-   
-  Any +args+ passed to Service.start are passed to this method.
-    
-Daemon#state
-  Returns the current state of the Daemon. For a list of valid states, see
-  the Constants section below.
-    
-= Signal Event Hooks
-  These methods are called if defined within your Daemon class, and the
-  appropriate signal is received by your service.
-
-Daemon#service_stop
-  Called if the service receives a SERVICE_CONTROL_STOP signal. This is
-  what the Service.stop() method sends.
-
-Daemon#service_pause
-  Called if the service receives a SERVICE_CONTROL_PAUSE signal. This is
-  what the Service.pause() method sends.
-    
-Daemon#service_resume
-  Called if the service receives a SERVICE_CONTROL_CONTINUE signal. This
-  is what the Service.resume() method sends.
-    
-Daemon#service_interrogate
-  Called if the service receives a SERVICE_CONTROL_INTERROGATE signal. This
-  notifies a service that it should report its current status information to
-  the service control manager.
-    
-Daemon#service_shutdown
-  Called if the service receives a SERVICE_CONTROL_SHUTDOWN signal.
-    
-Daemon#service_netbindadd
-  Called if the service receives a SERVICE_CONTROL_NETBINDADD signal. This
-  notifies a network service that there is a new component for binding.
-    
-Daemon#service_netbinddisable
-  Called if the service receives a SERVICE_CONTROL_NETBINDDISABLE signal.
-  This notifies a network service that one of its bindings has been
-  disabled.
-    
-Daemon#service_netbindenable
-  Called if the service receives a SERVICE_CONTROL_NETBINDENABLE signal.
-  This  Notifies a network service that a disabled binding has been enabled.
-
-Daemon#service_netbindremove
-  Called if the service receives a SERVICE_CONTROL_NETBINDREMOVE signal.
-  This notifies a network service that that a component for binding has
-  been removed.
-
-Daemon#service_paramchange
-  Called if the service receives a SERVICE_CONTROL_PARAMCHANGE signal.
-  This notifies a service that its startup parameters have changed.
-
-= Constants
-
-=== Service state constants
-Daemon::CONTINUE_PENDING
-  The service continue is pending.
-
-Daemon::PAUSE_PENDING
-  The service pause is pending.
-
-Daemon::PAUSED
-  The service is paused (but not STOPPED).
-
-Daemon::RUNNING
-  The service is running.
-
-Daemon::START_PENDING
-  The service is starting (but is not yet in a RUNNING state).
-
-Daemon::STOP_PENDING
-  The service is stopping (but is not yet in a STOPPED state).
-
-Daemon::STOPPED
-  The service is not running.
-   
-Daemon::IDLE
-  The service is running, in an idle state. This is a custom state that
-  we added that gets around a thread blocking issue.
-    
-= Notes
-  You must create a service before you can actually run it. Look in the
-  examples directory for the files 'demo_daemon.rb' and 'demodaemon_ctl.rb'.
-  They're small and straightforward examples of how to control, install and
-  setup your own Daemon.
-
-= Known Bugs
-  None known.  Please report any bugs you find on the Bug tracker at
-  https//github.com/djberg96/win32-service
-
-= Future Plans
-  None at this time.
-
-  Suggestions welcome. Please post them on the github project page at
-  https//github.com/djberg96/win32-service
-   
-= Acknowledgements
-  Many thanks go to Patrick Hurley for providing the fix for the thread
-  blocking issue for the original C code. Thanks also go to Kevin Burge for
-  his patch that solved service responsiveness issues.
-    
-= Copyright
-  (C) 2003-2013 Daniel J. Berger, All Rights Reserved
-
-= License
-  Artistic 2.0
-
-= Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-
-= Author(s)
-* Daniel J. Berger
-* Park Heesob
+= Description
+  The Daemon class is a wrapper class that allows you to run your code as a
+  Windows service.
+
+= Synopsis
+  class Daemon
+    def service_main
+      while running?
+        sleep 3
+        File.open("c:\\test.log", "a"){ |f| f.puts "service is running" }
+      end
+    end
+  end
+
+  Daemon.mainloop
+    
+= Singleton Methods
+Daemon.mainloop
+  This is the method that actually puts your code into a loop and allows it
+  to run as a service. The code that is actually run while in the mainloop
+  is what you defined in the Daemon#service_main method.
+
+= Instance Methods 
+Daemon#running?
+  Returns whether or not the daemon is running. This is just a shortcut
+  for checking if the state is RUNNING, PAUSED or IDLE.
+   
+  This is typically used within your service_main method. See the
+  demo_daemon.rb file in the 'examples' directory for an example of how it's
+  used in practice.
+   
+Daemon#service_init
+  Any code defined defined within this method occurs before service_main is
+  reached. Any initialization code that takes more than two seconds to
+  execute should be placed here. Otherwise, your service may timeout when
+  you try to start it.
+  
+Daemon#service_main(*args)
+  You are expected to define your own service_main() method. The code
+  defined in this method is the code that will run while running as a
+  service.
+   
+  Any +args+ passed to Service.start are passed to this method.
+    
+Daemon#state
+  Returns the current state of the Daemon. For a list of valid states, see
+  the Constants section below.
+    
+= Signal Event Hooks
+  These methods are called if defined within your Daemon class, and the
+  appropriate signal is received by your service.
+
+Daemon#service_stop
+  Called if the service receives a SERVICE_CONTROL_STOP signal. This is
+  what the Service.stop() method sends.
+
+Daemon#service_pause
+  Called if the service receives a SERVICE_CONTROL_PAUSE signal. This is
+  what the Service.pause() method sends.
+    
+Daemon#service_resume
+  Called if the service receives a SERVICE_CONTROL_CONTINUE signal. This
+  is what the Service.resume() method sends.
+    
+Daemon#service_interrogate
+  Called if the service receives a SERVICE_CONTROL_INTERROGATE signal. This
+  notifies a service that it should report its current status information to
+  the service control manager.
+    
+Daemon#service_shutdown
+  Called if the service receives a SERVICE_CONTROL_SHUTDOWN signal.
+    
+Daemon#service_netbindadd
+  Called if the service receives a SERVICE_CONTROL_NETBINDADD signal. This
+  notifies a network service that there is a new component for binding.
+    
+Daemon#service_netbinddisable
+  Called if the service receives a SERVICE_CONTROL_NETBINDDISABLE signal.
+  This notifies a network service that one of its bindings has been
+  disabled.
+    
+Daemon#service_netbindenable
+  Called if the service receives a SERVICE_CONTROL_NETBINDENABLE signal.
+  This  Notifies a network service that a disabled binding has been enabled.
+
+Daemon#service_netbindremove
+  Called if the service receives a SERVICE_CONTROL_NETBINDREMOVE signal.
+  This notifies a network service that that a component for binding has
+  been removed.
+
+Daemon#service_paramchange
+  Called if the service receives a SERVICE_CONTROL_PARAMCHANGE signal.
+  This notifies a service that its startup parameters have changed.
+
+= Constants
+
+=== Service state constants
+Daemon::CONTINUE_PENDING
+  The service continue is pending.
+
+Daemon::PAUSE_PENDING
+  The service pause is pending.
+
+Daemon::PAUSED
+  The service is paused (but not STOPPED).
+
+Daemon::RUNNING
+  The service is running.
+
+Daemon::START_PENDING
+  The service is starting (but is not yet in a RUNNING state).
+
+Daemon::STOP_PENDING
+  The service is stopping (but is not yet in a STOPPED state).
+
+Daemon::STOPPED
+  The service is not running.
+   
+Daemon::IDLE
+  The service is running, in an idle state. This is a custom state that
+  we added that gets around a thread blocking issue.
+    
+= Notes
+  You must create a service before you can actually run it. Look in the
+  examples directory for the files 'demo_daemon.rb' and 'demodaemon_ctl.rb'.
+  They're small and straightforward examples of how to control, install and
+  setup your own Daemon.
+
+= Known Bugs
+  None known.  Please report any bugs you find on the Bug tracker at
+  https//github.com/djberg96/win32-service
+
+= Future Plans
+  None at this time.
+
+  Suggestions welcome. Please post them on the github project page at
+  https//github.com/djberg96/win32-service
+   
+= Acknowledgements
+  Many thanks go to Patrick Hurley for providing the fix for the thread
+  blocking issue for the original C code. Thanks also go to Kevin Burge for
+  his patch that solved service responsiveness issues.
+    
+= Copyright
+  (C) 2003-2013 Daniel J. Berger, All Rights Reserved
+
+= License
+  Artistic 2.0
+
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+= Author(s)
+* Daniel J. Berger
+* Park Heesob