← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/pvm/pvm_probe.cat

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/pvm/pvm_probe.cat
1
 
pvm_probe         Scilab // Group         Scilab function         pvm_probe
2
 
NAME
3
 
   pvm_probe - Check if message has arrived.
4
 
  
5
 
CALLING SEQUENCE
6
 
 [buffid] = pvm_probe(tid, msgtag)
7
 
PARAMETERS
8
 
 tid   : integer, task identifier of sending process supplied by the user.
9
 
       
10
 
 msgtag : integer, message tag supplied by the user.  msgtag should be
11
 
        >= 0.
12
 
       
13
 
 buffid
14
 
        : integer, returning  the  value  of  the  new  active             
15
 
       receive  buffer  identifier.   Values less than zero             
16
 
       indicate an error. 
17
 
       
18
 
DESCRIPTION
19
 
   pvm_probe  checks to see if a message with  label      msgtag  has 
20
 
  arrived  from  tid.  If  a matching message has      arrived pvm_probe
21
 
  returns a buffer identifier in bufid. This      bufid  can be used in a
22
 
  pvm_bufinfo call to determine infor-      mation about the message such
23
 
  as its source and length.       If the requested message has  not 
24
 
  arrived,  then  pvm_probe      returns  with  a 0 in bufid. If some error
25
 
  occurs bufid will      be < 0.       A -1 in msgtag or tid matches 
26
 
  anything.   This  allows  the      user  the  following  options.   If 
27
 
  tid  = -1 and msgtag is      defined by the user, then pvm_probe will 
28
 
  accept  a  message      from  any  process which has a matching msgtag. 
29
 
  If msgtag =      -1 and tid is defined  by  the  user,  then  pvm_probe 
30
 
  will      accept  any message that is sent from process tid.  If tid =   
31
 
    -1 and msgtag = -1, then pvm_probe will accept  any  message      from
32
 
  any process.       pvm_probe can be called multiple times to check if  a 
33
 
  given      message  has  arrived  yet.  After  the message has arrived,  
34
 
     pvm_recv must be called before the message can  be  unpacked      into
35
 
  the user's memory using the unpack routines. 
36
 
  
37
 
EXAMPLE
38
 
 arrived = pvm_probe( tid, msgtag );
39
 
 if (arrived >= 0) then [bytes, msgtag, tid, info] = pvm_info(arrived); end
40
 
SEE ALSO
41
 
   pvm_recv,  pvm_info 
42