virtualx-engine/doc/classes/PacketPeerStream.xml

22 lines
1.3 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeerStream" inherits="PacketPeer" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Wrapper to use a PacketPeer over a StreamPeer.
</brief_description>
<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.
[b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] 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.
</description>
<tutorials>
</tutorials>
2018-01-11 23:38:35 +01:00
<members>
<member name="input_buffer_max_size" type="int" setter="set_input_buffer_max_size" getter="get_input_buffer_max_size" default="65532">
2018-01-11 23:38:35 +01:00
</member>
<member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size" default="65532">
2018-01-11 23:38:35 +01:00
</member>
<member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer">
2018-01-11 23:38:35 +01:00
The wrapped [StreamPeer] object.
</member>
</members>
</class>