.. 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 Variables
----------------

  .. _class_PacketPeerStream_input_buffer_max_size:

- :ref:`int<class_int>` **input_buffer_max_size**

  .. _class_PacketPeerStream_output_buffer_max_size:

- :ref:`int<class_int>` **output_buffer_max_size**

  .. _class_PacketPeerStream_stream_peer:

- :ref:`StreamPeer<class_streampeer>` **stream_peer** - The wrapped :ref:`StreamPeer<class_streampeer>` object.


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.