usr/src/man/man3perl/Task.3perl

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH TASK 3PERL "Dec 1, 2002"
   7 .SH NAME
   8 Task \- Perl interface to Tasks
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 use Sun::Solaris::Task qw(:ALL);
  13 my $taskid = gettaskid();
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 This module provides wrappers for the \fBgettaskid\fR(2) and \fBsettaskid\fR(2)
  20 system calls.
  21 .SS "Constants"
  22 .sp
  23 .LP
  24 \fBTASK_NORMAL\fR, \fBTASK_FINAL\fR.
  25 .SS "Functions"
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fBsettaskid($project, $flags)\fR\fR
  30 .ad
  31 .sp .6
  32 .RS 4n
  33 The \fB$project\fR parameter must be a valid project ID and the \fB$flags\fR
  34 parameter must be \fBTASK_NORMAL\fR or \fBTASK_FINAL\fR. The parameters are
  35 passed through directly to the underlying \fBsettaskid()\fR system call. The
  36 new task ID is returned if the call succeeds. On failure \(mi1 is returned.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBgettaskid()\fR\fR
  43 .ad
  44 .sp .6
  45 .RS 4n
  46 This function returns the numeric task ID of the calling process, or
  47 \fBundef\fR if the underlying \fBgettaskid()\fR system call is unsuccessful.
  48 .RE
  49
  50 .SS "Class methods"
  51 .sp
  52 .LP
  53 None.
  54 .SS "Object methods"
  55 .sp
  56 .LP
  57 None.
  58 .SS "Exports"
  59 .sp
  60 .LP
  61 By default nothing is exported from this module. The following tags can be used
  62 to selectively import constants and functions defined in this module:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fB:SYSCALLS\fR\fR
  67 .ad
  68 .RS 14n
  69 \fBsettaskid()\fR and \fBgettaskid()\fR
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB:CONSTANTS\fR\fR
  76 .ad
  77 .RS 14n
  78 \fBTASK_NORMAL\fR and \fBTASK_FINAL\fR
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB:ALL\fR\fR
  85 .ad
  86 .RS 14n
  87 \fB:SYSCALLS\fR and \fB:CONSTANTS\fR
  88 .RE
  89
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Evolving
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBgettaskid\fR(2), \fBsettaskid\fR(2), \fBattributes\fR(5)