crew_class_relay: 'R6' relay class.

In wlandau/crew: A Distributed Worker Launcher Framework

R6 relay class.

Description

R6 class for relay configuration.

Details

See crew_relay().

Active bindings

condition

Main condition variable.

from

Condition variable to relay from.

to

Condition variable to relay to.

Methods

Public methods

• crew_class_relay$validate()

• crew_class_relay$start()

• crew_class_relay$terminate()

• crew_class_relay$set_from()

• crew_class_relay$set_to()

• crew_class_relay$wait()

---

Method validate()

Validate the object.

Usage

crew_class_relay$validate()

Returns

NULL (invisibly).

---

Method start()

Start the relay object.

Usage

crew_class_relay$start()

Returns

NULL (invisibly).

---

Method terminate()

Terminate the relay object.

Usage

crew_class_relay$terminate()

Returns

NULL (invisibly).

---

Method set_from()

Set the condition variable to relay from.

Usage

crew_class_relay$set_from(from)

Arguments

from

Condition variable to relay from.

Returns

NULL (invisibly).

---

Method set_to()

Set the condition variable to relay to.

Usage

crew_class_relay$set_to(to)

Arguments

to

Condition variable to relay to.

Returns

NULL (invisibly).

---

Method wait()

Wait until an unobserved task resolves or the timeout is reached. Use the throttle to determine the waiting time.

Usage

crew_class_relay$wait(throttle)

Arguments

throttle

A crew_throttle() object to orchestrate the wait time intervals.

Returns

NULL (invisibly).

See Also

Other relay: crew_relay()

Examples

crew_relay()

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