File: pvm_bufinfo.man

package info (click to toggle)
scilab 2.6-4
  • links: PTS
  • area: non-free
  • in suites: woody
  • size: 54,632 kB
  • ctags: 40,267
  • sloc: ansic: 267,851; fortran: 166,549; sh: 10,005; makefile: 4,119; tcl: 1,070; cpp: 233; csh: 143; asm: 135; perl: 130; java: 39
file content (41 lines) | stat: -rw-r--r-- 1,281 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.TH pvm_bufinfo 1 "May 1998" "Scilab // Group" "Scilab function"
.so ../sci.an
.SH NAME
pvm_bufinfo - Returns information about a message buffer.
.SH CALLING SEQUENCE
.nf
[bytes, msgtag, tid, info] = pvm_bufinfo(bufid)
.fi
.SH PARAMETERS
.TP 5
bufid  :   integer, specifying   a  particular  message buffer
identifier.
.TP 5
bytes : integer, size of the message in bytes  (non very useful inside
scilab).
.TP 4
msgtag : integer,  label of the  message.  Useful when the message was
received with a wildcard msgtag.
.TP 6
tid : integer, task ID of the source of the message.
.TP 6
info : integer, status code returned by  the routine. Values less than
zero indicate an error.

.SH DESCRIPTION
\fVpvm_bufinfo\fR returns information   about  the requested   message
buffer.  Typically it is  used   to determine  facts  about the   last
received   message  such  as   its size  or   source.  pvm_bufinfo  is
especially useful when an application is  able to receive any incoming
message, and the action taken depends on the source tid and the msgtag
associated  with the message that comes  in first.   If pvm_bufinfo is
successful, info will be 0.  If some error  occurs then info will be <
0.

.SH EXAMPLE
.nf
[bytes, msgtag, tid, info] = pvm_info(bufid)

.fi
.SH SEE ALSO
pvm_recv