pandemonium_engine/doc/classes/PacketPeer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeer" inherits="Reference" version="4.3">
	<brief_description>
		Abstraction and base class for packet-based protocols.
	</brief_description>
	<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.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_available_packet_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of packets currently available in the ring-buffer.
			</description>
		</method>
		<method name="get_packet">
			<return type="PoolByteArray" />
			<description>
				Gets a raw packet.
			</description>
		</method>
		<method name="get_packet_error" qualifiers="const">
			<return type="int" enum="Error" />
			<description>
				Returns the error state of the last packet received (via [method get_packet] and [method get_var]).
			</description>
		</method>
		<method name="get_var">
			<return type="Variant" />
			<argument index="0" name="allow_objects" type="bool" default="false" />
			<description>
				Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], decoding objects is allowed.
				[b]Warning:[/b] 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.
			</description>
		</method>
		<method name="put_packet">
			<return type="int" enum="Error" />
			<argument index="0" name="buffer" type="PoolByteArray" />
			<description>
				Sends a raw packet.
			</description>
		</method>
		<method name="put_var">
			<return type="int" enum="Error" />
			<argument index="0" name="var" type="Variant" />
			<argument index="1" name="full_objects" type="bool" default="false" />
			<description>
				Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code).
			</description>
		</method>
	</methods>
	<members>
		<member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed" default="false">
			[i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead.
			If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var].
			[b]Warning:[/b] 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.
		</member>
		<member name="encode_buffer_max_size" type="int" setter="set_encode_buffer_max_size" getter="get_encode_buffer_max_size" default="8388608">
			Maximum buffer size allowed when encoding [Variant]s. Raise this value to support heavier memory allocations.
			The [method 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 [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY].
		</member>
	</members>
	<constants>
	</constants>
</class>