Inherits: Reference < Object

Helper class to implement a UDP server.


A simple server that opens a UDP socket and returns connected PacketPeerUDP upon receiving new packets. See also PacketPeerUDP.connect_to_host.

Below a small example of how it can be used:

# server.gd
extends Node

var server := UDPServer.new()
var peers = []

func _ready():

func _process(delta):
    if server.is_connection_available():
        var peer : PacketPeerUDP = server.take_connection()
        var pkt = peer.get_packet()
        print("Accepted peer: %s:%s" % [peer.get_packet_ip(), peer.get_packet_port()])
        print("Received data: %s" % [pkt.get_string_from_utf8()])
        # Reply so it knows we received the message.
        # Keep a reference so we can keep contacting the remote peer.

    for i in range(0, peers.size()):
        pass # Do something with the connected peers.
# client.gd
extends Node

var udp := PacketPeerUDP.new()
var connected = false

func _ready():
    udp.connect_to_host("", 4242)

func _process(delta):
    if !connected:
        # Try to contact server
        udp.put_packet("The answer is... 42!".to_utf8())
    if udp.get_available_packet_count() > 0:
        print("Connected: %s" % udp.get_packet().get_string_from_utf8())
        connected = true



is_connection_available ( ) const


is_listening ( ) const


listen ( int port, String bind_address="*" )


stop ( )


take_connection ( )

Method Descriptions

  • bool is_connection_available ( ) const

Returns true if a packet with a new address/port combination is received on the socket.

  • bool is_listening ( ) const

Returns true if the socket is open and listening on a port.

Starts the server by opening a UDP socket listening on the given port. You can optionally specify a bind_address to only listen for packets sent to that address. See also PacketPeerUDP.listen.

  • void stop ( )

Stops the server, closing the UDP socket if open. Will not disconnect any connected PacketPeerUDP.

Returns a PacketPeerUDP connected to the address/port combination of the first packet in queue. Will return null if no packet is in queue. See also PacketPeerUDP.connect_to_host.