Class StreamPeer
Abstract base class for interacting with streams.
- Inheritance
-
StreamPeer
- Derived
Remarks
StreamPeer is an abstract base class mostly used for stream-based protocols (such as TCP). It provides an API for sending and receiving data through streams as raw data or strings.
Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
Properties
big_endian
If true, this StreamPeer will using big-endian format for encoding and decoding.
var big_endian : bool = falseProperty Value
Remarks
Methods
get_8
Gets a signed byte from the stream.
int get_8get_16
Gets a signed 16-bit value from the stream.
int get_16get_32
Gets a signed 32-bit value from the stream.
int get_32get_64
Gets a signed 64-bit value from the stream.
int get_64get_available_bytes
Qualifiers: const
Returns the number of bytes this StreamPeer has available.
int get_available_bytesget_data(int)
Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the bytes argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array.
Array get_data(int bytes)Parameters
bytesint
get_double
Gets a double-precision float from the stream.
float get_doubleget_float
Gets a single-precision float from the stream.
float get_floatget_half
Gets a half-precision float from the stream.
float get_halfget_partial_data(int)
Returns a chunk data with the received bytes. The number 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 Error code, and a data array.
Array get_partial_data(int bytes)Parameters
bytesint
get_string(int)
Gets an ASCII string with byte-length bytes from the stream. If bytes is negative (default) the length will be read from the stream using the reverse process of StreamPeer.put_string.
String get_string(int bytes)Parameters
bytesint
get_u8
Gets an unsigned byte from the stream.
int get_u8get_u16
Gets an unsigned 16-bit value from the stream.
int get_u16get_u32
Gets an unsigned 32-bit value from the stream.
int get_u32get_u64
Gets an unsigned 64-bit value from the stream.
int get_u64get_utf8_string(int)
Gets a UTF-8 string with byte-length bytes from the stream (this decodes the string sent as UTF-8). If bytes is negative (default) the length will be read from the stream using the reverse process of StreamPeer.put_utf8_string.
String get_utf8_string(int bytes)Parameters
bytesint
get_var(bool)
Gets a Variant from the stream. If allow_objects is true, decoding objects is allowed.
Internally, this uses the same decoding mechanism as the @GlobalScope.bytes_to_var method.
Warning: 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.
Variant get_var(bool allow_objects)Parameters
allow_objectsbool
put_8(int)
Puts a signed byte into the stream.
void put_8(int value)Parameters
valueint
put_16(int)
Puts a signed 16-bit value into the stream.
void put_16(int value)Parameters
valueint
put_32(int)
Puts a signed 32-bit value into the stream.
void put_32(int value)Parameters
valueint
put_64(int)
Puts a signed 64-bit value into the stream.
void put_64(int value)Parameters
valueint
put_data(PackedByteArray)
Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code.
int put_data(PackedByteArray data)Parameters
dataPackedByteArray
put_double(float)
Puts a double-precision float into the stream.
void put_double(float value)Parameters
valuefloat
put_float(float)
Puts a single-precision float into the stream.
void put_float(float value)Parameters
valuefloat
put_half(float)
Puts a half-precision float into the stream.
void put_half(float value)Parameters
valuefloat
put_partial_data(PackedByteArray)
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 Error code and an integer, describing how much data was actually sent.
Array put_partial_data(PackedByteArray data)Parameters
dataPackedByteArray
put_string(String)
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 StreamPeer.put_data:
void put_string(String value)Parameters
valueString
put_u8(int)
Puts an unsigned byte into the stream.
void put_u8(int value)Parameters
valueint
put_u16(int)
Puts an unsigned 16-bit value into the stream.
void put_u16(int value)Parameters
valueint
put_u32(int)
Puts an unsigned 32-bit value into the stream.
void put_u32(int value)Parameters
valueint
put_u64(int)
Puts an unsigned 64-bit value into the stream.
void put_u64(int value)Parameters
valueint
put_utf8_string(String)
Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size.
Note: To put a UTF-8 string without prepending its size, you can use StreamPeer.put_data:
void put_utf8_string(String value)Parameters
valueString
put_var(Variant, bool)
Puts a Variant into the stream. If full_objects is true encoding objects is allowed (and can potentially include code).
Internally, this uses the same encoding mechanism as the @GlobalScope.var_to_bytes method.
void put_var(Variant value, bool full_objects)