homeassistant.components.onvif.event.PullPointManager Class Reference

Public Member Functions
None	__init__ (self, EventManager event_manager)
None	async_cancel_pull_messages (self)
None	async_pause (self)
None	async_resume (self)
None	async_schedule_pull_messages (self, float|None delay=None)
bool	async_start (self)
None	async_stop (self)

Public Attributes
	state

Private Member Functions
None	_async_background_pull_messages_or_reschedule (self, dt.datetime|None _now=None)
None	_async_cancel_and_unsubscribe (self)
None	_async_create_pullpoint_subscription (self)
None	_async_pull_messages (self)
bool	_async_start_pullpoint (self)
None	_async_unsubscribe_pullpoint (self)

Private Attributes
	_cancel_pull_messages
	_device
	_event_manager
	_hass
	_name
	_pull_messages_job
	_pull_messages_task
	_pullpoint_manager

Detailed Description

ONVIF PullPoint Manager.

If the camera supports webhooks and the webhook is reachable, the pullpoint
manager will keep the pull point subscription alive, but will not poll for
messages unless the webhook fails.

Definition at line 227 of file event.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.onvif.event.PullPointManager.__init__	(		self,
		EventManager	event_manager
	)

Initialize pullpoint manager.

Definition at line 235 of file event.py.

Member Function Documentation

_async_background_pull_messages_or_reschedule()

None homeassistant.components.onvif.event.PullPointManager._async_background_pull_messages_or_reschedule (   self, dt.datetime | None   _now = None  )

private

Pull messages from device in the background.

Definition at line 454 of file event.py.

_async_cancel_and_unsubscribe()

None homeassistant.components.onvif.event.PullPointManager._async_cancel_and_unsubscribe (   self )

private

Cancel and unsubscribe from PullPoint.

Definition at line 307 of file event.py.

_async_create_pullpoint_subscription()

None homeassistant.components.onvif.event.PullPointManager._async_create_pullpoint_subscription (   self )

private

Create pullpoint subscription.

Definition at line 315 of file event.py.

_async_pull_messages()

None homeassistant.components.onvif.event.PullPointManager._async_pull_messages (   self )

private

Pull messages from device.

Definition at line 340 of file event.py.

_async_start_pullpoint()

bool homeassistant.components.onvif.event.PullPointManager._async_start_pullpoint (   self )

private

Start pullpoint subscription.

Definition at line 294 of file event.py.

_async_unsubscribe_pullpoint()

None homeassistant.components.onvif.event.PullPointManager._async_unsubscribe_pullpoint (   self )

private

Unsubscribe the pullpoint subscription.

Definition at line 322 of file event.py.

async_cancel_pull_messages()

None homeassistant.components.onvif.event.PullPointManager.async_cancel_pull_messages

(

self

)

Cancel the PullPoint task.

Definition at line 430 of file event.py.

async_pause()

None homeassistant.components.onvif.event.PullPointManager.async_pause

(

self

)

Pause pullpoint subscription.

Definition at line 267 of file event.py.

async_resume()

None homeassistant.components.onvif.event.PullPointManager.async_resume

(

self

)

Resume pullpoint subscription.

Definition at line 281 of file event.py.

async_schedule_pull_messages()

None homeassistant.components.onvif.event.PullPointManager.async_schedule_pull_messages	(		self,
		float | None	delay = None
	)

Schedule async_pull_messages to run.

Used as fallback when webhook is not working.

Must not check if the webhook is working.

Definition at line 437 of file event.py.

async_start()

bool homeassistant.components.onvif.event.PullPointManager.async_start

(

self

)

Start pullpoint subscription.

Definition at line 253 of file event.py.

async_stop()

None homeassistant.components.onvif.event.PullPointManager.async_stop

(

self

)

Unsubscribe from PullPoint and cancel callbacks.

Definition at line 289 of file event.py.

Member Data Documentation

_cancel_pull_messages

homeassistant.components.onvif.event.PullPointManager._cancel_pull_messages

private

Definition at line 434 of file event.py.

_device

homeassistant.components.onvif.event.PullPointManager._device

private

Definition at line 240 of file event.py.

_event_manager

homeassistant.components.onvif.event.PullPointManager._event_manager

private

Definition at line 239 of file event.py.

_hass

homeassistant.components.onvif.event.PullPointManager._hass

private

Definition at line 241 of file event.py.

_name

homeassistant.components.onvif.event.PullPointManager._name

private

Definition at line 242 of file event.py.

_pull_messages_job

homeassistant.components.onvif.event.PullPointManager._pull_messages_job

private

Definition at line 247 of file event.py.

_pull_messages_task

homeassistant.components.onvif.event.PullPointManager._pull_messages_task

private

Definition at line 465 of file event.py.

_pullpoint_manager

homeassistant.components.onvif.event.PullPointManager._pullpoint_manager

private

Definition at line 317 of file event.py.

state

homeassistant.components.onvif.event.PullPointManager.state

Definition at line 237 of file event.py.

---

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

• core/homeassistant/components/onvif/event.py