Skip to contents

Create queue

rrq_controller()
Create rrq controller
rrq_default_controller_set() rrq_default_controller_clear()
Register default controller

Tasks

Creation

rrq_task_create_expr()
Create a task based on an expression
rrq_task_create_call()
Create a task from a call
rrq_task_create_bulk_expr()
Create bulk tasks from an expression
rrq_task_create_bulk_call()
Create bulk tasks from a call
rrq_task_retry()
Retry tasks

Query

rrq_task_data()
Fetch internal task data
rrq_task_exists()
Test if tasks exist
rrq_task_info()
Fetch task information
rrq_task_position()
Find task position in queue
rrq_task_preceeding()
List tasks ahead of a task
rrq_task_result()
Fetch single task result
rrq_task_results()
Get the results of a group of tasks, returning them as a list. See rrq_task_result for getting the result of a single task.
rrq_task_status()
Fetch task statuses
rrq_task_times()
Fetch task times
rrq_task_wait()
Wait for group of tasks
rrq_task_log()
Fetch task logs

Overall status

rrq_task_list()
List all tasks
rrq_task_overview()
High level task overview
rrq_deferred_list()
List deferred tasks
rrq_queue_length()
Queue length
rrq_queue_list()
List queue contents

Destructive operations

rrq_task_cancel()
Cancel a task
rrq_task_delete()
Delete tasks
rrq_queue_remove()
Remove task ids from a queue

Workers

Workers are the processes that execute tasks. You can create, query and control workers with these functions

rrq_worker
rrq queue worker
rrq_worker_config()
Create worker configuration
rrq_worker_config_list()
List worker configurations
rrq_worker_config_read()
Read worker configuration
rrq_worker_config_save()
Save worker configuration
rrq_worker_delete_exited()
Clean up exited workers
rrq_worker_detect_exited()
Detect exited workers
rrq_worker_envir_set() rrq_worker_envir_refresh()
Set worker environment
rrq_worker_exists()
Test if a worker exists
rrq_worker_info()
Worker information
rrq_worker_len()
Number of active workers
rrq_worker_list()
List active workers
rrq_worker_list_exited()
List exited workers
rrq_worker_load()
Report on worker load
rrq_worker_log_tail()
Returns the last (few) elements in the worker log, in a programmatically useful format (see Value).
rrq_worker_process_log()
Read worker process log
rrq_worker_script()
Write worker runner script
rrq_worker_spawn()
Spawn a worker
rrq_worker_status()
Worker statuses
rrq_worker_stop()
Stop workers
rrq_worker_task_id()
Current task id for workers
rrq_worker_wait()
Wait for workers

Messages

The messaging interface, see vignette("messages") for more details

rrq_message_get_response()
Get message response
rrq_message_has_response()
Detect if message has response
rrq_message_response_ids()
Return ids for messages with responses for a particular worker.
rrq_message_send()
Send message to workers
rrq_message_send_and_wait()
Send a message and wait for response

Advanced

rrq_task_progress()
Fetch task progress information
rrq_task_progress_update()
Post task update

Heartbeat

Interact with the optional heartbeat support

rrq_heartbeat
Create a heartbeat instance
rrq_heartbeat_kill()
Kill a process running a heartbeat

Uncategorised

Things yet to organise nicely

object_store
rrq object store
object_store_offload_disk
Disk-based offload
rrq_destroy()
Destroy queue
rrq_envir()
Create simple worker environments