PacketPeerStream (original) (raw)

Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Inherits: PacketPeer < RefCounted < Object

Wrapper to use a PacketPeer over a StreamPeer.

Description

PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly.

Note: When exporting to Android, make sure to enable the INTERNET 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.

Properties

Property Descriptions

int input_buffer_max_size = 65532 🔗

void set_input_buffer_max_size(value: int)
int get_input_buffer_max_size()

There is currently no description for this property. Please help us by contributing one!

int output_buffer_max_size = 65532 🔗

void set_output_buffer_max_size(value: int)
int get_output_buffer_max_size()

There is currently no description for this property. Please help us by contributing one!

StreamPeer stream_peer 🔗

void set_stream_peer(value: StreamPeer)
StreamPeer get_stream_peer()

The wrapped StreamPeer object.