Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
UDP packet peer.
UDP packet peer. Can be used to send raw UDP packets as well as Variants.
Note: When exporting to Android, make sure to enable the
INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
close ( )
get_local_port ( ) const
get_packet_ip ( ) const
get_packet_port ( ) const
is_bound ( ) const
is_socket_connected ( ) const
wait ( )
Binds this PacketPeerUDP to the specified
bind_address with a buffer size
recv_buf_size, allowing it to receive incoming packets.
bind_address is set to
"*" (default), the peer will be bound on all available addresses (both IPv4 and IPv6).
bind_address is set to
"0.0.0.0" (for IPv4) or
"::" (for IPv6), the peer will be bound to all available addresses matching that IP type.
bind_address is set to any valid address (e.g.
"::1", etc), the peer will only be bound to the interface with that addresses (or fail if no interface with the given address exists).
void close ( )
Closes the PacketPeerUDP's underlying UDP socket.
Calling this method connects this UDP peer to the given
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 set_dest_address are not allowed). This method does not send any data to the remote peer, to do that, use PacketPeer.put_var or 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 TLS or DTLS if you feel like your application is transferring sensitive information.
int get_local_port ( ) const
Returns the local port to which this peer is bound.
String get_packet_ip ( ) const
int get_packet_port ( ) const
bool is_bound ( ) const
Returns whether this PacketPeerUDP is bound to an address and can receive packets.
bool is_socket_connected ( ) const
true if the UDP socket is open and has been connected to a remote address. See connect_to_host.
Joins the multicast group specified by
multicast_address using the interface identified by