rename isForkedChild() to isProcessForkedChild()

avoids a name collision with parallelly::isForkedChild(), which has
slightly different semantics (it detects any forked child, whereas we
detect a fork() occurring after RcppParallel was loaded).

Author: kevinushey

NAMESPACE

@@ -5,6 +5,6 @@ export(LdFlags)
 export(RcppParallel.package.skeleton)
 export(RcppParallelLibs)
 export(defaultNumThreads)
-export(isForkedChild)
+export(isProcessForkedChild)
 export(setThreadOptions)
 export(tbbLibraryPath)

NEWS.md

@@ -1,9 +1,10 @@
 
 ## RcppParallel 6.0.0  (UNRELEASED)
 
-* RcppParallel now provides `isForkedChild()` (R) and
-  `RcppParallel::isForkedChild()` (C++), which return `TRUE` when the current
-  process is a `fork()` of the process in which RcppParallel was loaded.
+* RcppParallel now provides `isProcessForkedChild()` (R) and
+  `RcppParallel::isProcessForkedChild()` (C++), which return `TRUE` when the
+  current process is a `fork()` of the process in which RcppParallel was
+  loaded.
   Packages dispatching parallel work from within `parallel::mclapply()` (or
   similar) should consult this and fall back to a serial path, as TBB does
   not support use after fork. (#243)

R/fork.R

@@ -6,8 +6,8 @@
 #' Intel TBB — the parallel backend used by `parallelFor()` and
 #' `parallelReduce()` — does not support being used in a child process after
 #' `fork()`. Packages that may be invoked from within `parallel::mclapply()`
-#' or similar fork-based parallelism should call `isForkedChild()` and fall
-#' back to a serial code path when it returns `TRUE`.
+#' or similar fork-based parallelism should call `isProcessForkedChild()` and
+#' fall back to a serial code path when it returns `TRUE`.
 #'
 #' On Windows, which has no `fork()`, this always returns `FALSE`.
 #'
@@ -16,11 +16,11 @@
 #' @examples
 #' \dontrun{
 #' library(RcppParallel)
-#' isForkedChild()
-#' parallel::mclapply(1:2, function(i) RcppParallel::isForkedChild())
+#' isProcessForkedChild()
+#' parallel::mclapply(1:2, function(i) RcppParallel::isProcessForkedChild())
 #' }
 #'
 #' @export
-isForkedChild <- function() {
-   .Call("isForkedChild", PACKAGE = "RcppParallel")
+isProcessForkedChild <- function() {
+   .Call("isProcessForkedChild", PACKAGE = "RcppParallel")
 }

inst/include/RcppParallel/Fork.h

@@ -10,7 +10,7 @@ namespace RcppParallel {
 // Intel TBB does not support being used after fork(). Code paths reachable
 // from fork()'d children (for example, via parallel::mclapply) should call
 // this and fall back to a serial implementation when it returns true.
-bool isForkedChild();
+bool isProcessForkedChild();
 
 } // namespace RcppParallel
 

man/isForkedChild.Rd man/isProcessForkedChild.Rdman/isForkedChild.Rd renamed to man/isProcessForkedChild.Rd

@@ -13,12 +13,12 @@ namespace RcppParallel {
 #ifndef _WIN32
 static pid_t s_loadPid = 0;
 
-bool isForkedChild()
+bool isProcessForkedChild()
 {
    return getpid() != s_loadPid;
 }
 #else
-bool isForkedChild()
+bool isProcessForkedChild()
 {
    return false;
 }
@@ -29,15 +29,15 @@ bool isForkedChild()
 /* .Call calls */
 extern "C" SEXP defaultNumThreads();
 
-extern "C" SEXP isForkedChild()
+extern "C" SEXP isProcessForkedChild()
 {
-   int forked = RcppParallel::isForkedChild() ? TRUE : FALSE;
+   int forked = RcppParallel::isProcessForkedChild() ? TRUE : FALSE;
    return Rf_ScalarLogical(forked);
 }
 
 static const R_CallMethodDef CallEntries[] = {
-   {"defaultNumThreads", (DL_FUNC) &defaultNumThreads, 0},
-   {"isForkedChild",     (DL_FUNC) &isForkedChild,     0},
+   {"defaultNumThreads",    (DL_FUNC) &defaultNumThreads,    0},
+   {"isProcessForkedChild", (DL_FUNC) &isProcessForkedChild, 0},
    {NULL, NULL, 0}
 };