homeassistant.components.nest.camera.StreamRefresh Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, datetime.datetime expires_at, Callable[[], Awaitable[datetime.datetime|None]] refresh_cb)
None	unsub (self)

Private Member Functions
None	_handle_refresh (self, datetime.datetime _)
None	_schedule_stream_refresh (self, datetime.datetime refresh_time)

Private Attributes
	_hass
	_min_refresh_interval
	_refresh_cb
	_unsub

Detailed Description

Class that will refresh an expiring stream.

This class will schedule an alarm for the next expiration time of a stream.
When the alarm fires, it runs the provided `refresh_cb` to extend the
lifetime of the stream and return a new expiration time.

A simple backoff will be applied when the refresh callback fails.

Definition at line 75 of file camera.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.nest.camera.StreamRefresh.__init__	(		self,
		HomeAssistant	hass,
		datetime.datetime	expires_at,
		Callable[[], Awaitable[datetime.datetime | None]]	refresh_cb
	)

Initialize StreamRefresh.

Definition at line 85 of file camera.py.

Member Function Documentation

_handle_refresh()

None homeassistant.components.nest.camera.StreamRefresh._handle_refresh (   self, datetime.datetime  _  )

private

Alarm that fires to check if the stream should be refreshed.

Definition at line 103 of file camera.py.

_schedule_stream_refresh()

None homeassistant.components.nest.camera.StreamRefresh._schedule_stream_refresh (   self, datetime.datetime  refresh_time  )

private

Schedules an alarm to refresh any streams before expiration.

Definition at line 127 of file camera.py.

unsub()

None homeassistant.components.nest.camera.StreamRefresh.unsub

(

self

)

Invalidates the stream.

Definition at line 98 of file camera.py.

Member Data Documentation

_hass

homeassistant.components.nest.camera.StreamRefresh._hass

private

Definition at line 92 of file camera.py.

_min_refresh_interval

homeassistant.components.nest.camera.StreamRefresh._min_refresh_interval

private

Definition at line 94 of file camera.py.

_refresh_cb

homeassistant.components.nest.camera.StreamRefresh._refresh_cb

private

Definition at line 95 of file camera.py.

_unsub

homeassistant.components.nest.camera.StreamRefresh._unsub

private

Definition at line 105 of file camera.py.

---

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

• core/homeassistant/components/nest/camera.py