See the txtq()
function for full documentation and usage.
new()
Initialize a txtq.
R6_txtq$new(path, use_lock_file = TRUE)
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.)
path()
Get the txtq path.
R6_txtq$path()
count()
Get the number of messages in the queue.
R6_txtq$count()
total()
Get the number of messages in the database.
R6_txtq$total()
empty()
Detect whether the txtq is empty.
R6_txtq$empty()
log()
List the whole database.
R6_txtq$log()
list()
List messages.
R6_txtq$list(n = -1)
n
Number of messages.
pop()
Pop messages.
R6_txtq$pop(n = 1)
n
Number of messages.
push()
Push messages.
R6_txtq$push(title, message)
title
Titles of the messages.
message
Contents of the messages.
reset()
Reset the txtq.
R6_txtq$reset()
clean()
Clean the txtq.
R6_txtq$clean()
destroy()
Destroy the txtq.
R6_txtq$destroy()
validate()
Validate the txtq.
R6_txtq$validate()
import()
Import another txtq.
R6_txtq$import(queue)
queue
External txtq to import.
clone()
The objects of this class are cloneable with this method.
R6_txtq$clone(deep = FALSE)
deep
Whether to make a deep clone.
txtq
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.