Struct gdnative_bindings_lily::PacketPeerUDP

pub struct PacketPeerUDP { /* fields omitted */ }

core class PacketPeerUDP inherits PacketPeer (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

Class hierarchy

PacketPeerUDP inherits methods from:

• PacketPeer
• 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 PacketPeerUDP

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

Creates a new instance of this object.

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

pub fn close(&self)

Closes the UDP socket the PacketPeerUDP is currently listening on.

pub fn connect_to_host(
    &self,
    host: impl Into<GodotString>,
    port: i64
) -> GodotResult

Calling this method connects this UDP peer to the given host/port pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to [method set_dest_address] are not allowed). This method does not send any data to the remote peer, to do that, use [method PacketPeer.put_var] or [method PacketPeer.put_packet] as usual. See also UDPServer. Note: Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transfering sensitive information.

pub fn get_packet_ip(&self) -> GodotString

Returns the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]).

pub fn get_packet_port(&self) -> i64

Returns the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]).

pub fn is_connected_to_host(&self) -> bool

Returns true if the UDP socket is open and has been connected to a remote address. See [method connect_to_host].

pub fn is_listening(&self) -> bool

Returns whether this PacketPeerUDP is listening.

pub fn join_multicast_group(
    &self,
    multicast_address: impl Into<GodotString>,
    interface_name: impl Into<GodotString>
) -> GodotResult

Joins the multicast group specified by multicast_address using the interface identified by interface_name. You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. Note: Some Android devices might require the CHANGE_WIFI_MULTICAST_STATE permission for multicast to work.

pub fn leave_multicast_group(
    &self,
    multicast_address: impl Into<GodotString>,
    interface_name: impl Into<GodotString>
) -> GodotResult

Removes the interface identified by interface_name from the multicast group specified by multicast_address.

pub fn listen(
    &self,
    port: i64,
    bind_address: impl Into<GodotString>,
    recv_buf_size: i64
) -> GodotResult

Makes this PacketPeerUDP listen on the port binding to bind_address with a buffer size recv_buf_size. If bind_address is set to "*" (default), the peer will listen on all available addresses (both IPv4 and IPv6). If bind_address is set to "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer will listen on all available addresses matching that IP type. If bind_address is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists).

Default Arguments

• bind_address - "*"
• recv_buf_size - 65536

pub fn set_broadcast_enabled(&self, enabled: bool)

Enable or disable sending of broadcast packets (e.g. set_dest_address("255.255.255.255", 4343). This option is disabled by default. Note: Some Android devices might require the CHANGE_WIFI_MULTICAST_STATE permission and this option to be enabled to receive broadcast packets too.

pub fn set_dest_address(
    &self,
    host: impl Into<GodotString>,
    port: i64
) -> GodotResult

Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. Note: [method set_broadcast_enabled] must be enabled before sending packets to a broadcast address (e.g. 255.255.255.255).

pub fn wait(&self) -> GodotResult

Waits for a packet to arrive on the listening port. See [method listen].

Methods from Deref<Target = PacketPeer>

pub fn get_available_packet_count(&self) -> i64

Returns the number of packets currently available in the ring-buffer.

pub fn encode_buffer_max_size(&self) -> i64

Maximum buffer size allowed when encoding Variants. Raise this value to support heavier memory allocations. The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the Variant. If the Variant is bigger than encode_buffer_max_size, the method will error out with [constant ERR_OUT_OF_MEMORY].

pub fn get_packet(&self) -> ByteArray

Gets a raw packet.

pub fn get_packet_error(&self) -> GodotResult

Returns the error state of the last packet received (via [method get_packet] and [method get_var]).

pub fn get_var(&self, allow_objects: bool) -> Variant

Gets a Variant. If allow_objects (or [member allow_object_decoding]) is true, decoding objects is allowed. Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

Default Arguments

• allow_objects - false

pub fn is_object_decoding_allowed(&self) -> bool

[i]Deprecated.[/i] Use get_var and put_var parameters instead. If true, the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn put_packet(&self, buffer: ByteArray) -> GodotResult

Sends a raw packet.

pub fn put_var(
    &self,
    var: impl OwnedToVariant,
    full_objects: bool
) -> GodotResult

Sends a Variant as a packet. If full_objects (or [member allow_object_decoding]) is true, encoding objects is allowed (and can potentially include code).

Default Arguments

• full_objects - false

pub fn set_allow_object_decoding(&self, enable: bool)

[i]Deprecated.[/i] Use get_var and put_var parameters instead. If true, the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

pub fn set_encode_buffer_max_size(&self, max_size: i64)

Maximum buffer size allowed when encoding Variants. Raise this value to support heavier memory allocations. The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the Variant. If the Variant is bigger than encode_buffer_max_size, the method will error out with [constant ERR_OUT_OF_MEMORY].

Trait Implementations

impl Debug for PacketPeerUDP

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

Formats the value using the given formatter.

impl Deref for PacketPeerUDP

type Target = PacketPeer

The resulting type after dereferencing.

fn deref(&self) -> &PacketPeer

Dereferences the value.

impl DerefMut for PacketPeerUDP

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

Mutably dereferences the value.

impl GodotObject for PacketPeerUDP

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for PacketPeerUDP

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

impl Sealed for PacketPeerUDP

impl SubClass<Object> for PacketPeerUDP

impl SubClass<PacketPeer> for PacketPeerUDP

impl SubClass<Reference> for PacketPeerUDP