RemoteBuildLauncher

March 9, 2022 ยท View on GitHub

from tdw.remote_build_launcher import RemoteBuildLauncher

Connect to a remote binary_manager daemon and launch an instance of a TDW build.


Functions

launch_build

RemoteBuildLauncher.launch_build(listener_port, build_address, controller_address)

(Static)

Connect to a remote binary_manager daemon and launch an instance of a TDW build.

Returns the necessary information for a local controller to connect. Use this function to automatically launching binaries on remote (or local) nodes, and to automatically shut down the build after controller is finished. Call in the constructor of a controller and pass the build_port returned in build_info to the parent Controller class.

ParameterTypeDefaultDescription
listener_portintThe port launch_binaries is listening on.
build_addressstrRemote IP or hostname of node running launch_binaries.
controller_addressstrIP or hostname of node running controller.

Returns: The build_info dictionary containing build_port.

get_unity_args

RemoteBuildLauncher.get_unity_args(arg_dict)

(Static)

ParameterTypeDefaultDescription
arg_dictdictA dictionary of arguments. Key=The argument prefix (e.g. port) Value=Argument value.

Returns: The formatted command line string that is accepted by unity arg parser.

find_free_port

RemoteBuildLauncher.find_free_port()

(Static)

Returns: A free socket port.