virtualx-engine/doc/classes/PacketPeerStream.xml

27 lines
1 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2018-01-13 11:43:06 +01:00
<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0-rc1">
<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>
</methods>
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">
</member>
<member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size">
</member>
<member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer">
The wrapped [StreamPeer] object.
</member>
</members>
<constants>
</constants>
</class>