R/RedisParam-accessors.R

In mtmorgan/RedisParam: Provide a 'redis' back-end for BiocParallel

## The following line influences file collation order, and thus
## presentation of functions on the help page.

#' @include RedisParam-class.R
NULL

#' @rdname RedisParam-class
#'
#' @description `rpworkers()` determines the number of workers using
#'     `snowWorkers()` if workers are created dynamically, or a fixed
#'     maximum (currently 1000) if workers are listening on a queue.
#'
#' @export
rpworkers <-
    function(is.worker)
{
    stopifnot(is.logical(is.worker), length(is.worker) == 1L)
    if (is.na(is.worker)) {
        snowWorkers()
    } else if (is.worker) {
        1L
    } else {
        ## a large number -- up to 1000 listening on the queue
        1000L
    }
}

#' @rdname RedisParam-class
#'
#' @description `rphost()` reads the host name of the Redis server from
#'     the system environment variable `REDISPARAM_HOST`, if the
#'     variable is not defined, fallback to `REDIS_HOST`. Otherwise
#'     default to `"127.0.0.1"`. `rphost(x)` gives the host name used
#'     by `x`.
#'
#' @export
rphost <-
    function(x)
{
    if (missing(x)) {
        value <- Sys.getenv("REDIS_HOST", "127.0.0.1")
        Sys.getenv("REDISPARAM_HOST", value)
    } else {
        x$hostname
    }
}

#' @rdname RedisParam-class
#'
#' @description `rpport()` reads the port of the Redis server from a
#'     system environment variable `REDISPARAM_PORT`, if the variable
#'     is not defined, fallback to `REDIS_PORT`. Otherwise default to
#'     `6379`. `rpport(x)` gives the port used by `x`.
#'
#' @export
rpport <-
    function(x)
{
    if (missing(x)) {
        value <- Sys.getenv("REDIS_PORT", "6379")
        value <- Sys.getenv("REDISPARAM_PORT", value)
        ## Note that REDIS_PORT like "tcp://10.19.242.166:6379" seems
        ## to come from
        ## https://github.com/docker-library/redis/issues/53, where
        ## 'REDIS_PORT' is set more-or-less accidentally by docker
        port <- as.integer(value)
        if (is.na(port)) {
            fmt <- paste0(
                "The 'REDIS_PORT' or 'REDISPARAM_PORT' environment variable ",
                "cannot be coerced to an integer. The original value was '%s'."
            )
            .error(x, fmt, value)
        }
    } else {
        port <- x$port
    }
    port
}

#' @rdname RedisParam-class
#'
#' @description `rppassword()` reads an (optional) password from the
#'     system environment variable `REDISPARAM_PASSWORD`, if the
#'     variable is not defined, fallback to
#'     `REDIS_PASSWORD`. Otherwise default to `NA_character_` (no
#'     password). `rppassword(x)` gives the password used by `x`.
#'
#' @export
rppassword <-
    function(x)
{
    if (missing(x)) {
        value <- Sys.getenv("REDIS_PASSWORD", NA_character_)
        value <- Sys.getenv("REDISPARAM_PASSWORD", value)
    } else {
        value <- x$password
    }
    if (is.null(value)) {
        NA_character_
    } else {
        value
    }
}

#' @rdname RedisParam-class
#'
#' @export
rpisworker <-
    function(x)
{
    x$is.worker
}