R6_txtq: R6 class for 'txtq' objects

In wlandau/bbqr: A Small Message Queue for Parallel Processes

Description

See the txtq() function for full documentation and usage.

Methods

Public methods

• R6_txtq$new()

• R6_txtq$path()

• R6_txtq$count()

• R6_txtq$total()

• R6_txtq$empty()

• R6_txtq$log()

• R6_txtq$list()

• R6_txtq$pop()

• R6_txtq$push()

• R6_txtq$reset()

• R6_txtq$clean()

• R6_txtq$destroy()

• R6_txtq$validate()

• R6_txtq$import()

• R6_txtq$clone()

---

Method new()

Initialize a txtq.

Usage

R6_txtq$new(path, use_lock_file = TRUE)

Arguments

path

Character string giving the file path of the queue. The txtq() function creates a folder at this path to store the messages.

use_lock_file

Logical, whether to use a lock file for blocking operations. Should only be FALSE in specialized use cases with no parallel computing (for example, when a txtq is used as a database and accessed by only one process.)

---

Method path()

Get the txtq path.

Usage

R6_txtq$path()

---

Method count()

Get the number of messages in the queue.

Usage

R6_txtq$count()

---

Method total()

Get the number of messages in the database.

Usage

R6_txtq$total()

---

Method empty()

Detect whether the txtq is empty.

Usage

R6_txtq$empty()

---

Method log()

List the whole database.

Usage

R6_txtq$log()

---

Method list()

List messages.

Usage

R6_txtq$list(n = -1)

Arguments

n

Number of messages.

---

Method pop()

Pop messages.

Usage

R6_txtq$pop(n = 1)

Arguments

n

Number of messages.

---

Method push()

Push messages.

Usage

R6_txtq$push(title, message)

Arguments

title

Titles of the messages.

message

Contents of the messages.

---

Method reset()

Reset the txtq.

Usage

R6_txtq$reset()

---

Method clean()

Clean the txtq.

Usage

R6_txtq$clean()

---

Method destroy()

Destroy the txtq.

Usage

R6_txtq$destroy()

---

Method validate()

Validate the txtq.

Usage

R6_txtq$validate()

---

Method import()

Import another txtq.

Usage

R6_txtq$import(queue)

Arguments

queue

External txtq to import.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

R6_txtq$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

txtq

wlandau/bbqr documentation built on March 29, 2021, 6:23 p.m.