UPNPDevice

UPNP device.

See UPNP for UPNP discovery and utility functions. Provides low-level access to UPNP control commands. Allows to manage port mappings (port forwarding) and to query network information of the device (like local and external IP address and status). Note that methods on this class are synchronous and block the calling thread.

@GodotBaseClass

struct UPNPDevice {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(UPNPDevice other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static UPNPDevice _new();

enum IGDStatus;

enum Constants;

long addPortMapping(long port, long port_internal, String desc, String proto, long duration);

long deletePortMapping(long port, String proto);

String getDescriptionUrl();

String getIgdControlUrl();

String getIgdOurAddr();

String getIgdServiceType();

UPNPDevice.IGDStatus getIgdStatus();

String getServiceType();

bool isValidGateway();

String queryExternalAddress();

void setDescriptionUrl(String url);

void setIgdControlUrl(String url);

void setIgdOurAddr(String addr);

void setIgdServiceType(String type);

void setIgdStatus(long status);

void setServiceType(String type);

String descriptionUrl [@property getter];

String descriptionUrl [@property setter];

String igdControlUrl [@property getter];

String igdControlUrl [@property setter];

String igdOurAddr [@property getter];

String igdOurAddr [@property setter];

String igdServiceType [@property getter];

String igdServiceType [@property setter];

UPNPDevice.IGDStatus igdStatus [@property getter];

long igdStatus [@property setter];

String serviceType [@property getter];

String serviceType [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
IGDStatus enum IGDStatus

Functions

addPortMapping long addPortMapping(long port, long port_internal, String desc, String proto, long duration): Adds a port mapping to forward the given external port on this UPNPDevice for the given protocol to the local machine. See UPNP.addPortMapping.
deletePortMapping long deletePortMapping(long port, String proto): Deletes the port mapping identified by the given port and protocol combination on this device. See UPNP.deletePortMapping.
getDescriptionUrl String getDescriptionUrl()
getIgdControlUrl String getIgdControlUrl()
getIgdOurAddr String getIgdOurAddr()
getIgdServiceType String getIgdServiceType()
getIgdStatus UPNPDevice.IGDStatus getIgdStatus()
getServiceType String getServiceType()
isValidGateway bool isValidGateway(): Returns true if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(UPNPDevice other)
opEquals bool opEquals(typeof(null) n)
queryExternalAddress String queryExternalAddress(): Returns the external IP address of this UPNPDevice or an empty string.
setDescriptionUrl void setDescriptionUrl(String url)
setIgdControlUrl void setIgdControlUrl(String url)
setIgdOurAddr void setIgdOurAddr(String addr)
setIgdServiceType void setIgdServiceType(String type)
setIgdStatus void setIgdStatus(long status)
setServiceType void setServiceType(String type)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

descriptionUrl String descriptionUrl [@property getter]
String descriptionUrl [@property setter]: URL to the device description.
igdControlUrl String igdControlUrl [@property getter]
String igdControlUrl [@property setter]: IDG control URL.
igdOurAddr String igdOurAddr [@property getter]
String igdOurAddr [@property setter]: Address of the local machine in the network connecting it to this UPNPDevice.
igdServiceType String igdServiceType [@property getter]
String igdServiceType [@property setter]: IGD service type.
igdStatus UPNPDevice.IGDStatus igdStatus [@property getter]
long igdStatus [@property setter]: IGD status. See igdstatus.
serviceType String serviceType [@property getter]
String serviceType [@property setter]: Service type.

Static functions

_new UPNPDevice _new(): Construct a new instance of UPNPDevice. Note: use memnew!UPNPDevice instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot upnpdevice structs

UPNPDevice