SocketProtocolMixin

Full path: schola.core.protocols.socket_protocol.SocketProtocolMixin

TCP listen socket mixin for advertising the Python host to Unreal.

SocketProtocolMixin(url, port = None, client_only = False)

Bases: BaseProtocolMixin

Parameters

• url (str)

• port (int)

• client_only (bool)

Methods

init

__init__(url, port = None, client_only = False)

Parameters

• url (str)

• port (int)

• client_only (bool)

---

on_close

on_close()

Close the Unreal Connection. Method must be safe to call multiple times.

Returns

Return type: None

---

on_start

on_start()

Bind the tcp_socket to discover a free port (local mode only).

Returns

Return type: None

Attributes

address

address

---

has_socket

has_socket

---

is_started

is_started

Whether on_start has been called (works for both socket and client-only modes).

---

mixin_properties

mixin_properties

Get mixin-specific properties.