mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
76 lines
2.8 KiB
ReStructuredText
76 lines
2.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the PacketPeerStream.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_PacketPeerStream:
|
|
|
|
PacketPeerStream
|
|
================
|
|
|
|
**Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Wrapper to use a PacketPeer over a StreamPeer.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`input_buffer_max_size<class_PacketPeerStream_property_input_buffer_max_size>` |
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`output_buffer_max_size<class_PacketPeerStream_property_output_buffer_max_size>` |
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+
|
|
| :ref:`StreamPeer<class_StreamPeer>` | :ref:`stream_peer<class_PacketPeerStream_property_stream_peer>` |
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+
|
|
|
|
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.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PacketPeerStream_property_input_buffer_max_size:
|
|
|
|
- :ref:`int<class_int>` **input_buffer_max_size**
|
|
|
|
+----------+----------------------------------+
|
|
| *Setter* | set_input_buffer_max_size(value) |
|
|
+----------+----------------------------------+
|
|
| *Getter* | get_input_buffer_max_size() |
|
|
+----------+----------------------------------+
|
|
|
|
----
|
|
|
|
.. _class_PacketPeerStream_property_output_buffer_max_size:
|
|
|
|
- :ref:`int<class_int>` **output_buffer_max_size**
|
|
|
|
+----------+-----------------------------------+
|
|
| *Setter* | set_output_buffer_max_size(value) |
|
|
+----------+-----------------------------------+
|
|
| *Getter* | get_output_buffer_max_size() |
|
|
+----------+-----------------------------------+
|
|
|
|
----
|
|
|
|
.. _class_PacketPeerStream_property_stream_peer:
|
|
|
|
- :ref:`StreamPeer<class_StreamPeer>` **stream_peer**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_stream_peer(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_stream_peer() |
|
|
+----------+------------------------+
|
|
|
|
The wrapped :ref:`StreamPeer<class_StreamPeer>` object.
|
|
|