README (win32-mutex)

Brief Description

Interface for Mutexes on MS Windows.

Prerequisites

win32-ipc 0.5.0 or later

Installation

rake test (optional)
rake install

Synopsis

   
   require 'win32/mutex'

   # Do not leave out the 'Win32::', otherwise you're using Ruby's Mutex class.
   Win32::Mutex.new(false, 'test') do |m|
      # Do stuff
      m.release
   end
   

Documentation

The mutex.rb file contains inline RDoc documentation. If you installed this file as a gem, then you have the docs.

For an example of win32-mutex in action, look at the mutex_test.rb file in the 'examples' directory. You can also run the 'examples' rake task.

Notes

The Mutex class is a subclass of Win32::Ipc (win32-ipc). This package require's the win32-ipc package internally (you don't need to explicitly call it).

Acknowledgements

Originally adapted from the Win32::Mutex Perl module.

Known Bugs

None that I know of. Please log any other bug reports on the RubyForge project page at http://www.rubyforge.net/projects/win32utils

License

Ruby's

Copyright

(C) 2003-2007 Daniel J. Berger, All Rights Reserved

Warranty

This package is provided "as is" and without any exblockquotess or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.

Authors

Daniel J. Berger
Park Heesob