xref: /onnv-gate/usr/src/cmd/perl/contrib/Sun/Solaris/Task/pod/Task.pod (revision 12388:1bc8d55b0dfd)
10Sstevel@tonic-gate#
2*12388SJohn.Sonnenschein@Sun.COM# Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
30Sstevel@tonic-gate#
4*12388SJohn.Sonnenschein@Sun.COM
50Sstevel@tonic-gate#
60Sstevel@tonic-gate# Sun::Solaris::Task documentation.
70Sstevel@tonic-gate#
80Sstevel@tonic-gate
90Sstevel@tonic-gate=head1 NAME
100Sstevel@tonic-gate
110Sstevel@tonic-gateSun::Solaris::Task - Perl interface to Tasks
120Sstevel@tonic-gate
130Sstevel@tonic-gate=head1 SYNOPSIS
140Sstevel@tonic-gate
150Sstevel@tonic-gate use Sun::Solaris::Task qw(:ALL);
160Sstevel@tonic-gate my $taskid = gettaskid();
170Sstevel@tonic-gate
180Sstevel@tonic-gateThis module provides wrappers for the C<gettaskid(2)> and C<settaskid(2)>
190Sstevel@tonic-gatesystem calls.
200Sstevel@tonic-gate
210Sstevel@tonic-gate=head2 Constants
220Sstevel@tonic-gate
230Sstevel@tonic-gateC<TASK_NORMAL>, C<TASK_FINAL>.
240Sstevel@tonic-gate
250Sstevel@tonic-gate=head2 Functions
260Sstevel@tonic-gate
270Sstevel@tonic-gateB<C<settaskid($project, $flags)>>
280Sstevel@tonic-gate
290Sstevel@tonic-gateThe C<$project> parameter must be a valid project ID and the C<$flags>
300Sstevel@tonic-gateparameter must be C<TASK_NORMAL> or C<TASK_FINAL>. The parameters are passed
310Sstevel@tonic-gatethrough directly to the underlying C<settaskid()> system call. The new task ID
320Sstevel@tonic-gateis returned if the call succeeds. On failure -1 is returned.
330Sstevel@tonic-gate
340Sstevel@tonic-gateC<gettaskid()>
350Sstevel@tonic-gate
360Sstevel@tonic-gateThis function returns the numeric task ID of the calling process, or C<undef>
370Sstevel@tonic-gateif the underlying C<gettaskid()> system call is unsuccessful.
380Sstevel@tonic-gate
390Sstevel@tonic-gate=head2 Class methods
400Sstevel@tonic-gate
410Sstevel@tonic-gateNone.
420Sstevel@tonic-gate
430Sstevel@tonic-gate=head2 Object methods
440Sstevel@tonic-gate
450Sstevel@tonic-gateNone.
460Sstevel@tonic-gate
470Sstevel@tonic-gate=head2 Exports
480Sstevel@tonic-gate
490Sstevel@tonic-gateBy default nothing is exported from this module. The following tags can be
500Sstevel@tonic-gateused to selectively import constants and functions defined in this module:
510Sstevel@tonic-gate
520Sstevel@tonic-gate :SYSCALLS    settaskid() and gettaskid()
530Sstevel@tonic-gate
540Sstevel@tonic-gate :CONSTANTS   TASK_NORMAL and TASK_FINAL
550Sstevel@tonic-gate
560Sstevel@tonic-gate :ALL         :SYSCALLS and :CONSTANTS
570Sstevel@tonic-gate
580Sstevel@tonic-gate=head1 ATTRIBUTES
590Sstevel@tonic-gate
600Sstevel@tonic-gateSee C<attributes(5)> for descriptions of the following attributes:
610Sstevel@tonic-gate
620Sstevel@tonic-gate  ___________________________________________________________
630Sstevel@tonic-gate |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
640Sstevel@tonic-gate |_____________________________|_____________________________|
650Sstevel@tonic-gate | Availability                | CPAN (http://www.cpan.org)  |
660Sstevel@tonic-gate |_____________________________|_____________________________|
670Sstevel@tonic-gate | Interface Stability         | Evolving                    |
680Sstevel@tonic-gate |_____________________________|_____________________________|
690Sstevel@tonic-gate
700Sstevel@tonic-gate=head1 SEE ALSO
710Sstevel@tonic-gate
720Sstevel@tonic-gateC<gettaskid(2)>, C<settaskid(2)>, C<attributes(5)>
73