home *** CD-ROM | disk | FTP | other *** search
/ CD Actual Thematic 7: Programming / CDAT7.iso / Share / Editores / Perl5 / perl / lib / site / Win32 / Mutex.pm < prev    next >
Encoding:
Perl POD Document  |  1997-08-10  |  1.2 KB  |  67 lines
  1. package Win32::Mutex;
  2. use Win32::IPC;
  3. require Exporter;
  4. require DynaLoader;
  5. require AutoLoader;
  6.  
  7. @ISA = qw(Exporter DynaLoader Win32::IPC);
  8.  
  9. $VERSION = '0.01';
  10.  
  11. =head1 NAME
  12.  
  13. Win32::Mutex - create mutex objects in perl.
  14.  
  15. =head1 SYNOPSIS
  16.  
  17.     use Win32::Mutex;
  18.  
  19.     Win32::Mutex::Create($MutObj,$Initial,$Name);
  20.     $MutObj->Wait(INFINITE);
  21.  
  22. =head1 DESCRIPTION
  23.  
  24. This module creates access to the Win32 mutex objects.  The Wait and
  25. WaitForMultipleObjects calls are inherited from the Win32::IPC module.
  26.  
  27. =head1 METHODS AND CONSTRUCTORS
  28.  
  29. =over 8
  30.  
  31. =item Create($MutObj,$Initial,$Name)
  32.  
  33. Creates a mutex object in $MutObj.
  34.  
  35.    Args:
  36.     $Initial    Flags to decide initial ownership.(TRUE = I own it).
  37.     $Name        String to name the mutex.
  38.  
  39. =item Open($MutObj,$Name)
  40.  
  41. Create a mutex object from an already created mutex
  42.  
  43.     Args:
  44.     $MutObj        Container for mutex object.
  45.     $Name        name of already created mutex.
  46.  
  47. =item $MutObj->Release()
  48.  
  49. Release ownership of a mutex.
  50.  
  51. =item $MutObj->Wait($Timeout)
  52.  
  53. Wait for ownership of a mutex.
  54.  
  55.     Args:
  56.     $Timeout    amount of time you will wait.forever = INFINITE;
  57.  
  58.  
  59. =back
  60.  
  61. =cut
  62.  
  63. bootstrap Win32::Mutex;
  64.  
  65. 1;
  66. __END__
  67.