PacketPeerUDP

Inherits: PacketPeer < Reference < Object

Category: Core

Brief Description

UDP packet peer.

Methods

void close ( )
String get_packet_ip ( ) const
int get_packet_port ( ) const
bool is_listening ( ) const
Error join_multicast_group ( String multicast_address, String interface_name )
Error leave_multicast_group ( String multicast_address, String interface_name )
Error listen ( int port, String bind_address=”*”, int recv_buf_size=65536 )
Error set_dest_address ( String host, int port )
Error wait ( )

Description

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

Method Descriptions

  • void close ( )

Closes the UDP socket the PacketPeerUDP is currently listening on.


  • String get_packet_ip ( ) const

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


  • int get_packet_port ( ) const

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


  • bool is_listening ( ) const

Returns whether this PacketPeerUDP is listening.


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.get_local_interfaces to know which are available.


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


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).


Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed.


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