PacketPeer

Inherits: Reference < Object

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

Category: Core

Brief Description

Abstraction and base class for packet-based protocols.

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 )

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.

Property Descriptions

  • bool allow_object_decoding
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 object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).

Method Descriptions

  • int get_available_packet_count ( ) const

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

Get a raw packet.

  • Error get_packet_error ( ) const

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

Get a Variant. When allow_objects (or allow_object_decoding) is true decoding objects is allowed.

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

Send a raw packet.

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