homeassistant.components.websocket_api.connection.ActiveConnection Class Reference

Public Member Functions
None	__init__ (self, WebSocketAdapter logger, HomeAssistant hass, Callable[[bytes|str|dict[str, Any]], None] send_message, User user, RefreshToken refresh_token)
str	__repr__ (self)
None	async_handle (self, JsonValueType msg)
None	async_handle_binary (self, int handler_id, bytes payload)
None	async_handle_close (self)
None	async_handle_exception (self, dict[str, Any] msg, Exception err)
tuple[int, Callable[[], None]]	async_register_binary_handler (self, BinaryHandler handler)
Context	context (self, dict[str, Any] msg)
str	get_description (self, web.Request|None request)
None	send_error (self, int msg_id, str code, str message, str|None translation_key=None, str|None translation_domain=None, dict[str, Any]|None translation_placeholders=None)
None	send_event (self, int msg_id, Any|None event=None)
None	send_result (self, int msg_id, Any|None result=None)
None	set_supported_features (self, dict[str, float] features)

Public Attributes
	can_coalesce
	hass
	last_id
	logger
	refresh_token_id
	send_message
	supported_features
	user

Private Member Functions
None	_connect_closed_error (self, bytes|str|dict[str, Any]|Callable[[], str] msg)

Static Private Attributes
tuple	__slots__

Detailed Description

Handle an active websocket client connection.

Definition at line 39 of file connection.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.websocket_api.connection.ActiveConnection.__init__	(		self,
		WebSocketAdapter	logger,
		HomeAssistant	hass,
		Callable[[bytes | str | dict[str, Any]], None]	send_message,
		User	user,
		RefreshToken	refresh_token
	)

Initialize an active connection.

Definition at line 56 of file connection.py.

Member Function Documentation

__repr__()

str homeassistant.components.websocket_api.connection.ActiveConnection.__repr__

(

self

)

Return the representation.

Definition at line 80 of file connection.py.

_connect_closed_error()

None homeassistant.components.websocket_api.connection.ActiveConnection._connect_closed_error (   self, bytes | str | dict[str, Any] | Callable[[], str]   msg  )

private

Send a message when the connection is closed.

Definition at line 260 of file connection.py.

async_handle()

None homeassistant.components.websocket_api.connection.ActiveConnection.async_handle	(		self,
		JsonValueType	msg
	)

Handle a single incoming message.

Definition at line 187 of file connection.py.

async_handle_binary()

None homeassistant.components.websocket_api.connection.ActiveConnection.async_handle_binary	(		self,
		int	handler_id,
		bytes	payload
	)

Handle a single incoming binary message.

Definition at line 167 of file connection.py.

async_handle_close()

None homeassistant.components.websocket_api.connection.ActiveConnection.async_handle_close

(

self

)

Handle closing down connection.

Definition at line 244 of file connection.py.

async_handle_exception()

None homeassistant.components.websocket_api.connection.ActiveConnection.async_handle_exception	(		self,
		dict[str, Any]	msg,
		Exception	err
	)

Handle an exception while processing a handler.

Definition at line 267 of file connection.py.

async_register_binary_handler()

tuple[int, Callable[[], None]] homeassistant.components.websocket_api.connection.ActiveConnection.async_register_binary_handler	(		self,
		BinaryHandler	handler
	)

Register a temporary binary handler for this connection.

Returns a binary handler_id (1 byte) and a callback to unregister the handler.

Definition at line 101 of file connection.py.

context()

Context homeassistant.components.websocket_api.connection.ActiveConnection.context	(		self,
		dict[str, Any]	msg
	)

Return a context.

Definition at line 96 of file connection.py.

get_description()

str homeassistant.components.websocket_api.connection.ActiveConnection.get_description	(		self,
		web.Request | None	request
	)

Return a description of the connection.

Definition at line 89 of file connection.py.

send_error()

None homeassistant.components.websocket_api.connection.ActiveConnection.send_error	(		self,
		int	msg_id,
		str	code,
		str	message,
		str | None	translation_key = None,
		str | None	translation_domain = None,
		dict[str, Any] | None	translation_placeholders = None
	)

Send an error message.

Definition at line 143 of file connection.py.

send_event()

None homeassistant.components.websocket_api.connection.ActiveConnection.send_event	(		self,
		int	msg_id,
		Any | None	event = None
	)

Send a event message.

Definition at line 138 of file connection.py.

send_result()

None homeassistant.components.websocket_api.connection.ActiveConnection.send_result	(		self,
		int	msg_id,
		Any | None	result = None
	)

Send a result message.

Definition at line 133 of file connection.py.

set_supported_features()

None homeassistant.components.websocket_api.connection.ActiveConnection.set_supported_features	(		self,
		dict[str, float]	features
	)

Set supported features.

Definition at line 84 of file connection.py.

Member Data Documentation

__slots__

tuple homeassistant.components.websocket_api.connection.ActiveConnection.__slots__

staticprivate

Initial value:

=  (
        "logger",
        "hass",
        "send_message",
        "user",
        "refresh_token_id",
        "subscriptions",
        "last_id",
        "can_coalesce",
        "supported_features",
        "handlers",
        "binary_handlers",
    )

Definition at line 42 of file connection.py.

can_coalesce

homeassistant.components.websocket_api.connection.ActiveConnection.can_coalesce

Definition at line 72 of file connection.py.

hass

homeassistant.components.websocket_api.connection.ActiveConnection.hass

Definition at line 66 of file connection.py.

last_id

homeassistant.components.websocket_api.connection.ActiveConnection.last_id

Definition at line 71 of file connection.py.

logger

homeassistant.components.websocket_api.connection.ActiveConnection.logger

Definition at line 65 of file connection.py.

refresh_token_id

homeassistant.components.websocket_api.connection.ActiveConnection.refresh_token_id

Definition at line 69 of file connection.py.

send_message

homeassistant.components.websocket_api.connection.ActiveConnection.send_message

Definition at line 67 of file connection.py.

supported_features

homeassistant.components.websocket_api.connection.ActiveConnection.supported_features

Definition at line 86 of file connection.py.

user

homeassistant.components.websocket_api.connection.ActiveConnection.user

Definition at line 68 of file connection.py.

---

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

• core/homeassistant/components/websocket_api/connection.py