This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
more pod patches
[perl5.git] / ext / IPC / SysV / SysV.pm
1 # IPC::SysV.pm
2 #
3 # Copyright (c) 1997 Graham Barr <gbarr@pobox.com>. All rights reserved.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the same terms as Perl itself.
6
7 package IPC::SysV;
8
9 use strict;
10 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $VERSION);
11 use Carp;
12 use Config;
13
14 require Exporter;
15 @ISA = qw(Exporter);
16
17 $VERSION = "1.03";
18
19 @EXPORT_OK = qw(
20         GETALL GETNCNT GETPID GETVAL GETZCNT
21
22         IPC_ALLOC IPC_CREAT IPC_EXCL IPC_GETACL IPC_LOCKED IPC_M
23         IPC_NOERROR IPC_NOWAIT IPC_PRIVATE IPC_R IPC_RMID IPC_SET
24         IPC_SETACL IPC_SETLABEL IPC_STAT IPC_W IPC_WANTED
25
26         MSG_FWAIT MSG_LOCKED MSG_MWAIT MSG_NOERROR MSG_QWAIT
27         MSG_R MSG_RWAIT MSG_STAT MSG_W MSG_WWAIT
28
29         SEM_A SEM_ALLOC SEM_DEST SEM_ERR SEM_ORDER SEM_R SEM_UNDO
30
31         SETALL SETVAL
32
33         SHMLBA
34
35         SHM_A SHM_CLEAR SHM_COPY SHM_DCACHE SHM_DEST SHM_ECACHE
36         SHM_FMAP SHM_ICACHE SHM_INIT SHM_LOCK SHM_LOCKED SHM_MAP
37         SHM_NOSWAP SHM_R SHM_RDONLY SHM_REMOVED SHM_RND SHM_SHARE_MMU
38         SHM_SHATTR SHM_SIZE SHM_UNLOCK SHM_W
39
40         S_IRUSR S_IWUSR S_IRWXU
41         S_IRGRP S_IWGRP S_IRWXG
42         S_IROTH S_IWOTH S_IRWXO
43
44         ftok
45 );
46
47 BOOT_XS: {
48     # If I inherit DynaLoader then I inherit AutoLoader and I DON'T WANT TO
49     require DynaLoader;
50
51     # DynaLoader calls dl_load_flags as a static method.
52     *dl_load_flags = DynaLoader->can('dl_load_flags');
53
54     do {
55         __PACKAGE__->can('bootstrap') || \&DynaLoader::bootstrap
56     }->(__PACKAGE__, $VERSION);
57 }
58
59 1;
60
61 __END__
62
63 =head1 NAME
64
65 IPC::SysV - SysV IPC constants
66
67 =head1 SYNOPSIS
68
69     use IPC::SysV qw(IPC_STAT IPC_PRIVATE);
70
71 =head1 DESCRIPTION
72
73 C<IPC::SysV> defines and conditionally exports all the constants
74 defined in your system include files which are needed by the SysV
75 IPC calls.
76
77 =over 4
78
79 =item ftok( PATH, ID )
80
81 Return a key based on PATH and ID, which can be used as a key for
82 C<msgget>, C<semget> and C<shmget>. See L<ftok>
83
84 =back
85
86 =head1 SEE ALSO
87
88 L<IPC::Msg>, L<IPC::Semaphore>, L<ftok>
89
90 =head1 AUTHORS
91
92 Graham Barr <gbarr@pobox.com>
93 Jarkko Hietaniemi <jhi@iki.fi>
94
95 =head1 COPYRIGHT
96
97 Copyright (c) 1997 Graham Barr. All rights reserved.
98 This program is free software; you can redistribute it and/or modify it
99 under the same terms as Perl itself.
100
101 =cut
102