xref: /illumos-gate/usr/src/cmd/perl/contrib/Sun/Solaris/Task/pod/Task.pod (revision cd3e933325e68e23516a196a8fea7f49b1e497c3)
1#
2# Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
3#
4
5#
6# Sun::Solaris::Task documentation.
7#
8
9=head1 NAME
10
11Sun::Solaris::Task - Perl interface to Tasks
12
13=head1 SYNOPSIS
14
15 use Sun::Solaris::Task qw(:ALL);
16 my $taskid = gettaskid();
17
18This module provides wrappers for the C<gettaskid(2)> and C<settaskid(2)>
19system calls.
20
21=head2 Constants
22
23C<TASK_NORMAL>, C<TASK_FINAL>.
24
25=head2 Functions
26
27B<C<settaskid($project, $flags)>>
28
29The C<$project> parameter must be a valid project ID and the C<$flags>
30parameter must be C<TASK_NORMAL> or C<TASK_FINAL>. The parameters are passed
31through directly to the underlying C<settaskid()> system call. The new task ID
32is returned if the call succeeds. On failure -1 is returned.
33
34C<gettaskid()>
35
36This function returns the numeric task ID of the calling process, or C<undef>
37if the underlying C<gettaskid()> system call is unsuccessful.
38
39=head2 Class methods
40
41None.
42
43=head2 Object methods
44
45None.
46
47=head2 Exports
48
49By default nothing is exported from this module. The following tags can be
50used to selectively import constants and functions defined in this module:
51
52 :SYSCALLS    settaskid() and gettaskid()
53
54 :CONSTANTS   TASK_NORMAL and TASK_FINAL
55
56 :ALL         :SYSCALLS and :CONSTANTS
57
58=head1 ATTRIBUTES
59
60See C<attributes(5)> for descriptions of the following attributes:
61
62  ___________________________________________________________
63 |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
64 |_____________________________|_____________________________|
65 | Availability                | CPAN (http://www.cpan.org)  |
66 |_____________________________|_____________________________|
67 | Interface Stability         | Evolving                    |
68 |_____________________________|_____________________________|
69
70=head1 SEE ALSO
71
72C<gettaskid(2)>, C<settaskid(2)>, C<attributes(5)>
73