All docs
lsdtools.network reference
Generated public SDK reference for lsdtools.network.
SDK distribution 1.0.0; API contract 1.0; generator 1.0.0.
Product source digest: 4ea39055732e8883c03ccfecf12af6ccebd2041a12ce1b843e4a769e200f5ef9.
Generated from declared public exports and source syntax. Signatures and annotations are declaration spellings; decorators, factories and annotations are never executed. Class members below are declared members; base classes remain explicit. Source docstrings describe their owning implementation; they do not grant app permissions.
Lazy public networking contracts and explicit session/run capabilities.
Importing this facade never loads the native transport or opens a connection.
lsdtools.network.CommandIdentity#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/domain.py:121.
Source docstring:
Host-resolved attribution. Author objects come from the host's identity policy.
Implementation alias: lsd_runtime_network.domain.CommandIdentity.
lsdtools.network.CommandIdentity.actor#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:123.
actor: Any
lsdtools.network.CommandIdentity.executor#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:124.
executor: Any
executor = None
lsdtools.network.CommandIdentity.approver#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:125.
approver: Any
approver = None
lsdtools.network.CommandRequest#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/domain.py:63.
Implementation alias: lsd_runtime_network.domain.CommandRequest.
lsdtools.network.CommandRequest.operation_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:64.
operation_id: str
lsdtools.network.CommandRequest.target#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:65.
target: str
lsdtools.network.CommandRequest.model_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:66.
model_id: str
lsdtools.network.CommandRequest.model_revision#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:67.
model_revision: str
lsdtools.network.CommandRequest.base_revision#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:68.
base_revision: str
lsdtools.network.CommandRequest.intent_json#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/domain.py:69.
intent_json: str
lsdtools.network.CommandRequest.intent#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:89.
intent(self) -> dict
self: (unannotated)
lsdtools.network.CommandRequest.to_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:92.
to_dict(self) -> dict
self: (unannotated)
lsdtools.network.CommandRequest.digest#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:98.
digest(self) -> str
self: (unannotated)
lsdtools.network.CommandRequest.from_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:102.
from_dict(cls, value: Mapping[str, Any]) -> 'CommandRequest'
cls: (unannotated)
value: Mapping[str, Any]
lsdtools.network.CommandRequest.from_bytes#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:111.
from_bytes(cls, value: bytes) -> 'CommandRequest'
cls: (unannotated)
value: bytes
lsdtools.network.ControlMessage#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:23.
Source docstring:
Identity is stamped by the authenticated native transport, never by payload fields.
Implementation alias: lsd_runtime_network.sessions.ControlMessage.
lsdtools.network.ControlMessage.participant_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:25.
participant_id: int
lsdtools.network.ControlMessage.operation_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:26.
operation_id: int
lsdtools.network.ControlMessage.payload#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:27.
payload: bytes
lsdtools.network.DeliveryReceipt#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:81.
Implementation alias: lsd_runtime_network.sessions.DeliveryReceipt.
lsdtools.network.DeliveryReceipt.schema_version#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:82.
schema_version: int
lsdtools.network.DeliveryReceipt.operation_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:83.
operation_id: str
lsdtools.network.DeliveryReceipt.run_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:84.
run_id: str
lsdtools.network.DeliveryReceipt.session_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:85.
session_id: str
lsdtools.network.DeliveryReceipt.channel#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:86.
channel: str
lsdtools.network.DeliveryReceipt.payload_sha256#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:87.
payload_sha256: str
lsdtools.network.DeliveryReceipt.state#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:88.
state: str
lsdtools.network.DeliveryReceipt.sequence#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:89.
sequence: int
lsdtools.network.DeliveryReceipt.recipient_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:90.
recipient_id: int
recipient_id = 0
lsdtools.network.DeliveryReceipt.to_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:92.
to_dict(self)
self: (unannotated)
lsdtools.network.FromNetwork#
Kind: function. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:308.
FromNetwork(*, session_id: str, channel: str, schema_digest: str, lane: str='dataset') -> NetworkPort
channel: str
lane: str
schema_digest: str
session_id: str
Implementation alias: lsd_runtime_network.contracts.FromNetwork.
lsdtools.network.KinematicModel#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:75.
Source docstring:
Explicit compiler-attested controller parameters; no live state or authority.
Applications obtain these values from the same validated simulation as the
plan. Supplying a model does not grant control of its actor.
Implementation alias: lsd_runtime_network.contracts.KinematicModel.
lsdtools.network.KinematicModel.actor_eid#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:81.
actor_eid: int
lsdtools.network.KinematicModel.object_eid#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:82.
object_eid: int
lsdtools.network.KinematicModel.object_spawn_generation#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:83.
object_spawn_generation: int
lsdtools.network.KinematicModel.speed#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:84.
speed: float
lsdtools.network.KinematicModel.axis0#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:85.
axis0: int
lsdtools.network.KinematicModel.axis1#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:86.
axis1: int
lsdtools.network.KinematicModel.invert_second_axis#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:87.
invert_second_axis: bool
invert_second_axis = False
lsdtools.network.NetworkContractError#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:17.
Source docstring:
A network contract is unknown, ambiguous or outside declared limits.
Implementation alias: lsd_runtime_network.contracts.NetworkContractError.
Declared bases: ValueError.
lsdtools.network.NetworkPlan#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:218.
Implementation alias: lsd_runtime_network.contracts.NetworkPlan.
lsdtools.network.NetworkPlan.schema_version#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:219.
schema_version: int
lsdtools.network.NetworkPlan.application_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:220.
application_id: str
lsdtools.network.NetworkPlan.session_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:221.
session_id: str
lsdtools.network.NetworkPlan.role#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:222.
role: str
lsdtools.network.NetworkPlan.profile#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:223.
profile: NetworkProfile
lsdtools.network.NetworkPlan.fields#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:224.
fields: tuple[ReplicationField, ...]
lsdtools.network.NetworkPlan.content_digest#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:225.
content_digest: str
lsdtools.network.NetworkPlan.simulation_digest#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:226.
simulation_digest: str
lsdtools.network.NetworkPlan.to_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:245.
to_dict(self) -> dict
self: (unannotated)
lsdtools.network.NetworkPlan.from_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:252.
from_dict(cls, value: Any) -> NetworkPlan
cls: (unannotated)
value: Any
lsdtools.network.NetworkPlan.semantic_digest#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:262.
semantic_digest(self) -> str
self: (unannotated)
Source docstring:
Common peer compatibility; role-specific artifact identity is separate.
simulation_digest must come from the compiler's complete shared simulation
contract, including schedule, physics parameters and floating-point policy.
A caller-chosen label is not evidence of compatibility.
lsdtools.network.NetworkPlan.fingerprint#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:274.
fingerprint(self) -> str
self: (unannotated)
lsdtools.network.NetworkPort#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:279.
Source docstring:
One finite reliable command/dataset declaration; no live replication lane.
Implementation alias: lsd_runtime_network.contracts.NetworkPort.
lsdtools.network.NetworkPort.schema_version#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:281.
schema_version: int
lsdtools.network.NetworkPort.session_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:282.
session_id: str
lsdtools.network.NetworkPort.channel#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:283.
channel: str
lsdtools.network.NetworkPort.direction#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:284.
direction: str
lsdtools.network.NetworkPort.schema_digest#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:285.
schema_digest: str
lsdtools.network.NetworkPort.lane#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:286.
lane: str
lane = 'dataset'
lsdtools.network.NetworkPort.to_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:296.
to_dict(self) -> dict
self: (unannotated)
lsdtools.network.NetworkPort.from_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:300.
from_dict(cls, value: Any) -> NetworkPort
cls: (unannotated)
value: Any
lsdtools.network.NetworkProfile#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:110.
Implementation alias: lsd_runtime_network.contracts.NetworkProfile.
lsdtools.network.NetworkProfile.name#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:111.
name: str
name = 'shared-physics'
lsdtools.network.NetworkProfile.tick_hz#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:112.
tick_hz: int
tick_hz = 60
lsdtools.network.NetworkProfile.state_hz#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:113.
state_hz: int
state_hz = 20
lsdtools.network.NetworkProfile.max_peers#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:114.
max_peers: int
max_peers = 32
lsdtools.network.NetworkProfile.max_entities#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:115.
max_entities: int
max_entities = 4096
lsdtools.network.NetworkProfile.max_packet_bytes#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:116.
max_packet_bytes: int
max_packet_bytes = 1200
lsdtools.network.NetworkProfile.max_queue_bytes#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:117.
max_queue_bytes: int
max_queue_bytes = 1048576
lsdtools.network.NetworkProfile.max_streams#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:118.
max_streams: int
max_streams = 256
lsdtools.network.NetworkProfile.history_ticks#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:119.
history_ticks: int
history_ticks = 120
lsdtools.network.NetworkProfile.prediction#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:120.
prediction: str
prediction = 'none'
lsdtools.network.NetworkProfile.to_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:135.
to_dict(self) -> dict
self: (unannotated)
lsdtools.network.NetworkProfile.from_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:139.
from_dict(cls, value: Any) -> NetworkProfile
cls: (unannotated)
value: Any
lsdtools.network.NetworkRunBinding#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:467.
NetworkRunBinding(self, manager, run_id, ports, generation, expires, cancelled)
Source docstring:
An explicit live capability. It has no serialized representation.
Implementation alias: lsd_runtime_network.sessions.NetworkRunBinding.
lsdtools.network.NetworkRunBinding.__init__#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:471.
__init__(self, manager, run_id, ports, generation, expires, cancelled)
cancelled: (unannotated)
expires: (unannotated)
generation: (unannotated)
manager: (unannotated)
ports: (unannotated)
run_id: (unannotated)
self: (unannotated)
lsdtools.network.NetworkRunBinding.send#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:488.
send(self, port: NetworkPort, payload: bytes, *, operation_id: str, recipient: int=0) -> DeliveryReceipt
operation_id: str
payload: bytes
port: NetworkPort
recipient: int
self: (unannotated)
lsdtools.network.NetworkRunBinding.receive#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:510.
receive(self, port: NetworkPort) -> bytes | None
port: NetworkPort
self: (unannotated)
lsdtools.network.NetworkRunBinding.receive_record#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:514.
receive_record(self, port: NetworkPort) -> ReceivedMessage | None
port: NetworkPort
self: (unannotated)
Source docstring:
Poll one finite exact payload. No application/commit acknowledgment is inferred.
lsdtools.network.NetworkRunBinding.close#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:520.
close(self)
self: (unannotated)
lsdtools.network.NetworkRunBinding.__enter__#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:530.
__enter__(self)
self: (unannotated)
lsdtools.network.NetworkRunBinding.__exit__#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:533.
__exit__(self, *_)
_: (unannotated)
self: (unannotated)
lsdtools.network.NetworkSources#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/native_sources.py:29.
NetworkSources(self, prepared)
Source docstring:
A selected local prepared bundle, independently reverified at every write.
Implementation alias: lsd_runtime_network.native_sources.NetworkSources.
lsdtools.network.NetworkSources.__init__#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/native_sources.py:31.
__init__(self, prepared)
prepared: (unannotated)
self: (unannotated)
lsdtools.network.NetworkSources.from_checkout#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/native_sources.py:36.
from_checkout(cls, *, prepared=None)
cls: (unannotated)
prepared: (unannotated)
lsdtools.network.NetworkSources.write#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/native_sources.py:92.
write(self, stage)
self: (unannotated)
stage: (unannotated)
lsdtools.network.NetworkSources.root#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/native_sources.py:32.
root: (unannotated)
root = Path(prepared).absolute()
lsdtools.network.NetworkUnavailableError#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:18.
Implementation alias: lsd_runtime_network.sessions.NetworkUnavailableError.
Declared bases: RuntimeError.
lsdtools.network.ReceivedMessage#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:31.
Implementation alias: lsd_runtime_network.sessions.ReceivedMessage.
lsdtools.network.ReceivedMessage.participant_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:32.
participant_id: int
lsdtools.network.ReceivedMessage.transport_operation_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:33.
transport_operation_id: int
lsdtools.network.ReceivedMessage.operation_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:34.
operation_id: str
lsdtools.network.ReceivedMessage.run_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:35.
run_id: str
lsdtools.network.ReceivedMessage.session_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:36.
session_id: str
lsdtools.network.ReceivedMessage.channel#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:37.
channel: str
lsdtools.network.ReceivedMessage.schema_digest#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:38.
schema_digest: str
lsdtools.network.ReceivedMessage.payload_sha256#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:39.
payload_sha256: str
lsdtools.network.ReceivedMessage.payload#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:40.
payload: bytes
lsdtools.network.ReplicationField#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:182.
Implementation alias: lsd_runtime_network.contracts.ReplicationField.
lsdtools.network.ReplicationField.name#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:183.
name: str
lsdtools.network.ReplicationField.component#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:184.
component: str
lsdtools.network.ReplicationField.column#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:185.
column: str
lsdtools.network.ReplicationField.value_type#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:186.
value_type: str
lsdtools.network.ReplicationField.direction#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:187.
direction: str
direction = 'server_to_client'
lsdtools.network.ReplicationField.lane#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:188.
lane: str
lane = 'state'
lsdtools.network.ReplicationField.precision#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:189.
precision: float | None
precision = None
lsdtools.network.ReplicationField.to_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:209.
to_dict(self) -> dict
self: (unannotated)
lsdtools.network.ReplicationField.from_dict#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:213.
from_dict(cls, value: Any) -> ReplicationField
cls: (unannotated)
value: Any
lsdtools.network.RepositoryCommandService#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/domain.py:138.
RepositoryCommandService(self, repo: Any, *, model_id: str, model_revision: str, resolve_identity: Callable[[int], CommandIdentity], authorize: Callable[[CommandIdentity, CommandRequest], bool], stage: Callable[[Any, CommandRequest], None], max_history: int=4096)
Source docstring:
Bounded durable replay over one revisioned domain repository.
``stage(session, request)`` is the trusted owning domain's handler. It must use
public EditSession methods and leave persistence to this coordinator. ``authorize``
is rechecked before execution AND receipt queries. A receipt is acknowledged only
after the commit that contains its domain edits. Retention is bounded explicitly:
exceeding max_history refuses work until a domain-owned archival policy exists.
Implementation alias: lsd_runtime_network.domain.RepositoryCommandService.
lsdtools.network.RepositoryCommandService.__init__#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:148.
__init__(self, repo: Any, *, model_id: str, model_revision: str, resolve_identity: Callable[[int], CommandIdentity], authorize: Callable[[CommandIdentity, CommandRequest], bool], stage: Callable[[Any, CommandRequest], None], max_history: int=4096)
authorize: Callable[[CommandIdentity, CommandRequest], bool]
max_history: int
model_id: str
model_revision: str
repo: Any
resolve_identity: Callable[[int], CommandIdentity]
self: (unannotated)
stage: Callable[[Any, CommandRequest], None]
lsdtools.network.RepositoryCommandService.receipt#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:183.
receipt(self, principal: int, request: CommandRequest) -> dict | None
principal: int
request: CommandRequest
self: (unannotated)
lsdtools.network.RepositoryCommandService.execute#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/domain.py:190.
execute(self, principal: int, request: CommandRequest) -> dict
principal: int
request: CommandRequest
self: (unannotated)
lsdtools.network.SessionConfig#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:44.
Source docstring:
Run-only identity configuration. Never serialize this into a plan or project.
Implementation alias: lsd_runtime_network.sessions.SessionConfig.
lsdtools.network.SessionConfig.participant_id#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:46.
participant_id: int
lsdtools.network.SessionConfig.endpoint#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:47.
endpoint: str
lsdtools.network.SessionConfig.trusted_ca_path#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:48.
trusted_ca_path: str
trusted_ca_path = field(repr=False)
lsdtools.network.SessionConfig.identity_path#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:49.
identity_path: str
identity_path = field(repr=False)
lsdtools.network.SessionConfig.native_library#
Kind: attribute. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:50.
native_library: str
native_library = field(default='', repr=False)
lsdtools.network.SessionManager#
Kind: class. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:96.
SessionManager(self, *, backend_factory: Callable[[], SessionBackend] | None=None, runtime_validator: Callable | None=None, runtime_resolver: Callable | None=None)
Source docstring:
One project's session lifetime, independent of inspector/window lifetime.
The initial authenticated transport has one process identity; reject multiple
sessions here as well as in native code. Inject a backend for deterministic
contract tests. No socket or native library is opened by this constructor.
Implementation alias: lsd_runtime_network.sessions.SessionManager.
lsdtools.network.SessionManager.__init__#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:103.
__init__(self, *, backend_factory: Callable[[], SessionBackend] | None=None, runtime_validator: Callable | None=None, runtime_resolver: Callable | None=None)
backend_factory: Callable[[], SessionBackend] | None
runtime_resolver: Callable | None
runtime_validator: Callable | None
self: (unannotated)
lsdtools.network.SessionManager.capabilities#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:122.
capabilities() -> dict
lsdtools.network.SessionManager.start#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:131.
start(self, plan: NetworkPlan, config: SessionConfig, *, owner: str | None=None, prediction_models: tuple[KinematicModel, ...] | None=None) -> dict
config: SessionConfig
owner: str | None
plan: NetworkPlan
prediction_models: tuple[KinematicModel, ...] | None
self: (unannotated)
lsdtools.network.SessionManager.host#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:167.
host(self, plan: NetworkPlan, config: SessionConfig, *, owner: str | None=None) -> dict
config: SessionConfig
owner: str | None
plan: NetworkPlan
self: (unannotated)
lsdtools.network.SessionManager.join#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:172.
join(self, plan: NetworkPlan, config: SessionConfig, *, owner: str | None=None, prediction_models: tuple[KinematicModel, ...] | None=None) -> dict
config: SessionConfig
owner: str | None
plan: NetworkPlan
prediction_models: tuple[KinematicModel, ...] | None
self: (unannotated)
lsdtools.network.SessionManager.status#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:178.
status(self) -> dict
self: (unannotated)
lsdtools.network.SessionManager.stop#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:197.
stop(self) -> dict
self: (unannotated)
lsdtools.network.SessionManager.poll_events#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:224.
poll_events(self, *, maximum: int=64) -> tuple[dict, ...]
maximum: int
self: (unannotated)
Source docstring:
Consume bounded lifecycle records; reliable control payloads remain queued.
lsdtools.network.SessionManager.submit_input#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:260.
submit_input(self, grant: Mapping, *, tick: int, sequence: int, x: float, y: float, jump: bool=False) -> None
grant: Mapping
jump: bool
self: (unannotated)
sequence: int
tick: int
x: float
y: float
Source docstring:
Submit one explicit local tick; native admission rechecks the exact grant.
lsdtools.network.SessionManager.read_state#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:280.
read_state(self, after_sequence: int=0) -> dict | None
after_sequence: int
self: (unannotated)
Source docstring:
Read a detached authoritative keyframe; controls/lifecycle stay queued.
lsdtools.network.SessionManager.prediction_read#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:291.
prediction_read(self, grant: Mapping, expected_sequence: int, target_tick: int) -> dict | None
expected_sequence: int
grant: Mapping
self: (unannotated)
target_tick: int
Source docstring:
Copy a separate local pose; None means keep the authoritative presentation.
lsdtools.network.SessionManager.close#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:309.
close(self) -> None
self: (unannotated)
lsdtools.network.SessionManager.retire_owner#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:314.
retire_owner(self, package: str) -> None
package: str
self: (unannotated)
lsdtools.network.SessionManager.attach_runtime#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:319.
attach_runtime(self, driver) -> None
driver: (unannotated)
self: (unannotated)
Source docstring:
Attach the injected runtime's typed publication reader, never its renderer.
lsdtools.network.SessionManager.attach_entity#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:337.
attach_entity(self, entity_id: str)
entity_id: str
self: (unannotated)
lsdtools.network.SessionManager.grant_actor#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:353.
grant_actor(self, participant_id: int, seat: int)
participant_id: int
seat: int
self: (unannotated)
lsdtools.network.SessionManager.revoke_actor#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:359.
revoke_actor(self, seat: int)
seat: int
self: (unannotated)
lsdtools.network.SessionManager.bind_run#
Kind: method. Source: services/runtime_network/src/lsd_runtime_network/sessions.py:365.
bind_run(self, run_id: str, ports: tuple[NetworkPort, ...], *, ttl_seconds: float=300, cancelled: Callable[[], bool] | None=None)
cancelled: Callable[[], bool] | None
ports: tuple[NetworkPort, ...]
run_id: str
self: (unannotated)
ttl_seconds: float
lsdtools.network.ToNetwork#
Kind: function. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:304.
ToNetwork(*, session_id: str, channel: str, schema_digest: str, lane: str='dataset') -> NetworkPort
channel: str
lane: str
schema_digest: str
session_id: str
Implementation alias: lsd_runtime_network.contracts.ToNetwork.
lsdtools.network.canonical_digest#
Kind: function. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:58.
canonical_digest(document: Any) -> str
document: Any
Source docstring:
Hash strict finite JSON; callers retain authority over what is represented.
Implementation alias: lsd_runtime_network.contracts.canonical_digest.
lsdtools.network.decode_table#
Kind: function. Source: sdk/src/lsdtools/network.py:42.
decode_table(payload, *, schema_digest)
payload: (unannotated)
schema_digest: (unannotated)
lsdtools.network.encode_table#
Kind: function. Source: sdk/src/lsdtools/network.py:31.
encode_table(table)
table: (unannotated)
Source docstring:
Return bounded wire bytes and the exact primitive table schema digest.
lsdtools.network.kinematic_models#
Kind: function. Source: services/compiler/src/lsd_compiler/network.py:114.
kinematic_models(plan, bundle, *, fixed_hz=60, substeps=4, active_systems=())
active_systems: (unannotated)
bundle: (unannotated)
fixed_hz: (unannotated)
plan: (unannotated)
substeps: (unannotated)
Source docstring:
Return controller models only after binding the actual source simulation.
Source composition supplies its real driver frequency, substeps and registered systems.
This checks the same content and complete tick contract as native export. The immutable
values configure a client predictor; only a server grant can authorize its local actor.
Implementation alias: lsd_compiler.network.kinematic_models.
lsdtools.network.require_run_binding#
Kind: function. Source: sdk/src/lsdtools/network.py:56.
require_run_binding(context)
context: (unannotated)
Source docstring:
Read the exact capability supplied through Engine.run(run_capabilities=...).
lsdtools.network.stable_session_id#
Kind: function. Source: services/runtime_network/src/lsd_runtime_network/contracts.py:68.
stable_session_id(value: str) -> int
value: str
Source docstring:
Map a plan's UTF-8 session identity to the native v1 uint64 namespace.
Implementation alias: lsd_runtime_network.contracts.stable_session_id.
lsdtools.network.table_schema_digest#
Kind: function. Source: sdk/src/lsdtools/network.py:37.
table_schema_digest(table)
table: (unannotated)