PacketPeerUDP

Inherits: PacketPeer < Reference < Object

Category: Core

Brief Description

UDP packet peer.

Member Functions

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

Description

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

Member Function Description

  • void close ( )

Close the UDP socket the PacketPeerUDP is currently listening on.

  • String get_packet_ip ( ) const

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

  • int get_packet_port ( ) const

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

  • bool is_listening ( ) const

Return whether this PacketPeerUDP is listening.

  • int listen ( int port, String bind_address=”*”, int recv_buf_size=65536 )

Make this PacketPeerUDP listen on the “port” binding to “bind_address” with a buffer size “recv_buf_size”.

If “bind_address” is set as “*” (default), the peer will listen on all available addresses (both IPv4 and IPv6).

If “bind_address” is set as “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).

Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid.

Wait for a packet to arrive on the listening port, see listen.