summaryrefslogtreecommitdiff
path: root/doc/classes/PacketPeerStream.xml
blob: 38e2d9c1a1c1ac8d8def2735ead4b3f8435c4c0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<?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>