virtualx-engine/doc/classes/PacketPeerStream.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.2">
	<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>
	<methods>
	</methods>
	<members>
		<member name="input_buffer_max_size" type="int" setter="set_input_buffer_max_size" getter="get_input_buffer_max_size" default="65532">
		</member>
		<member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size" default="65532">
		</member>
		<member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer">
			The wrapped [StreamPeer] object.
		</member>
	</members>
	<constants>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00			`<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.2">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<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>`
			`<methods>`
			`</methods>`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="input_buffer_max_size" type="int" setter="set_input_buffer_max_size" getter="get_input_buffer_max_size" default="65532">`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="output_buffer_max_size" type="int" setter="set_output_buffer_max_size" getter="get_output_buffer_max_size" default="65532">`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 21:22:15 +02:00			`<member name="stream_peer" type="StreamPeer" setter="set_stream_peer" getter="get_stream_peer">`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`The wrapped [StreamPeer] object.`
			`</member>`
			`</members>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<constants>`
			`</constants>`
			`</class>`