Struct PacketPeerUDP

UDP packet peer.

struct PacketPeerUDP ;

Can be used to send raw UDP packets as well as Variants.

Methods

NameDescription
close Closes the UDP socket the PacketPeerUDP is currently listening on.
getPacketIp Returns the IP of the remote peer that sent the last packet(that was received with PacketPeer.getPacket or PacketPeer.getVar).
getPacketPort Returns the port of the remote peer that sent the last packet(that was received with PacketPeer.getPacket or PacketPeer.getVar).
isListening Returns whether this PacketPeerUDP is listening.
joinMulticastGroup 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 IP.getLocalInterfaces to know which are available.
leaveMulticastGroup Removes the interface identified by interface_name from the multicast group specified by multicast_address.
listen 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).
setBroadcastEnabled Enable or disable sending of broadcast packets (e.g. set_dest_address("255.255.255.255", 4343). This option is disabled by default.
setDestAddress Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed.
wait Waits for a packet to arrive on the listening port. See listen.