Skip to content

SimulationAppPortMapping

Source code in docs_src/capo_simspaceweaver/types/simulation_app_port_mapping.py
class SimulationAppPortMapping(TypedDict, closed=True):
    declared: NotRequired["capo_simspaceweaver.types.port_number.PortNumber"]
    """<p>The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the <code>Declared</code> port to the <code>Actual</code> port. The source code for the app should bind to the <code>Declared</code> port.</p>"""
    actual: NotRequired["capo_simspaceweaver.types.port_number.PortNumber"]
    """<p>The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the <code>Declared</code> port to the <code>Actual</code> port. Clients connect to the app using the app's IP address and the <code>Actual</code> port number.</p>"""

actual instance-attribute

actual: NotRequired[PortNumber]

The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to the Actual port. Clients connect to the app using the app's IP address and the Actual port number.

declared instance-attribute

declared: NotRequired[PortNumber]

The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for the app should bind to the Declared port.