Table of Contents

Class PacketPeer

Abstraction and base class for packet-based protocols.

Inheritance
PacketPeer
Derived

Remarks

PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low-level bytes or having to worry about network ordering.

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.

Properties

encode_buffer_max_size

Maximum buffer size allowed when encoding Variants. Raise this value to support heavier memory allocations.

The PacketPeer.put_var method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the Variant. If the Variant is bigger than encode_buffer_max_size, the method will error out with @GlobalScope.ERR_OUT_OF_MEMORY.

var encode_buffer_max_size : int = 8388608

Property Value

int

Remarks

  • void set_encode_buffer_max_size(int value)
  • int get_encode_buffer_max_size

Methods

get_available_packet_count

Qualifiers: const

Returns the number of packets currently available in the ring-buffer.

int get_available_packet_count

get_packet

Gets a raw packet.

PackedByteArray get_packet

get_packet_error

Qualifiers: const

Returns the error state of the last packet received (via get_packet and PacketPeer.get_var).

int get_packet_error

get_var(bool)

Gets a Variant. If allow_objects is true, decoding objects is allowed.

Internally, this uses the same decoding mechanism as the @GlobalScope.bytes_to_var method.

Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.

Variant get_var(bool allow_objects)

Parameters

allow_objects bool

put_packet(PackedByteArray)

Sends a raw packet.

int put_packet(PackedByteArray buffer)

Parameters

buffer PackedByteArray

put_var(Variant, bool)

Sends a Variant as a packet. If full_objects is true, encoding objects is allowed (and can potentially include code).

Internally, this uses the same encoding mechanism as the @GlobalScope.var_to_bytes method.

int put_var(Variant var, bool full_objects)

Parameters

var Variant
full_objects bool