xref: /onnv-gate/usr/src/cmd/perl/5.8.4/distrib/ext/attrs/attrs.pm (revision 0:68f95e015346)
1package attrs;
2use XSLoader ();
3
4$VERSION = "1.01";
5
6=head1 NAME
7
8attrs - set/get attributes of a subroutine (deprecated)
9
10=head1 SYNOPSIS
11
12    sub foo {
13        use attrs qw(locked method);
14        ...
15    }
16
17    @a = attrs::get(\&foo);
18
19=head1 DESCRIPTION
20
21NOTE: Use of this pragma is deprecated.  Use the syntax
22
23    sub foo : locked method { }
24
25to declare attributes instead.  See also L<attributes>.
26
27This pragma lets you set and get attributes for subroutines.
28Setting attributes takes place at compile time; trying to set
29invalid attribute names causes a compile-time error. Calling
30C<attrs::get> on a subroutine reference or name returns its list
31of attribute names. Notice that C<attrs::get> is not exported.
32Valid attributes are as follows.
33
34=over 4
35
36=item method
37
38Indicates that the invoking subroutine is a method.
39
40=item locked
41
42Setting this attribute is only meaningful when the subroutine or
43method is to be called by multiple threads. When set on a method
44subroutine (i.e. one marked with the B<method> attribute above),
45perl ensures that any invocation of it implicitly locks its first
46argument before execution. When set on a non-method subroutine,
47perl ensures that a lock is taken on the subroutine itself before
48execution. The semantics of the lock are exactly those of one
49explicitly taken with the C<lock> operator immediately after the
50subroutine is entered.
51
52=back
53
54=cut
55
56XSLoader::load 'attrs', $VERSION;
57
581;
59