Skip to content

Latest commit

 

History

History
109 lines (67 loc) · 4.77 KB

class_packetpeerstream.rst

File metadata and controls

109 lines (67 loc) · 4.77 KB
github_url:hide

PacketPeerStream

Inherits: :ref:`PacketPeer<class_PacketPeer>` < :ref:`RefCounted<class_RefCounted>` < :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.

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.

.. rst-class:: classref-reftable-group

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>`  
.. rst-class:: classref-section-separator


.. rst-class:: classref-descriptions-group

Property Descriptions

.. rst-class:: classref-property

:ref:`int<class_int>` input_buffer_max_size = 65532 :ref:`🔗<class_PacketPeerStream_property_input_buffer_max_size>`

.. rst-class:: classref-property-setget

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


.. rst-class:: classref-property

:ref:`int<class_int>` output_buffer_max_size = 65532 :ref:`🔗<class_PacketPeerStream_property_output_buffer_max_size>`

.. rst-class:: classref-property-setget

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


.. rst-class:: classref-property

:ref:`StreamPeer<class_StreamPeer>` stream_peer :ref:`🔗<class_PacketPeerStream_property_stream_peer>`

.. rst-class:: classref-property-setget

The wrapped :ref:`StreamPeer<class_StreamPeer>` object.