crew_class_relay {crew} | R Documentation |
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.
throttle
A
crew_throttle()
object forwait()
.
Methods
Public methods
Method new()
Relay constructor.
Usage
crew_class_relay$new(throttle)
Arguments
throttle
A
crew_throttle()
object.
Returns
A crew_relay()
object.
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()
Returns
NULL
(invisibly).
See Also
Other relay:
crew_relay()
Examples
crew_relay()
[Package crew version 1.2.1 Index]