File: PVM.freebuf.Rd

package info (click to toggle)
rpvm 1.0.2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 420 kB
  • ctags: 92
  • sloc: ansic: 1,111; sh: 28; makefile: 1
file content (50 lines) | stat: -rw-r--r-- 1,416 bytes parent folder | download | duplicates (4)
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
42
43
44
45
46
47
48
49
50
\name{.PVM.freebuf}
\alias{.PVM.freebuf}
\title{Free message buffer}
\description{
  Disposes of a message buffer.
}
\usage{
.PVM.freebuf (bufid)
}
\arguments{
  \item{bufid}{integer message buffer id}
}
\value{
  Returns 0 if successful or -1 if failed.
}
\details{
  This function frees the memory associated with the message buffer
  identified by \code{bufid}.  Message buffers are created by
  \code{\link{.PVM.mkbuf}}, \code{\link{.PVM.initsend}} and
  \code{\link{.PVM.recv}}.

  \code{\link{.PVM.freebuf}} should be called for a send buffer created
  by \code{\link{.PVM.mkbuf}} after the message has been send and is no
  longer needed.

  Receive buffer typically do not have to be freed unless they have been
  saved in the cources of using multiple buffers.  But
  \code{\link{.PVM.freebuf}} can be used to destroy receive buffers as
  well.  Therefore, messages that arrive but are no longer needed as a
  result of some other event can be destroyed to save buffer space.
}
\references{
  PVM documentation
}
\seealso{
  \code{\link{.PVM.initsend}}, \code{\link{.PVM.mkbuf}},
  \code{\link{.PVM.setrbuf}},  \code{\link{.PVM.recv}} 
}
\examples{
\dontrun{bufid <- .PVM.mkbuf ("Raw")}
## Send the message ...
\dontrun{.PVM.freebuf (bufid)}
}
\author{
  Na (Michael) Li \email{nali@umn.edu} and
  A.J. Rossini \email{rossini@u.washington.edu}
}
\keyword{utilities}
\keyword{connection}
\keyword{interface}