Struct gdnative::api::UPNP

pub struct UPNP { /* fields omitted */ }

core class UPNP inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

UPNP inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl UPNP

Constants

pub const UPNP_RESULT_ACTION_FAILED: i64

pub const UPNP_RESULT_CONFLICT_WITH_OTHER_MAPPING: i64

pub const UPNP_RESULT_CONFLICT_WITH_OTHER_MECHANISM: i64

pub const UPNP_RESULT_EXT_PORT_MUST_BE_WILDCARD: i64

pub const UPNP_RESULT_EXT_PORT_WILDCARD_NOT_PERMITTED: i64

pub const UPNP_RESULT_HTTP_ERROR: i64

pub const UPNP_RESULT_INCONSISTENT_PARAMETERS: i64

pub const UPNP_RESULT_INT_PORT_WILDCARD_NOT_PERMITTED: i64

pub const UPNP_RESULT_INVALID_ARGS: i64

pub const UPNP_RESULT_INVALID_DURATION: i64

pub const UPNP_RESULT_INVALID_GATEWAY: i64

pub const UPNP_RESULT_INVALID_PARAM: i64

pub const UPNP_RESULT_INVALID_PORT: i64

pub const UPNP_RESULT_INVALID_PROTOCOL: i64

pub const UPNP_RESULT_INVALID_RESPONSE: i64

pub const UPNP_RESULT_MEM_ALLOC_ERROR: i64

pub const UPNP_RESULT_NOT_AUTHORIZED: i64

pub const UPNP_RESULT_NO_DEVICES: i64

pub const UPNP_RESULT_NO_GATEWAY: i64

pub const UPNP_RESULT_NO_PORT_MAPS_AVAILABLE: i64

pub const UPNP_RESULT_NO_SUCH_ENTRY_IN_ARRAY: i64

pub const UPNP_RESULT_ONLY_PERMANENT_LEASE_SUPPORTED: i64

pub const UPNP_RESULT_PORT_MAPPING_NOT_FOUND: i64

pub const UPNP_RESULT_REMOTE_HOST_MUST_BE_WILDCARD: i64

pub const UPNP_RESULT_SAME_PORT_VALUES_REQUIRED: i64

pub const UPNP_RESULT_SOCKET_ERROR: i64

pub const UPNP_RESULT_SRC_IP_WILDCARD_NOT_PERMITTED: i64

pub const UPNP_RESULT_SUCCESS: i64

pub const UPNP_RESULT_UNKNOWN_ERROR: i64

impl UPNP

pub fn new() -> Ref<UPNP, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_device(&self, device: impl AsArg<UPNPDevice>)

pub fn add_port_mapping(
    &self,
    port: i64,
    port_internal: i64,
    desc: impl Into<GodotString>,
    proto: impl Into<GodotString>,
    duration: i64
) -> i64

pub fn clear_devices(&self)

pub fn delete_port_mapping(
    &self,
    port: i64,
    proto: impl Into<GodotString>
) -> i64

pub fn discover(
    &self,
    timeout: i64,
    ttl: i64,
    device_filter: impl Into<GodotString>
) -> i64

pub fn get_device(&self, index: i64) -> Option<Ref<UPNPDevice, Shared>>

pub fn get_device_count(&self) -> i64

pub fn discover_local_port(&self) -> i64

pub fn discover_multicast_if(&self) -> GodotString

pub fn get_gateway(&self) -> Option<Ref<UPNPDevice, Shared>>

pub fn is_discover_ipv6(&self) -> bool

pub fn query_external_address(&self) -> GodotString

pub fn remove_device(&self, index: i64)

pub fn set_device(&self, index: i64, device: impl AsArg<UPNPDevice>)

pub fn set_discover_ipv6(&self, ipv6: bool)

pub fn set_discover_local_port(&self, port: i64)

pub fn set_discover_multicast_if(&self, m_if: impl Into<GodotString>)

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for UPNP

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for UPNP

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for UPNP

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for UPNP

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for UPNP

fn construct() -> Ref<UPNP, Unique>

impl SubClass<Object> for UPNP

impl SubClass<Reference> for UPNP