summaryrefslogtreecommitdiff
path: root/usr/src/cmd/perl/contrib/Sun/Solaris/Task/pod/Task.pod
blob: e96f92ea5ae44e61b16e10ffd02cfd102e193c63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#
# Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
#

#
# Sun::Solaris::Task documentation.
# 

=head1 NAME

Sun::Solaris::Task - Perl interface to Tasks

=head1 SYNOPSIS

 use Sun::Solaris::Task qw(:ALL);
 my $taskid = gettaskid();

This module provides wrappers for the C<gettaskid(2)> and C<settaskid(2)>
system calls.

=head2 Constants

C<TASK_NORMAL>, C<TASK_FINAL>.

=head2 Functions

B<C<settaskid($project, $flags)>>

The C<$project> parameter must be a valid project ID and the C<$flags>
parameter must be C<TASK_NORMAL> or C<TASK_FINAL>. The parameters are passed
through directly to the underlying C<settaskid()> system call. The new task ID
is returned if the call succeeds. On failure -1 is returned.

C<gettaskid()>

This function returns the numeric task ID of the calling process, or C<undef>
if the underlying C<gettaskid()> system call is unsuccessful.

=head2 Class methods

None.

=head2 Object methods

None.

=head2 Exports

By default nothing is exported from this module. The following tags can be
used to selectively import constants and functions defined in this module:

 :SYSCALLS    settaskid() and gettaskid()

 :CONSTANTS   TASK_NORMAL and TASK_FINAL

 :ALL         :SYSCALLS and :CONSTANTS

=head1 ATTRIBUTES

See C<attributes(7)> for descriptions of the following attributes:

  ___________________________________________________________
 |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
 |_____________________________|_____________________________|
 | Availability                | CPAN (http://www.cpan.org)  |
 |_____________________________|_____________________________|
 | Interface Stability         | Evolving                    |
 |_____________________________|_____________________________|

=head1 SEE ALSO

C<gettaskid(2)>, C<settaskid(2)>, C<attributes(7)>