UPNPResult

Type members

• class var godotClassName: StringName

Instance members

• var discoverIpv6: Bool

  If true, IPv6 is used for UPNPDevice discovery.

• var discoverLocalPort: Int32

  If 0, the local port to use for discovery is chosen automatically by the system. If 1, discovery will be done from the source port 1900 (same as destination port). Otherwise, the value will be used as the port.

• var discoverMulticastIf: String

  Multicast interface to use for discovery. Uses the default multicast interface if empty.

• func addDevice(UPNPDevice?)

  Adds the given UPNPDevice to the list of discovered devices.

• func addPortMapping(port: Int32, portInternal: Int32, desc: String, proto: String, duration: Int32) -> Int32

  Adds a mapping to forward the external port (between 1 and 65535, although recommended to use port 1024 or above) on the default gateway (see getGateway) to the portInternal on the local machine for the given protocol proto (either "TCP" or "UDP", with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with getGateway and call addPortMapping(port:portInternal:desc:proto:duration:) on it, if any. Note that forwarding a well-known port (below 1024) with UPnP may fail depending on the device.

• func clearDevices()

  Clears the list of discovered devices.

• func deletePortMapping(port: Int32, proto: String) -> Int32

  Deletes the port mapping for the given port and protocol combination on the default gateway (see getGateway) if one exists. port must be a valid port between 1 and 65535, proto can be either "TCP" or "UDP". May be refused for mappings pointing to addresses other than this one, for well-known ports (below 1024), or for mappings not added via UPnP. See UPNPResult for possible return values.

• func discover(timeout: Int32, ttl: Int32, deviceFilter: String) -> Int32

  Discovers local UPNPDevices. Clears the list of previously discovered devices.

• func getDevice(index: Int32) -> UPNPDevice?

  Returns the UPNPDevice at the given index.

• func getDeviceCount() -> Int32

  Returns the number of discovered UPNPDevices.

• func getGateway() -> UPNPDevice?

  Returns the default gateway. That is the first discovered UPNPDevice that is also a valid IGD (InternetGatewayDevice).

• func queryExternalAddress() -> String

  Returns the external IP address of the default gateway (see getGateway) as string. Returns an empty string on error.

• func removeDevice(index: Int32)

  Removes the device at index from the list of discovered devices.

• func setDevice(index: Int32, device: UPNPDevice?)

  Sets the device at index from the list of discovered devices to device.