virtualx-engine/doc/classes/PacketPeerStream.xml
Rémi Verschelde 967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00

54 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0-alpha">
<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.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_input_buffer_max_size" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_output_buffer_max_size" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_input_buffer_max_size">
<return type="void">
</return>
<argument index="0" name="max_size_bytes" type="int">
</argument>
<description>
</description>
</method>
<method name="set_output_buffer_max_size">
<return type="void">
</return>
<argument index="0" name="max_size_bytes" type="int">
</argument>
<description>
</description>
</method>
<method name="set_stream_peer">
<return type="void">
</return>
<argument index="0" name="peer" type="Reference">
</argument>
<description>
Set the [StreamPeer] object to be wrapped.
</description>
</method>
</methods>
<constants>
</constants>
</class>