The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

<html>
<head>
<title>IPC::Mmap::Win32</title>
</head>
<body>
<table width='100%' border=0 CELLPADDING='0' CELLSPACING='3'>
<TR>
<TD VALIGN='top' align=left><FONT SIZE='-2'>
 SUMMARY:&nbsp;<A HREF='#constructor_summary'>CONSTR</a>&nbsp;|&nbsp;<A HREF='#method_summary'>METHOD</a>
 </FONT></TD>
<TD VALIGN='top' align=right><FONT SIZE='-2'>
DETAIL:&nbsp;<A HREF='#constructor_detail'>CONSTR</a>&nbsp;|&nbsp;<A HREF='#method_detail'>METHOD</a>
</FONT></TD>
</TR>
</table><hr>
<h2>Class IPC::Mmap::Win32</h2>

<p>
<dl>
<dt><b>Inherits from:</b>
<dd><a href='../../IPC/Mmap.html'>IPC::Mmap</a></dd>
</dt>
</dl>

<hr>

Concrete implementation of the IPC::Mmap class for Win32.
<p>
Permission is granted to use this software under the same terms as Perl itself.
Refer to the <a href='http://perldoc.perl.org/perlartistic.html'>Perl Artistic License</a>
for details.


<p>

<dl>

<dt><b>Author:</b></dt>
	<dd>D. Arnold</dd>

<dt><b>Version:</b></dt>
	<dd>0.11</dd>

<dt><b>Since:</b></dt>
	<dd>2006-05-01
</dd>

<p>
<i>Unless otherwise noted, <code>$self
</code> is the object instance variable.</i>
<p>
<table border=1 cellpadding=3 cellspacing=0 width='100%'>
<tr bgcolor='#9800B500EB00'><th align=left><font size='+2'>Constructor Summary</font></th></tr>

<tr><td align=left valign=top>
<code><a href='#IPC::Mmap::Win32'>new</a>($filename, $length, $protflags, $mmapflags)</code>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mmap()'s using Win32::MMF::UseNameSpace,
Win32::MMF::ClaimNameSpace, Win32::MMF::MapViewOfFile,
and Win32::MMF::CreateSemaphore methods
</td></tr>
</table><p>

<table border=1 cellpadding=3 cellspacing=0 width='100%'>
<tr bgcolor='#9800B500EB00'><th align=left><font size='+2'>Method Summary</font></th></tr>

<tr><td align=left valign=top>
<code><a href='#close'>close</a>()</code>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unmap the mmap()ed region
</td></tr>

<tr><td align=left valign=top>
<code><a href='#lock'>lock</a>()</code>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Locks the mmap'ed region
</td></tr>

<tr><td align=left valign=top>
<code><a href='#unlock'>unlock</a>()</code>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unlocks the mmap'ed region
</td></tr>
</table>
<p>

<a name='constructor_detail'></a>
<table border=1 cellpadding=3 cellspacing=0 width='100%'>
<tr bgcolor='#9800B500EB00'>
	<th align=left><font size='+2'>Constructor Details</font></th>
</tr>
</table>

<a name='new'></a>
<h3>new</h3>
<pre>
new($filename, $length, $protflags, $mmapflags)
</pre><p>
<dl>
<dd>mmap()'s using Win32::MMF::UseNameSpace,
Win32::MMF::ClaimNameSpace, Win32::MMF::MapViewOfFile,
and Win32::MMF::CreateSemaphore methods.


<p>
<dd><dl>
<dt><b>Parameters:</b>
<dd><code>$filename</code> - </dd>
<dd><code>$length</code> - optional
</dd>
<dd><code>$protflags</code> - optional
</dd>
<dd><code>$mmapflags</code> - optional

</dd>
<dt><b>Returns:</b><dd>the IPC::Mmap::Win32 object on success; undef on failure
</dd>
</dl></dd></dl><hr>

<p>

<a name='method_detail'></a>
<table border=1 cellpadding=3 cellspacing=0 width='100%'>
<tr bgcolor='#9800B500EB00'>
	<th align=left><font size='+2'>Method Details</font></th>
</tr></table>

<a name='close'></a>
<h3>close</h3>
<pre>
close()
</pre><p>
<dl>
<dd>Unmap the mmap()ed region.

<p>
<dd><dl>
</dl></dd></dl><hr>

<a name='lock'></a>
<h3>lock</h3>
<pre>
lock()
</pre><p>
<dl>
<dd>Locks the mmap'ed region. Implemented using Win32::MMF::WaitForSingleObject().
<i>May</i> be sufficient for multithread locking.

<p>
<dd><dl>
</dl></dd></dl><hr>

<a name='unlock'></a>
<h3>unlock</h3>
<pre>
unlock()
</pre><p>
<dl>
<dd>Unlocks the mmap'ed region. Implemented using Win32::MMF::ReleaseSemaphore().

<p>
<dd><dl>
</dl></dd></dl><hr>

<small>
<center>
<i>Generated by psichedoc on Wed May  3 07:40:42 2006</i>
</center>
</small>
</body>
</html>