PacketPeer

Inherits: Reference < Object

继承人： NetworkedMultiplayerPeer ， PacketPeerGDNative ， PacketPeerStream ， PacketPeerUDP ， WebRTCDataChannel ， WebSocketPeer

类别： 核心

简要说明

基于包的协议的抽象和基类。

属性

bool

allow_object_decoding

假

方法

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 )

描述

PacketPeer是基于数据包的协议（如UDP）的抽象和基类。它提供了一个API，用于以原始数据或变量的形式发送和接收数据包。这使得通过协议传输数据变得容易，而无需将数据编码为低级字节或担心网络排序。

属性描述

• bool allow_object_decoding

违约	假
设定器	设置允许对象解码（值）
吸气剂	_object_decoding_allowed（）允许吗？

已弃用。 使用 get_var 和 put_var 而是参数。

如果 true ，packetpeer将允许通过 get_var 和 put_var .

警告： 反序列化对象可以包含执行的代码。如果序列化对象来自不受信任的源，请不要使用此选项，以避免潜在的安全威胁，如远程代码执行。

方法说明

• int get_available_packet_count ( ) const

返回当前在环缓冲区中可用的数据包数。

• PoolByteArray get_packet ( )

获取原始数据包。

• Error get_packet_error ( ) const

返回接收到的最后一个数据包的错误状态（通过 get_packet 和 get_var ）

• Variant get_var ( bool allow_objects=false )

获取变量。如果 allow_objects （或） allow_object_decoding 是 true ，允许解码对象。

警告： 反序列化对象可以包含执行的代码。如果序列化对象来自不受信任的源，请不要使用此选项，以避免潜在的安全威胁，如远程代码执行。

• Error put_packet ( PoolByteArray buffer )

发送原始数据包。

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

发送 Variant 作为一个包。如果 full_objects （或） allow_object_decoding 是 true ，允许对对象进行编码（并且可能包括代码）。