17c478bd9Sstevel@tonic-gate#
2c227543fSJohn Sonnenschein# Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
37c478bd9Sstevel@tonic-gate#
4c227543fSJohn Sonnenschein
57c478bd9Sstevel@tonic-gate#
67c478bd9Sstevel@tonic-gate# Sun::Solaris::Task documentation.
77c478bd9Sstevel@tonic-gate#
87c478bd9Sstevel@tonic-gate
97c478bd9Sstevel@tonic-gate=head1 NAME
107c478bd9Sstevel@tonic-gate
117c478bd9Sstevel@tonic-gateSun::Solaris::Task - Perl interface to Tasks
127c478bd9Sstevel@tonic-gate
137c478bd9Sstevel@tonic-gate=head1 SYNOPSIS
147c478bd9Sstevel@tonic-gate
157c478bd9Sstevel@tonic-gate use Sun::Solaris::Task qw(:ALL);
167c478bd9Sstevel@tonic-gate my $taskid = gettaskid();
177c478bd9Sstevel@tonic-gate
187c478bd9Sstevel@tonic-gateThis module provides wrappers for the C<gettaskid(2)> and C<settaskid(2)>
197c478bd9Sstevel@tonic-gatesystem calls.
207c478bd9Sstevel@tonic-gate
217c478bd9Sstevel@tonic-gate=head2 Constants
227c478bd9Sstevel@tonic-gate
237c478bd9Sstevel@tonic-gateC<TASK_NORMAL>, C<TASK_FINAL>.
247c478bd9Sstevel@tonic-gate
257c478bd9Sstevel@tonic-gate=head2 Functions
267c478bd9Sstevel@tonic-gate
277c478bd9Sstevel@tonic-gateB<C<settaskid($project, $flags)>>
287c478bd9Sstevel@tonic-gate
297c478bd9Sstevel@tonic-gateThe C<$project> parameter must be a valid project ID and the C<$flags>
307c478bd9Sstevel@tonic-gateparameter must be C<TASK_NORMAL> or C<TASK_FINAL>. The parameters are passed
317c478bd9Sstevel@tonic-gatethrough directly to the underlying C<settaskid()> system call. The new task ID
327c478bd9Sstevel@tonic-gateis returned if the call succeeds. On failure -1 is returned.
337c478bd9Sstevel@tonic-gate
347c478bd9Sstevel@tonic-gateC<gettaskid()>
357c478bd9Sstevel@tonic-gate
367c478bd9Sstevel@tonic-gateThis function returns the numeric task ID of the calling process, or C<undef>
377c478bd9Sstevel@tonic-gateif the underlying C<gettaskid()> system call is unsuccessful.
387c478bd9Sstevel@tonic-gate
397c478bd9Sstevel@tonic-gate=head2 Class methods
407c478bd9Sstevel@tonic-gate
417c478bd9Sstevel@tonic-gateNone.
427c478bd9Sstevel@tonic-gate
437c478bd9Sstevel@tonic-gate=head2 Object methods
447c478bd9Sstevel@tonic-gate
457c478bd9Sstevel@tonic-gateNone.
467c478bd9Sstevel@tonic-gate
477c478bd9Sstevel@tonic-gate=head2 Exports
487c478bd9Sstevel@tonic-gate
497c478bd9Sstevel@tonic-gateBy default nothing is exported from this module. The following tags can be
507c478bd9Sstevel@tonic-gateused to selectively import constants and functions defined in this module:
517c478bd9Sstevel@tonic-gate
527c478bd9Sstevel@tonic-gate :SYSCALLS    settaskid() and gettaskid()
537c478bd9Sstevel@tonic-gate
547c478bd9Sstevel@tonic-gate :CONSTANTS   TASK_NORMAL and TASK_FINAL
557c478bd9Sstevel@tonic-gate
567c478bd9Sstevel@tonic-gate :ALL         :SYSCALLS and :CONSTANTS
577c478bd9Sstevel@tonic-gate
587c478bd9Sstevel@tonic-gate=head1 ATTRIBUTES
597c478bd9Sstevel@tonic-gate
60*bbf21555SRichard LoweSee C<attributes(7)> for descriptions of the following attributes:
617c478bd9Sstevel@tonic-gate
627c478bd9Sstevel@tonic-gate  ___________________________________________________________
637c478bd9Sstevel@tonic-gate |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
647c478bd9Sstevel@tonic-gate |_____________________________|_____________________________|
657c478bd9Sstevel@tonic-gate | Availability                | CPAN (http://www.cpan.org)  |
667c478bd9Sstevel@tonic-gate |_____________________________|_____________________________|
677c478bd9Sstevel@tonic-gate | Interface Stability         | Evolving                    |
687c478bd9Sstevel@tonic-gate |_____________________________|_____________________________|
697c478bd9Sstevel@tonic-gate
707c478bd9Sstevel@tonic-gate=head1 SEE ALSO
717c478bd9Sstevel@tonic-gate
72*bbf21555SRichard LoweC<gettaskid(2)>, C<settaskid(2)>, C<attributes(7)>
73