Home Assistant Unofficial Reference 2024.12.1
homeassistant.util.timeout._ZoneTaskContext 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, _ZoneTimeoutManager zone, asyncio.Task[Any] task, float timeout)
 
None pause (self)
 
None reset (self)
 
_State state (self)
 

Private Member Functions

None _on_timeout (self)
 
None _start_timer (self)
 
None _stop_timer (self)
 

Private Attributes

 _cancelling
 
 _expiration_time
 
 _state
 
 _time_left
 
 _timeout_handler
 

Detailed Description

Context manager that tracks an active task for a zone.

Definition at line 265 of file timeout.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.util.timeout._ZoneTaskContext.__init__ (   self,
_ZoneTimeoutManager  zone,
asyncio.Task[Any]  task,
float  timeout 
)
Initialize internal timeout context manager.

Definition at line 268 of file timeout.py.

Member Function Documentation

◆ __aenter__()

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

Definition at line 289 of file timeout.py.

◆ __aexit__()

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

Definition at line 304 of file timeout.py.

◆ _on_timeout()

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

Definition at line 349 of file timeout.py.

◆ _start_timer()

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

Definition at line 328 of file timeout.py.

◆ _stop_timer()

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

Definition at line 338 of file timeout.py.

◆ pause()

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

Definition at line 359 of file timeout.py.

◆ reset()

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

Definition at line 363 of file timeout.py.

◆ state()

_State homeassistant.util.timeout._ZoneTaskContext.state (   self)
Return state of the Zone task.

Definition at line 285 of file timeout.py.

Member Data Documentation

◆ _cancelling

homeassistant.util.timeout._ZoneTaskContext._cancelling
private

Definition at line 282 of file timeout.py.

◆ _expiration_time

homeassistant.util.timeout._ZoneTaskContext._expiration_time
private

Definition at line 333 of file timeout.py.

◆ _state

homeassistant.util.timeout._ZoneTaskContext._state
private

Definition at line 291 of file timeout.py.

◆ _time_left

homeassistant.util.timeout._ZoneTaskContext._time_left
private

Definition at line 347 of file timeout.py.

◆ _timeout_handler

homeassistant.util.timeout._ZoneTaskContext._timeout_handler
private

Definition at line 334 of file timeout.py.


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