← Back to branch summary

~ubuntu-branches/ubuntu/karmic/scilab/karmic

« back to all changes in this revision

Viewing changes to man/pvm/pvm_mytid.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/pvm/pvm_mytid.man
 
1
.TH pvm_mytid 1 "May 1998" "Scilab // Group" "Scilab function"
 
2
.so ../sci.an
 
3
.SH NAME
 
4
pvm_mytid - returns the \fItid\fR of the calling process.
 
5
.SH CALLING SEQUENCE
 
6
.nf
 
7
[tid] = pvm_mytid()
 
8
.fi
 
9
.SH PARAMETERS
 
10
.TP 5
 
11
tid
 
12
: integer, the task identifier of the calling PVM process.
 
13
Values less than zero indicate an error.
 
14
 
 
15
.SH DESCRIPTION
 
16
\fVpvm_mytid\fR 
 
17
enrolls this process
 
18
into PVM on its first call. It also generates a unique
 
19
.I tid
 
20
if this process was not created by pvm_spawn.
 
21
pvm_mytid returns the
 
22
.I tid
 
23
of the calling process
 
24
and can be called multiple times in an application.
 
25
.PP
 
26
Any PVM system call (not just pvm_mytid) will enroll a task in PVM
 
27
if the task is not enrolled before the call.
 
28
.PP
 
29
The tid is a 32 bit positive integer created by the local pvmd.
 
30
The 32 bits are divided into fields that encode various
 
31
information about this process such as its location in
 
32
the virtual machine (i.e. local pvmd address),
 
33
the CPU number in the case where the process is on
 
34
a multiprocessor, and a process ID field. This information
 
35
is used by PVM and is not expected to be used by applications.
 
36
Applications should not attempt to predict or interpret the tid with
 
37
the exception of calling tidtohost()
 
38
.PP
 
39
If PVM has not been started before an application calls pvm_mytid
 
40
the returned
 
41
.I tid
 
42
will be < 0.
 
43
 
 
44
.SH EXAMPLE
 
45
.nf
 
46
tid = pvm_mytid()
 
47
.fi
 
48
 
 
49
.SH SEE ALSO
 
50
pvm_tidtohost, pvm_parent