Struct PacketPeer
Abstraction and base class for packet-based protocols.
struct PacketPeer
;
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.
Properties
| Name | Type | Description |
|---|---|---|
allowObjectDecoding[get, set]
|
bool | Deprecated. Use get_var and put_var parameters instead.
If true, the PacketPeer will allow encoding and decoding of object via getVar and putVar.
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.
|
encodeBufferMaxSize[get, set]
|
long | Maximum buffer size allowed when encoding Variants. Raise this value to support heavier memory allocations.
The putVar 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 encode_buffer_max_size, the method will error out with constant ERR_OUT_OF_MEMORY.
|
Methods
| Name | Description |
|---|---|
getAvailablePacketCount
|
Returns the number of packets currently available in the ring-buffer. |
getEncodeBufferMaxSize
|
|
getPacket
|
Gets a raw packet. |
getPacketError
|
Returns the error state of the last packet received (via getPacket and getVar).
|
getVar
|
Gets a Variant. If allow_objects (or allowObjectDecoding) 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.
|
isObjectDecodingAllowed
|
|
putPacket
|
Sends a raw packet. |
putVar
|
Sends a Variant as a packet. If full_objects (or allowObjectDecoding) is true, encoding objects is allowed (and can potentially include code).
|
setAllowObjectDecoding
|
|
setEncodeBufferMaxSize
|