Home Assistant Unofficial Reference 2024.12.1
homeassistant.util.timeout._GlobalTaskContext Class Reference

Public Member Functions

Self __aenter__ (self)
 
bool|None __aexit__ (self, type[BaseException]|None exc_type, BaseException|None exc_val, TracebackType|None exc_tb)
 
None __init__ (self, TimeoutManager manager, asyncio.Task[Any] task, float timeout, float cool_down)
 
None pause (self)
 
None reset (self)
 
_State state (self)
 
None zones_done_signal (self)
 

Private Member Functions

None _cancel_task (self)
 
None _on_timeout (self)
 
None _on_wait (self)
 
None _start_timer (self)
 
None _stop_timer (self)
 

Private Attributes

 _cancelling
 
 _expiration_time
 
 _on_wait_task
 
 _state
 
 _time_left
 
 _timeout_handler
 

Detailed Description

Context manager that tracks a global task.

Definition at line 142 of file timeout.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.util.timeout._GlobalTaskContext.__init__ (   self,
TimeoutManager  manager,
asyncio.Task[Any]  task,
float  timeout,
float  cool_down 
)
Initialize internal timeout context manager.

Definition at line 145 of file timeout.py.

Member Function Documentation

◆ __aenter__()

Self homeassistant.util.timeout._GlobalTaskContext.__aenter__ (   self)

Definition at line 165 of file timeout.py.

◆ __aexit__()

bool | None homeassistant.util.timeout._GlobalTaskContext.__aexit__ (   self,
type[BaseException] | None  exc_type,
BaseException | None  exc_val,
TracebackType | None  exc_tb 
)

Definition at line 175 of file timeout.py.

◆ _cancel_task()

None homeassistant.util.timeout._GlobalTaskContext._cancel_task (   self)
private
Cancel own task.

Definition at line 241 of file timeout.py.

◆ _on_timeout()

None homeassistant.util.timeout._GlobalTaskContext._on_timeout (   self)
private
Process timeout.

Definition at line 230 of file timeout.py.

◆ _on_wait()

None homeassistant.util.timeout._GlobalTaskContext._on_wait (   self)
private
Wait until zones are done.

Definition at line 255 of file timeout.py.

◆ _start_timer()

None homeassistant.util.timeout._GlobalTaskContext._start_timer (   self)
private
Start timeout handler.

Definition at line 209 of file timeout.py.

◆ _stop_timer()

None homeassistant.util.timeout._GlobalTaskContext._stop_timer (   self)
private
Stop zone timer.

Definition at line 219 of file timeout.py.

◆ pause()

None homeassistant.util.timeout._GlobalTaskContext.pause (   self)
Pause timers while it freeze.

Definition at line 247 of file timeout.py.

◆ reset()

None homeassistant.util.timeout._GlobalTaskContext.reset (   self)
Reset timer after freeze.

Definition at line 251 of file timeout.py.

◆ state()

_State homeassistant.util.timeout._GlobalTaskContext.state (   self)
Return state of the Global task.

Definition at line 201 of file timeout.py.

◆ zones_done_signal()

None homeassistant.util.timeout._GlobalTaskContext.zones_done_signal (   self)
Signal that all zones are done.

Definition at line 205 of file timeout.py.

Member Data Documentation

◆ _cancelling

homeassistant.util.timeout._GlobalTaskContext._cancelling
private

Definition at line 163 of file timeout.py.

◆ _expiration_time

homeassistant.util.timeout._GlobalTaskContext._expiration_time
private

Definition at line 214 of file timeout.py.

◆ _on_wait_task

homeassistant.util.timeout._GlobalTaskContext._on_wait_task
private

Definition at line 237 of file timeout.py.

◆ _state

homeassistant.util.timeout._GlobalTaskContext._state
private

Definition at line 168 of file timeout.py.

◆ _time_left

homeassistant.util.timeout._GlobalTaskContext._time_left
private

Definition at line 228 of file timeout.py.

◆ _timeout_handler

homeassistant.util.timeout._GlobalTaskContext._timeout_handler
private

Definition at line 215 of file timeout.py.


The documentation for this class was generated from the following file: