mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 19:29:06 +00:00
65 lines
3.4 KiB
ReStructuredText
65 lines
3.4 KiB
ReStructuredText
.. 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.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_input_buffer_max_size<class_PacketPeerStream_get_input_buffer_max_size>` **(** **)** const |
|
|
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_output_buffer_max_size<class_PacketPeerStream_get_output_buffer_max_size>` **(** **)** const |
|
|
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_input_buffer_max_size<class_PacketPeerStream_set_input_buffer_max_size>` **(** :ref:`int<class_int>` max_size_bytes **)** |
|
|
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_output_buffer_max_size<class_PacketPeerStream_set_output_buffer_max_size>` **(** :ref:`int<class_int>` max_size_bytes **)** |
|
|
+------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_stream_peer<class_PacketPeerStream_set_stream_peer>` **(** :ref:`Reference<class_reference>` 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.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_PacketPeerStream_get_input_buffer_max_size:
|
|
|
|
- :ref:`int<class_int>` **get_input_buffer_max_size** **(** **)** const
|
|
|
|
.. _class_PacketPeerStream_get_output_buffer_max_size:
|
|
|
|
- :ref:`int<class_int>` **get_output_buffer_max_size** **(** **)** const
|
|
|
|
.. _class_PacketPeerStream_set_input_buffer_max_size:
|
|
|
|
- void **set_input_buffer_max_size** **(** :ref:`int<class_int>` max_size_bytes **)**
|
|
|
|
.. _class_PacketPeerStream_set_output_buffer_max_size:
|
|
|
|
- void **set_output_buffer_max_size** **(** :ref:`int<class_int>` max_size_bytes **)**
|
|
|
|
.. _class_PacketPeerStream_set_stream_peer:
|
|
|
|
- void **set_stream_peer** **(** :ref:`Reference<class_reference>` peer **)**
|
|
|
|
Set the :ref:`StreamPeer<class_streampeer>` object to be wrapped.
|
|
|
|
|