TextFileSource: Reads and writes the queue to a text file

TextFileSourceR Documentation

Reads and writes the queue to a text file

Description

Reads and writes the queue to a text file

Reads and writes the queue to a text file

Details

A wrapper around txtq. This object saves signals and associated objects to and queue, and retrieves them for processing.

Methods

Public methods


Method new()

Creates a TextFileSource

Usage
TextFileSource$new(filePath = tempFileGenerator()())
Arguments
filePath

The path to the file.


Method pop()

removes n items from the source and returns them

Usage
TextFileSource$pop(n = -1)
Arguments
n

The number of records to pop (-1 indicates all available).


Method push()

Adds an item to the source.

Usage
TextFileSource$push(msg, obj)
Arguments
msg

A string indicating the signal.

obj

The object to associate with the signal.


Method destroy()

Cleans up source after use.

Usage
TextFileSource$destroy()

Method clone()

The objects of this class are cloneable with this method.

Usage
TextFileSource$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


ipc documentation built on Feb. 16, 2023, 6:01 p.m.