104 lines
4 KiB
Text
104 lines
4 KiB
Text
|
:github_url: hide
|
||
|
|
|
||
|
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
|
.. Generated automatically from Godot engine sources.
|
||
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
||
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PacketPeerStream.xml.
|
||
|
|
|
||
|
|
.. _class_PacketPeerStream:
|
||
|
|
|
||
|
|
PacketPeerStream
|
||
|
|
================
|
||
|
|
|
||
|
|
**Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
Wrapper to use a PacketPeer over a StreamPeer.
|
||
|
|
|
||
|
|
.. rst-class:: classref-introduction-group
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
.. rst-class:: classref-reftable-group
|
||
|
|
|
||
|
|
Properties
|
||
|
|
----------
|
||
|
|
|
||
|
|
.. table::
|
||
|
|
:widths: auto
|
||
|
|
|
||
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+-----------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`input_buffer_max_size<class_PacketPeerStream_property_input_buffer_max_size>` | ``65532`` |
|
||
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+-----------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`output_buffer_max_size<class_PacketPeerStream_property_output_buffer_max_size>` | ``65532`` |
|
||
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+-----------+
|
||
|
|
| :ref:`StreamPeer<class_StreamPeer>` | :ref:`stream_peer<class_PacketPeerStream_property_stream_peer>` | |
|
||
|
|
+-------------------------------------+---------------------------------------------------------------------------------------+-----------+
|
||
|
|
|
||
|
|
.. rst-class:: classref-section-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. rst-class:: classref-descriptions-group
|
||
|
|
|
||
|
|
Property Descriptions
|
||
|
|
---------------------
|
||
|
|
|
||
|
|
.. _class_PacketPeerStream_property_input_buffer_max_size:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`int<class_int>` **input_buffer_max_size** = ``65532``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_input_buffer_max_size** **(** :ref:`int<class_int>` value **)**
|
||
|
|
- :ref:`int<class_int>` **get_input_buffer_max_size** **(** **)**
|
||
|
|
|
||
|
|
.. container:: contribute
|
||
|
|
|
||
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_PacketPeerStream_property_output_buffer_max_size:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`int<class_int>` **output_buffer_max_size** = ``65532``
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_output_buffer_max_size** **(** :ref:`int<class_int>` value **)**
|
||
|
|
- :ref:`int<class_int>` **get_output_buffer_max_size** **(** **)**
|
||
|
|
|
||
|
|
.. container:: contribute
|
||
|
|
|
||
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
|
||
|
|
.. rst-class:: classref-item-separator
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_PacketPeerStream_property_stream_peer:
|
||
|
|
|
||
|
|
.. rst-class:: classref-property
|
||
|
|
|
||
|
|
:ref:`StreamPeer<class_StreamPeer>` **stream_peer**
|
||
|
|
|
||
|
|
.. rst-class:: classref-property-setget
|
||
|
|
|
||
|
|
- void **set_stream_peer** **(** :ref:`StreamPeer<class_StreamPeer>` value **)**
|
||
|
|
- :ref:`StreamPeer<class_StreamPeer>` **get_stream_peer** **(** **)**
|
||
|
|
|
||
|
|
The wrapped :ref:`StreamPeer<class_StreamPeer>` object.
|
||
|
|
|
||
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
||
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|