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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/multicore.R
\name{requestCore}
\alias{requestCore}
\title{Request a core for multicore processing}
\usage{
requestCore(await, workers = availableCores(),
timeout = getOption("future.wait.timeout",
as.numeric(Sys.getenv("R_FUTURE_WAIT_TIMEOUT", 30 * 24 * 60 * 60))),
delta = getOption("future.wait.interval",
as.numeric(Sys.getenv("R_FUTURE_WAIT_INTERVAL", 0.2))),
alpha = getOption("future.wait.alpha",
as.numeric(Sys.getenv("R_FUTURE_WAIT_ALPHA", 1.01))))
}
\arguments{
\item{await}{A function used to try to "collect"
finished multicore subprocesses.}
\item{workers}{Total number of workers available.}
\item{timeout}{Maximum waiting time (in seconds) allowed
before a timeout error is generated.}
\item{delta}{Then base interval (in seconds) to wait
between each try.}
\item{alpha}{A multiplicative factor used to increase
the wait interval after each try.}
}
\value{
Invisible TRUE. If no cores are available after
extensive waiting, then a timeout error is thrown.
}
\description{
If no cores are available, the current process
blocks until a core is available.
}
\keyword{internal}
|