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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeer" inherits="Reference" version="3.2">
<brief_description>
Abstraction and base class for stream-based protocols.
</brief_description>
<description>
StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or UNIX sockets). It provides an API for sending and receiving data through streams as raw data or strings.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_16">
<return type="int">
</return>
<description>
Gets a signed 16-bit value from the stream.
</description>
</method>
<method name="get_32">
<return type="int">
</return>
<description>
Gets a signed 32-bit value from the stream.
</description>
</method>
<method name="get_64">
<return type="int">
</return>
<description>
Gets a signed 64-bit value from the stream.
</description>
</method>
<method name="get_8">
<return type="int">
</return>
<description>
Gets a signed byte from the stream.
</description>
</method>
<method name="get_available_bytes" qualifiers="const">
<return type="int">
</return>
<description>
Returns the amount of bytes this [StreamPeer] has available.
</description>
</method>
<method name="get_data">
<return type="Array">
</return>
<argument index="0" name="bytes" type="int">
</argument>
<description>
Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [code]bytes[/code] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array.
</description>
</method>
<method name="get_double">
<return type="float">
</return>
<description>
Gets a double-precision float from the stream.
</description>
</method>
<method name="get_float">
<return type="float">
</return>
<description>
Gets a single-precision float from the stream.
</description>
</method>
<method name="get_partial_data">
<return type="Array">
</return>
<argument index="0" name="bytes" type="int">
</argument>
<description>
Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array.
</description>
</method>
<method name="get_string">
<return type="String">
</return>
<argument index="0" name="bytes" type="int" default="-1">
</argument>
<description>
Gets a string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string].
</description>
</method>
<method name="get_u16">
<return type="int">
</return>
<description>
Gets an unsigned 16-bit value from the stream.
</description>
</method>
<method name="get_u32">
<return type="int">
</return>
<description>
Gets an unsigned 32-bit value from the stream.
</description>
</method>
<method name="get_u64">
<return type="int">
</return>
<description>
Gets an unsigned 64-bit value from the stream.
</description>
</method>
<method name="get_u8">
<return type="int">
</return>
<description>
Gets an unsigned byte from the stream.
</description>
</method>
<method name="get_utf8_string">
<return type="String">
</return>
<argument index="0" name="bytes" type="int" default="-1">
</argument>
<description>
Gets an UTF-8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as UTF-8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string].
</description>
</method>
<method name="get_var">
<return type="Variant">
</return>
<argument index="0" name="allow_objects" type="bool" default="false">
</argument>
<description>
Gets a Variant from the stream. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed.
[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
</description>
</method>
<method name="put_16">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts a signed 16-bit value into the stream.
</description>
</method>
<method name="put_32">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts a signed 32-bit value into the stream.
</description>
</method>
<method name="put_64">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts a signed 64-bit value into the stream.
</description>
</method>
<method name="put_8">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts a signed byte into the stream.
</description>
</method>
<method name="put_data">
<return type="int" enum="Error">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code.
</description>
</method>
<method name="put_double">
<return type="void">
</return>
<argument index="0" name="value" type="float">
</argument>
<description>
Puts a double-precision float into the stream.
</description>
</method>
<method name="put_float">
<return type="void">
</return>
<argument index="0" name="value" type="float">
</argument>
<description>
Puts a single-precision float into the stream.
</description>
</method>
<method name="put_partial_data">
<return type="Array">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent.
</description>
</method>
<method name="put_string">
<return type="void">
</return>
<argument index="0" name="value" type="String">
</argument>
<description>
Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size.
Note: To put an ASCII string without prepending its size, you can use [method put_data]:
[codeblock]
put_data("Hello world".to_ascii())
[/codeblock]
</description>
</method>
<method name="put_u16">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts an unsigned 16-bit value into the stream.
</description>
</method>
<method name="put_u32">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts an unsigned 32-bit value into the stream.
</description>
</method>
<method name="put_u64">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts an unsigned 64-bit value into the stream.
</description>
</method>
<method name="put_u8">
<return type="void">
</return>
<argument index="0" name="value" type="int">
</argument>
<description>
Puts an unsigned byte into the stream.
</description>
</method>
<method name="put_utf8_string">
<return type="void">
</return>
<argument index="0" name="value" type="String">
</argument>
<description>
Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size.
Note: To put an UTF-8 string without prepending its size, you can use [method put_data]:
[codeblock]
put_data("Hello world".to_utf8())
[/codeblock]
</description>
</method>
<method name="put_var">
<return type="void">
</return>
<argument index="0" name="value" type="Variant">
</argument>
<argument index="1" name="full_objects" type="bool" default="false">
</argument>
<description>
Puts a Variant into the stream. If [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code).
</description>
</method>
</methods>
<members>
<member name="big_endian" type="bool" setter="set_big_endian" getter="is_big_endian_enabled" default="false">
If [code]true[/code], this [StreamPeer] will using big-endian format for encoding and decoding.
</member>
</members>
<constants>
</constants>
</class>
|