Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.influxdb.InfluxThread Class Reference
Inheritance diagram for homeassistant.components.influxdb.InfluxThread:
[legend]
Collaboration diagram for homeassistant.components.influxdb.InfluxThread:
[legend]

Public Member Functions

def __init__ (self, hass, influx, event_to_json, max_tries)
 
def block_till_done (self)
 
def get_events_json (self)
 
def run (self)
 
def write_to_influxdb (self, json)
 

Static Public Member Functions

def batch_timeout ()
 

Public Attributes

 event_to_json
 
 influx
 
 max_tries
 
 shutdown
 
 write_errors
 

Private Member Functions

def _event_listener (self, event)
 

Detailed Description

A threaded event handler class.

Definition at line 510 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.influxdb.InfluxThread.__init__ (   self,
  hass,
  influx,
  event_to_json,
  max_tries 
)
Initialize the listener.

Definition at line 513 of file __init__.py.

Member Function Documentation

◆ _event_listener()

def homeassistant.components.influxdb.InfluxThread._event_listener (   self,
  event 
)
private
Listen for new messages on the bus and queue them for Influx.

Definition at line 527 of file __init__.py.

◆ batch_timeout()

def homeassistant.components.influxdb.InfluxThread.batch_timeout ( )
static
Return number of seconds to wait for more events.

Definition at line 533 of file __init__.py.

◆ block_till_done()

def homeassistant.components.influxdb.InfluxThread.block_till_done (   self)
Block till all events processed.

Currently only used for testing.

Definition at line 601 of file __init__.py.

◆ get_events_json()

def homeassistant.components.influxdb.InfluxThread.get_events_json (   self)
Return a batch of events formatted for writing.

Definition at line 537 of file __init__.py.

◆ run()

def homeassistant.components.influxdb.InfluxThread.run (   self)
Process incoming events.

Definition at line 594 of file __init__.py.

◆ write_to_influxdb()

def homeassistant.components.influxdb.InfluxThread.write_to_influxdb (   self,
  json 
)
Write preprocessed events to influxdb, with retry.

Definition at line 571 of file __init__.py.

Member Data Documentation

◆ event_to_json

homeassistant.components.influxdb.InfluxThread.event_to_json

Definition at line 520 of file __init__.py.

◆ influx

homeassistant.components.influxdb.InfluxThread.influx

Definition at line 519 of file __init__.py.

◆ max_tries

homeassistant.components.influxdb.InfluxThread.max_tries

Definition at line 521 of file __init__.py.

◆ shutdown

homeassistant.components.influxdb.InfluxThread.shutdown

Definition at line 523 of file __init__.py.

◆ write_errors

homeassistant.components.influxdb.InfluxThread.write_errors

Definition at line 522 of file __init__.py.


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