.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "IPC::SharedMem 3perl"
.TH IPC::SharedMem 3perl "2011-09-19" "perl v5.14.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
IPC::SharedMem \- SysV Shared Memory IPC object class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use IPC::SysV qw(IPC_PRIVATE S_IRUSR S_IWUSR);
\&    use IPC::SharedMem;
\&
\&    $shm = IPC::SharedMem\->new(IPC_PRIVATE, 8, S_IRWXU);
\&
\&    $shm\->write(pack("S", 4711), 2, 2);
\&
\&    $data = $shm\->read(0, 2);
\&
\&    $ds = $shm\->stat;
\&
\&    $shm\->remove;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A class providing an object based interface to SysV \s-1IPC\s0 shared memory.
.SH "METHODS"
.IX Header "METHODS"
.IP "new ( \s-1KEY\s0 , \s-1SIZE\s0 , \s-1FLAGS\s0 )" 4
.IX Item "new ( KEY , SIZE , FLAGS )"
Creates a new shared memory segment associated with \f(CW\*(C`KEY\*(C'\fR. A new
segment is created if
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`KEY\*(C'\fR is equal to \f(CW\*(C`IPC_PRIVATE\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`KEY\*(C'\fR does not already have a shared memory segment associated
with it, and \f(CW\*(C`\f(CIFLAGS\f(CW & IPC_CREAT\*(C'\fR is true.
.RE
.RS 4
.Sp
On creation of a new shared memory segment \f(CW\*(C`FLAGS\*(C'\fR is used to
set the permissions.  Be careful not to set any flags that the
Sys V \s-1IPC\s0 implementation does not allow: in some systems setting
execute bits makes the operations fail.
.RE
.IP "id" 4
.IX Item "id"
Returns the shared memory identifier.
.IP "read ( \s-1POS\s0, \s-1SIZE\s0 )" 4
.IX Item "read ( POS, SIZE )"
Read \f(CW\*(C`SIZE\*(C'\fR bytes from the shared memory segment at \f(CW\*(C`POS\*(C'\fR. Returns
the string read, or \f(CW\*(C`undef\*(C'\fR if there was an error. The return value
becomes tainted. See shmread.
.IP "write ( \s-1STRING\s0, \s-1POS\s0, \s-1SIZE\s0 )" 4
.IX Item "write ( STRING, POS, SIZE )"
Write \f(CW\*(C`SIZE\*(C'\fR bytes to the shared memory segment at \f(CW\*(C`POS\*(C'\fR. Returns
true if successful, or false if there is an error. See shmwrite.
.IP "remove" 4
.IX Item "remove"
Remove the shared memory segment from the system or mark it as
removed as long as any processes are still attached to it.
.IP "is_removed" 4
.IX Item "is_removed"
Returns true if the shared memory segment has been removed or
marked for removal.
.IP "stat" 4
.IX Item "stat"
Returns an object of type \f(CW\*(C`IPC::SharedMem::stat\*(C'\fR which is a sub-class
of \f(CW\*(C`Class::Struct\*(C'\fR. It provides the following fields. For a description
of these fields see you system documentation.
.Sp
.Vb 12
\&    uid
\&    gid
\&    cuid
\&    cgid
\&    mode
\&    segsz
\&    lpid
\&    cpid
\&    nattach
\&    atime
\&    dtime
\&    ctime
.Ve
.IP "attach ( [\s-1FLAG\s0] )" 4
.IX Item "attach ( [FLAG] )"
Permanently attach to the shared memory segment. When a \f(CW\*(C`IPC::SharedMem\*(C'\fR
object is attached, it will use memread and memwrite instead of
shmread and shmwrite for accessing the shared memory segment.
Returns true if successful, or false on error. See shmat.
.IP "detach" 4
.IX Item "detach"
Detach from the shared memory segment that previously has been attached
to. Returns true if successful, or false on error. See shmdt.
.IP "addr" 4
.IX Item "addr"
Returns the address of the shared memory that has been attached to in a
format suitable for use with \f(CW\*(C`pack(\*(AqP\*(Aq)\*(C'\fR. Returns \f(CW\*(C`undef\*(C'\fR if the shared
memory has not been attached.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IPC::SysV, Class::Struct
.SH "AUTHORS"
.IX Header "AUTHORS"
Marcus Holland-Moritz <mhx@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Version 2.x, Copyright (C) 2007\-2010, Marcus Holland-Moritz.
.PP
Version 1.x, Copyright (c) 1997, Graham Barr.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.