Rename function -> capacity()

Author: shikokuchuo

NAMESPACE

@@ -28,12 +28,12 @@ export(.flat)
 export(.progress)
 export(.stop)
 export(call_mirai)
+export(capacity)
 export(cluster_config)
 export(collect_mirai)
 export(daemon)
 export(daemons)
 export(daemons_set)
-export(dispatcher_capacity)
 export(everywhere)
 export(host_url)
 export(http_config)

NEWS.md

@@ -5,7 +5,7 @@
 * Dispatcher reimplemented as a thread for lower overhead, removing the separate dispatcher process (#581). 
 * Adds `capacity` argument to `daemons()` setting a memory budget (MB, metric) for queued task payloads at dispatcher, providing memory-based backpressure.
   This is opt-in and `NULL` (default) is unbounded (thanks @t-kalinowski, #454).
-* Adds `dispatcher_capacity()` to query current and peak queued bytes (in MB) against the `capacity` budget.
+* Adds `capacity()` to query current and peak queued bytes (in MB) against the `capacity` budget.
 * Adds `try_mirai()`, a non-blocking variant of `mirai()` that returns `NULL` immediately if the dispatcher's `capacity` budget is exhausted, instead of blocking.
   Useful in event-loop contexts (Shiny, promises) where blocking the host R thread is unacceptable.
 

R/daemons.R

@@ -83,7 +83,7 @@
 #' argument caps the approximate total memory (MB, metric — 1 MB = 1,000,000
 #' bytes) of queued task payloads at dispatcher. New tasks block until existing
 #' ones are dispatched, providing memory-based backpressure to prevent host
-#' OOM. Current usage is surfaced via [dispatcher_capacity()].
+#' OOM. Current usage is surfaced via [capacity()].
 #' Dispatcher also enables (i) mirai cancellation using [stop_mirai()] or a
 #' `.timeout` argument to [mirai()], and (ii) custom serialization
 #' configurations.
@@ -373,7 +373,7 @@ status <- function(.compute = NULL) {
   list(connections = as.integer(stat(envir[["sock"]], "pipes")), daemons = envir[["url"]])
 }
 
-#' Dispatcher Capacity
+#' Capacity
 #'
 #' Retrieve the approximate current and peak memory used by queued task
 #' payloads at dispatcher, in MB (metric, 1 MB = 1,000,000 bytes), to monitor
@@ -389,13 +389,13 @@ status <- function(.compute = NULL) {
 #' @examplesIf interactive()
 #' daemons(1, capacity = 100)
 #' m <- mirai(Sys.sleep(0.5))
-#' dispatcher_capacity()
+#' capacity()
 #' m[]
 #' daemons(0)
 #'
 #' @export
 #'
-dispatcher_capacity <- function(.compute = NULL) {
+capacity <- function(.compute = NULL) {
   envir <- compute_env(.compute)
   (is.null(envir) || is.null(envir[["dispatcher"]])) && return()
   .dispatcher_capacity(envir[["dispatcher"]])

dev/vignettes/_v01-reference.Rmd

@@ -207,7 +207,7 @@ The default `dispatcher = TRUE` enables optimal FIFO scheduling.
 Tasks queue at the dispatcher and send to daemons as they become available.
 The `capacity` argument caps the approximate total memory (MB, metric — 1 MB = 1,000,000 bytes) of queued task payloads at dispatcher.
 New tasks block until existing ones are dispatched, providing memory-based backpressure to prevent host OOM.
-Current usage is surfaced via the `dispatcher_capacity()` accessor (returns MB, matching the `capacity` unit).
+Current usage is surfaced via the `capacity()` accessor (returns MB, matching the `capacity` unit).
 It also enables mirai cancellation via `stop_mirai()` or the `.timeout` argument to `mirai()`.
 
 `info()` provides current statistics as an integer vector:

man/dispatcher_capacity.Rd man/capacity.Rdman/dispatcher_capacity.Rd renamed to man/capacity.Rd

@@ -39,7 +39,7 @@ reference:
 - title: Compute Profiles
   contents:
   - info
-  - dispatcher_capacity
+  - capacity
   - daemons_set
   - require_daemons
   - with_daemons

man/daemons.Rd

@@ -360,14 +360,14 @@ connection && NOT_CRAN && {
 }
 # capacity tests
 connection && NOT_CRAN && {
-  # dispatcher_capacity() returns NULL when no profile / no dispatcher
-  test_null(dispatcher_capacity())
+  # capacity() returns NULL when no profile / no dispatcher
+  test_null(capacity())
   test_true(daemons(1, dispatcher = FALSE))
-  test_null(dispatcher_capacity())
+  test_null(capacity())
   test_false(daemons(0L))
   # Unlimited: capacity = NULL → used/peak zero, capacity reported as NA
   test_true(daemons(1, capacity = NULL))
-  qs <- dispatcher_capacity()
+  qs <- capacity()
   test_type("double", qs)
   test_equal(length(qs), 3L)
   test_zero(qs[["used"]])
@@ -378,30 +378,30 @@ connection && NOT_CRAN && {
   for (cap in list(0, -1, NA_real_, Inf)) {
     test_true(daemons(1, capacity = cap))
     test_equal(collect_mirai(mirai(1L + 1L)), 2L)
-    test_identical(dispatcher_capacity()[["capacity"]], NA_real_)
+    test_identical(capacity()[["capacity"]], NA_real_)
     test_false(daemons(0L))
   }
   # Queue accumulates with no daemon connected; peak retained after drain.
   # Verifying via peak (monotonic high-watermark) after drain is robust to
   # cross-thread visibility latency in queue accounting.
   test_true(daemons(url = local_url(), capacity = 1))
   m1 <- mirai(Sys.sleep(0.1))
-  while (dispatcher_capacity()[["used"]] == 0) Sys.sleep(0.05)
+  while (capacity()[["used"]] == 0) Sys.sleep(0.05)
   launch_local(1L)
   test_null(call_mirai(m1)$data)
-  while (dispatcher_capacity()[["used"]] > 0) Sys.sleep(0.05)
-  qs <- dispatcher_capacity()
+  while (capacity()[["used"]] > 0) Sys.sleep(0.05)
+  qs <- capacity()
   test_zero(qs[["used"]])
   test_true(qs[["peak"]] > 0)
   test_equal(qs[["capacity"]], 1)
   test_false(daemons(0L))
   # Cancel clears used bytes; peak still reflects prior occupancy.
   test_true(daemons(url = local_url(), capacity = 1))
   m <- mirai(Sys.sleep(0.1))
-  while (dispatcher_capacity()[["used"]] == 0) Sys.sleep(0.05)
+  while (capacity()[["used"]] == 0) Sys.sleep(0.05)
   test_true(stop_mirai(m))
-  while (dispatcher_capacity()[["used"]] > 0) Sys.sleep(0.05)
-  qs <- dispatcher_capacity()
+  while (capacity()[["used"]] > 0) Sys.sleep(0.05)
+  qs <- capacity()
   test_zero(qs[["used"]])
   test_true(qs[["peak"]] > 0)
   test_false(daemons(0L))

pkgdown/_pkgdown.yml

@@ -226,7 +226,7 @@ The default `dispatcher = TRUE` enables optimal FIFO scheduling.
 Tasks queue at the dispatcher and send to daemons as they become available.
 The `capacity` argument caps the approximate total memory (MB, metric — 1 MB = 1,000,000 bytes) of queued task payloads at dispatcher.
 New tasks block until existing ones are dispatched, providing memory-based backpressure to prevent host OOM.
-Current usage is surfaced via the `dispatcher_capacity()` accessor (returns MB, matching the `capacity` unit).
+Current usage is surfaced via the `capacity()` accessor (returns MB, matching the `capacity` unit).
 It also enables mirai cancellation via `stop_mirai()` or the `.timeout` argument to `mirai()`.
 
 `info()` provides current statistics as an integer vector: