exclusive Async locker

o-murphy · Aug 13, 2024 · 50f90d1 · 50f90d1
1 parent a24f5e3
commit 50f90d1
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/aiowialon/api.py b/aiowialon/api.py
@@ -92,7 +92,18 @@ def timeout(self, timeout: float) -> None:
 
     @property
     def session_lock(self) -> Callable:
-        """Decorator to set exclusive session access for long critical operations"""
+        """
+        Decorator to set exclusive session access for long critical operations
+
+        >>> # Example
+        >>> from aiowialon import Wialon
+        >>> wialon = Wialon()
+        >>>
+        >>> @wialon.avl_event_handler()
+        >>> @wialon.session_lock  # exclusive session lock for callback's frame
+        >>> async def unit_event(event: AvlEvent):
+        >>>     await wialon.core_search_item(id=event.data.i, flags=1)
+        """
 
         return self.__exclusive_session_lock.lock
 

diff --git a/examples/aiolock.py b/examples/aiolock.py
@@ -39,7 +39,7 @@ async def register_avl_events(session_login):
 @wialon.avl_event_handler()
 @wialon.session_lock  # exclusive session lock for callback's frame
 async def unit_event(event: AvlEvent):
-    await wialon.core_search_item(id=734455, flags=1)
+    await wialon.core_search_item(id=event.data.i, flags=1)
     print("Handler got event:", event)
     for i in range(5):
         print("Waiting exclusive operation", i, "item:", event.data.i)