crew_class_queue: 'R6' queue class

In wlandau/crew: A Distributed Worker Launcher Framework

R6 queue class

Description

R6 class for a queue of resolved task names.

Details

See crew_queue().

Active bindings

names

Names of resolved tasks.

head

Non-negative integer pointing to the location of the next name to pop.

Methods

Public methods

• crew_class_queue$validate()

• crew_class_queue$reset()

• crew_class_queue$set()

• crew_class_queue$pop()

• crew_class_queue$collect()

• crew_class_queue$empty()

• crew_class_queue$nonempty()

• crew_class_queue$popped()

---

Method validate()

Validate the queue.

Usage

crew_class_queue$validate()

Returns

NULL (invisibly). Called for its side effects.

---

Method reset()

Reset the queue.

Usage

crew_class_queue$reset()

Returns

NULL (invisibly). Called for its side effects.

---

Method set()

Set the names in the queue.

Usage

crew_class_queue$set(names = character(0L))

Arguments

names

Character vector of names to set.

Returns

NULL (invisibly). Called for its side effects.

---

Method pop()

Pop a name off the queue.

Usage

crew_class_queue$pop()

Returns

Character string, a name popped off the queue. NULL if there are no more names available to pop.

---

Method collect()

Remove and return all available names off the queue.

Usage

crew_class_queue$collect()

Returns

Character vector, names collected from the queue. NULL if there are no more names available to collect.

---

Method empty()

Report if the queue is empty.

Usage

crew_class_queue$empty()

Returns

TRUE if the queue is empty, FALSE otherwise.

---

Method nonempty()

Report if the queue is nonempty.

Usage

crew_class_queue$nonempty()

Returns

TRUE if the queue is nonempty, FALSE otherwise.

---

Method popped()

List the names already popped.

Usage

crew_class_queue$popped()

Details

set(), reset(), and collect() remove these names.

Returns

Character vector of names already popped.

See Also

Other queue: crew_queue()

Examples

crew_queue()

wlandau/crew documentation built on Feb. 8, 2025, 10:12 a.m.