PacketPeer

Inherits: Reference < Object

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

Category: Core

Brief Description

Abstraction and base class for packet-based protocols.

Properties

Methods

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

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.

• PoolByteArray get_packet ( )

Get 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 )

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

• Error put_packet ( PoolByteArray buffer )

Send a raw packet.

• Error put_var ( Variant var, bool full_objects=false )

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