PacketPeer

Inherits: Reference < Object

Inherited By: NetworkedMultiplayerPeer, PacketPeerDTLS, PacketPeerGDNative, PacketPeerStream, PacketPeerUDP, WebRTCDataChannel, WebSocketPeer

Abstraction and base class for packet-based protocols.

Description

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.

Properties

bool	allow_object_decoding	false
int	encode_buffer_max_size	8388608

Methods

int	get_available_packet_count ( ) const
PoolByteArray	get_packet ( )
Error	get_packet_error ( ) const
Variant	get_var ( bool allow_objects=false )
Error	put_packet ( PoolByteArray buffer )
Error	put_var ( Variant var, bool full_objects=false )

Property Descriptions

bool allow_object_decoding

Default	false
Setter	set_allow_object_decoding(value)
Getter	is_object_decoding_allowed()

Deprecated. Use get_var and put_var parameters instead.

If true, the PacketPeer will allow encoding and decoding of object via get_var and put_var.

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.

int encode_buffer_max_size

Default	8388608
Setter	set_encode_buffer_max_size(value)
Getter	get_encode_buffer_max_size()

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

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

Method Descriptions

int get_available_packet_count ( ) const

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

PoolByteArray get_packet ( )

Gets a raw packet.

Error get_packet_error ( ) const

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

Variant get_var ( bool allow_objects=false )

Gets a Variant. If allow_objects (or allow_object_decoding) is true, decoding objects is allowed.

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.

Error put_packet ( PoolByteArray buffer )

Sends a raw packet.

Error put_var ( Variant var, bool full_objects=false )

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