PacketPeer

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

    Abstraction and base class for packet-based protocols.

    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.

    • allow_object_decoding

    Deprecated. Use get_var and parameters instead.

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


    • int encode_buffer_max_size

    Maximum buffer size allowed when encoding s. 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 . If the Variant is bigger than encode_buffer_max_size, the method will error out with .

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


    • get_packet ( )

    Gets a raw packet.


    • Error get_packet_error ( ) const

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


    • get_var ( bool allow_objects=false )

    Gets a Variant. If (or ) 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.


    Sends a raw packet.


    • Error put_var ( var, bool full_objects=false )