| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_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
- ----------
- +-------------------------------------+---------------------------------------------------------------------------------------+-----------+
- | :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>` | |
- +-------------------------------------+---------------------------------------------------------------------------------------+-----------+
- Property Descriptions
- ---------------------
- .. _class_PacketPeerStream_property_input_buffer_max_size:
- - :ref:`int<class_int>` **input_buffer_max_size**
- +-----------+----------------------------------+
- | *Default* | ``65532`` |
- +-----------+----------------------------------+
- | *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**
- +-----------+-----------------------------------+
- | *Default* | ``65532`` |
- +-----------+-----------------------------------+
- | *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.
- .. |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.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
