| | |
- vcorelib.logging.LoggerMixin(builtins.object)
-
- AsyncTask
class AsyncTask(vcorelib.logging.LoggerMixin) |
| |
AsyncTask(name: str, period_s: float, env: runtimepy.channel.environment.ChannelEnvironment, average_depth: int = 10, max_iterations: int = 0) -> None
A basic implementation of a periodic task.
|
| |
- Method resolution order:
- AsyncTask
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- __init__(self, name: str, period_s: float, env: runtimepy.channel.environment.ChannelEnvironment, average_depth: int = 10, max_iterations: int = 0) -> None
- Initialize this asynchronous task.
- disable(self) -> None
- Disable this task.
- async dispatch(self, *_, **__) -> bool
- Dispatch this task.
- enable(self) -> None
- Enable this task.
- async init(self, *_, **__) -> bool
- Initialize this task.
- init_channels(self, env: runtimepy.channel.environment.ChannelEnvironment) -> None
- Initialize task-specific channels.
- log_metrics(self) -> None
- Log information related to metrics channels.
- reset_metrics(self) -> None
- Reset metrics channel values.
- async run(self, *args, stop_sig: asyncio.locks.Event = None, **kwargs) -> None
- Run this task while it's enabled.
Readonly properties defined here:
- rate_str
- Get this periodic's rate as a string.
Data and other attributes defined here:
- __annotations__ = {}
Methods inherited from vcorelib.logging.LoggerMixin:
- log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
- A simple wrapper.
Data descriptors inherited from vcorelib.logging.LoggerMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
| |