usr/src/cmd/perl/contrib/Sun/Solaris/Task/pod/Task.pod

   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
  11 Sun::Solaris::Task - Perl interface to Tasks
  12
  13 =head1 SYNOPSIS
  14
  15  use Sun::Solaris::Task qw(:ALL);
  16  my $taskid = gettaskid();
  17
  18 This module provides wrappers for the C<gettaskid(2)> and C<settaskid(2)>
  19 system calls.
  20
  21 =head2 Constants
  22
  23 C<TASK_NORMAL>, C<TASK_FINAL>.
  24
  25 =head2 Functions
  26
  27 B<C<settaskid($project, $flags)>>
  28
  29 The C<$project> parameter must be a valid project ID and the C<$flags>
  30 parameter must be C<TASK_NORMAL> or C<TASK_FINAL>. The parameters are passed
  31 through directly to the underlying C<settaskid()> system call. The new task ID
  32 is returned if the call succeeds. On failure -1 is returned.
  33
  34 C<gettaskid()>
  35
  36 This function returns the numeric task ID of the calling process, or C<undef>
  37 if the underlying C<gettaskid()> system call is unsuccessful.
  38
  39 =head2 Class methods
  40
  41 None.
  42
  43 =head2 Object methods
  44
  45 None.
  46
  47 =head2 Exports
  48
  49 By default nothing is exported from this module. The following tags can be
  50 used 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
  60 See 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
  72 C<gettaskid(2)>, C<settaskid(2)>, C<attributes(5)>