Home Assistant Unofficial Reference 2024.12.1
homeassistant.util.executor.InterruptibleThreadPoolExecutor Class Reference
Inheritance diagram for homeassistant.util.executor.InterruptibleThreadPoolExecutor:
[legend]
Collaboration diagram for homeassistant.util.executor.InterruptibleThreadPoolExecutor:
[legend]

Public Member Functions

None join_threads_or_timeout (self)
 
None shutdown (self, *Any args, bool join_threads_or_timeout=True, **Any kwargs)
 

Detailed Description

A ThreadPoolExecutor instance that will not deadlock on shutdown.

Definition at line 63 of file executor.py.

Member Function Documentation

◆ join_threads_or_timeout()

None homeassistant.util.executor.InterruptibleThreadPoolExecutor.join_threads_or_timeout (   self)
Join threads or timeout.

Definition at line 79 of file executor.py.

◆ shutdown()

None homeassistant.util.executor.InterruptibleThreadPoolExecutor.shutdown (   self,
*Any  args,
bool   join_threads_or_timeout = True,
**Any   kwargs 
)
Shutdown with interrupt support added.

By default shutdown will wait for threads to finish up
to the timeout before forcefully stopping them. This can
be disabled by setting `join_threads_or_timeout` to False.

Definition at line 66 of file executor.py.


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