/ 
POSIX-RT-SharedMem-0.05
River stage zero No dependents
/ POSIX::RT::SharedMem

NAME

POSIX::RT::SharedMem - Create/open or unlink POSIX shared memory objects in Perl

VERSION

Version 0.05

SYNOPSIS

use POSIX::RT::SharedMem qw/shared_open/;

shared_open my $map, '/some_file', '>+', size => 1024, perms => oct(777);

FUNCTIONS

shared_open $map, $name, $mode, ...

Map the shared memory object $name into $map. For portable use, a shared memory object should be identified by a name of the form '/somename'; that is, a string consisting of an initial slash, followed by one or more characters, none of which are slashes.

$mode determines the read/write mode. It works the same as in open and map_file.

Beyond that it can take two named arguments:

  • size

    This determines the size of the map. If the map is map has writing permissions and the file is smaller than the given size it will be lengthened. Defaults to the length of the file and fails if it is zero.

  • perms

    This determines the permissions with which the file is created (if $mode is '+>'). Default is 0700.

  • offset

    This determines the offset in the file that is mapped. Default is 0.

Remove the shared memory object $name from the namespace. Note that while the shared memory object can't be opened anymore after this, it doesn't remove the contents until all processes have closed it.

AUTHOR

Leon Timmermans, <leont at cpan.org>

BUGS

Please report any bugs or feature requests to bug-posix-rt-sharedmem at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POSIX-RT-SharedMem. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc POSIX::RT::SharedMem

You can also look for information at:

SEE ALSO

COPYRIGHT & LICENSE

Copyright 2010 Leon Timmermans, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.