<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeer" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<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.
		[b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
	</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="PackedByteArray" />
			<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" />
			<param index="0" name="allow_objects" type="bool" default="false" />
			<description>
				Gets a Variant. If [param allow_objects] is [code]true[/code], decoding objects is allowed.
				Internally, this uses the same decoding mechanism as the [method @GlobalScope.bytes_to_var] method.
				[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" />
			<param index="0" name="buffer" type="PackedByteArray" />
			<description>
				Sends a raw packet.
			</description>
		</method>
		<method name="put_var">
			<return type="int" enum="Error" />
			<param index="0" name="var" type="Variant" />
			<param index="1" name="full_objects" type="bool" default="false" />
			<description>
				Sends a [Variant] as a packet. If [param full_objects] is [code]true[/code], encoding objects is allowed (and can potentially include code).
				Internally, this uses the same encoding mechanism as the [method @GlobalScope.var_to_bytes] method.
			</description>
		</method>
	</methods>
	<members>
		<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 [member encode_buffer_max_size], the method will error out with [constant ERR_OUT_OF_MEMORY].
		</member>
	</members>
</class>
