class_packetpeerstream.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PacketPeerStream.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PacketPeerStream:
  5. PacketPeerStream
  6. ================
  7. **Inherits:** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Wrapper to use a PacketPeer over a StreamPeer.
  12. Member Variables
  13. ----------------
  14. .. _class_PacketPeerStream_input_buffer_max_size:
  15. - :ref:`int<class_int>` **input_buffer_max_size**
  16. .. _class_PacketPeerStream_output_buffer_max_size:
  17. - :ref:`int<class_int>` **output_buffer_max_size**
  18. .. _class_PacketPeerStream_stream_peer:
  19. - :ref:`StreamPeer<class_streampeer>` **stream_peer** - The wrapped :ref:`StreamPeer<class_streampeer>` object.
  20. Description
  21. -----------
  22. 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.