RedisBackend-class: Creating the Redis backend

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

Creating the Redis backend

Description

Creating the Redis backend

Usage

RedisBackend(
  RedisParam = NULL,
  jobname = "myjob",
  host = rphost(),
  port = rpport(),
  password = rppassword(),
  timeout = .Machine$integer.max,
  type = c("manager", "worker"),
  id = NULL,
  log = FALSE,
  redis.log = NULL,
  flushInterval = 5L
)

## S4 method for signature 'RedisBackend'
.recv(worker)

## S4 method for signature 'RedisBackend'
.send(worker, value)

## S4 method for signature 'RedisBackend'
.close(worker)

## S4 method for signature 'RedisBackend'
.send_to(backend, node, value)

## S4 method for signature 'RedisBackend'
.recv_any(backend)

## S4 method for signature 'RedisBackend'
.recv_all(backend)

## S4 method for signature 'RedisBackend'
bpjobname(x)

## S4 method for signature 'RedisBackend'
bpworkers(x)

Arguments

RedisParam	RedisParam, if this argument is not NULL, all the other arguments will be ignored except type.
jobname	character(1) The job name used by the manager and workers to connect.
host	character(1) The host of the Redis server.
port	integer(1) The port of the Redis server.
password	character(1) The password of the redis server.
timeout	integer(1) The waiting time in BLPOP.
type	character(1) The type of the backend (manager or worker?).
id	character(1) The manager/worker ID. If not given by the user and the environment REDISPARAM_ID is not defined, a random ID will be used
log	logical(1) Whether to enable the log
redis.log	logical(1) Whether to enable the redis server log
flushInterval	numeric(1) The waiting time between two flush operation.

Value

RedisBackend() returns an object of class RedisBackend. This object is not useful to the end user.

mtmorgan/RedisParam documentation built on July 22, 2023, 6:27 a.m.