diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2021-09-30 20:12:00 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-30 20:12:00 +0200 |
| commit | 94b27eb9349e5e16d7e38b7ed8c2cf54a1e420ad (patch) | |
| tree | f4dfab52532d1a7d9b97b842363d7df014085809 | |
| parent | 7e8385ff78e81b764fcb57eae68e964d190283eb (diff) | |
| parent | f4bebc272c560b025b47aa79ced156e18195d586 (diff) | |
Merge pull request #47670 from Calinou/doc-upnp-non-blocking
Document how to set up UPnP in a non-blocking manner
| -rw-r--r-- | modules/upnp/doc_classes/UPNP.xml | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml index 5b1d9dbfd1..2cd0b8843a 100644 --- a/modules/upnp/doc_classes/UPNP.xml +++ b/modules/upnp/doc_classes/UPNP.xml @@ -16,6 +16,38 @@ [codeblock] upnp.delete_port_mapping(port) [/codeblock] + [b]Note:[/b] UPnP discovery blocks the current thread. To perform discovery without blocking the main thread, use [Thread]s like this: + [codeblock] + # Emitted when UPnP port mapping setup is completed (regardless of success or failure). + signal upnp_completed(error) + + # Replace this with your own server port number between 1025 and 65535. + const SERVER_PORT = 3928 + var thread = null + + func _upnp_setup(server_port): + # UPNP queries take some time. + var upnp = UPNP.new() + var err = upnp.discover() + + if err != OK: + push_error(str(err)) + emit_signal("upnp_completed", err) + return + + if upnp.get_gateway() and upnp.get_gateway().is_valid_gateway(): + upnp.add_port_mapping(server_port, server_port, ProjectSettings.get_setting("application/config/name"), "UDP") + upnp.add_port_mapping(server_port, server_port, ProjectSettings.get_setting("application/config/name"), "TCP") + emit_signal("upnp_completed", OK) + + func _ready(): + thread = Thread.new() + thread.start(self, "_upnp_setup", SERVER_PORT) + + func _exit_tree(): + # Wait for thread finish here to handle game exit while the thread is running. + thread.wait_to_finish() + [/codeblock] </description> <tutorials> </tutorials> |