浏览代码

doc: UPNP: Add example on how to open/close a port

I have added a small code sample to show how to automate the process of port forwarding (and closing after you are done).
Thanks to @mhilbrunner for explaining how to achieve t0his (see #18780)
tree786 6 年之前
父节点
当前提交
2a63853720
共有 1 个文件被更改,包括 11 次插入0 次删除
  1. 11 0
      modules/upnp/doc_classes/UPNP.xml

+ 11 - 0
modules/upnp/doc_classes/UPNP.xml

@@ -5,6 +5,17 @@
 	</brief_description>
 	<description>
 		Provides UPNP functionality to discover [UPNPDevice]s on the local network and execute commands on them, like managing port mappings (port forwarding) and querying the local and remote network IP address. Note that methods on this class are synchronous and block the calling thread.
+		To forward a specific port:
+		[codeblock]
+		const PORT = 7777
+		var upnp = UPNP.new()
+		upnp.discover(2000, 2, "InternetGatewayDevice")
+		upnp.add_port_mapping(port)
+		[/codeblock]
+		To close a specific port (e.g. after you have finished using it):
+		[codeblock]
+		upnp.delete_port_mapping(port)
+		[/codeblock]
 	</description>
 	<tutorials>
 	</tutorials>