EventNotifier: update docstring with single-consumer use case
This commit is contained in:
@@ -14,9 +14,12 @@ from pipecat.utils.sync.base_notifier import BaseNotifier
|
|||||||
class EventNotifier(BaseNotifier):
|
class EventNotifier(BaseNotifier):
|
||||||
"""Event-based notifier using asyncio.Event for task synchronization.
|
"""Event-based notifier using asyncio.Event for task synchronization.
|
||||||
|
|
||||||
Provides a simple notification mechanism where one task can signal
|
Provides a simple single-consumer notification mechanism where one task
|
||||||
an event and other tasks can wait for that event to occur. The event
|
can signal an event and one other task can wait for that event to occur.
|
||||||
is automatically cleared after each wait operation.
|
The event is automatically cleared after each wait operation.
|
||||||
|
|
||||||
|
Note: This notifier supports only a single waiter at a time. If multiple
|
||||||
|
tasks wait concurrently, notifications may be lost.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
|
|||||||
Reference in New Issue
Block a user