StreamPeer¶
Inherited By: StreamPeerBuffer, StreamPeerGDNative, StreamPeerSSL, StreamPeerTCP
Category: Core
Brief Description¶
Abstraction and base class for stream-based protocols.
Properties¶
bool | big_endian |
Methods¶
int | get_16 ( ) |
int | get_32 ( ) |
int | get_64 ( ) |
int | get_8 ( ) |
int | get_available_bytes ( ) const |
Array | get_data ( int bytes ) |
float | get_double ( ) |
float | get_float ( ) |
Array | get_partial_data ( int bytes ) |
String | get_string ( int bytes=-1 ) |
int | get_u16 ( ) |
int | get_u32 ( ) |
int | get_u64 ( ) |
int | get_u8 ( ) |
String | get_utf8_string ( int bytes=-1 ) |
Variant | get_var ( bool allow_objects=false ) |
void | put_16 ( int value ) |
void | put_32 ( int value ) |
void | put_64 ( int value ) |
void | put_8 ( int value ) |
Error | put_data ( PoolByteArray data ) |
void | put_double ( float value ) |
void | put_float ( float value ) |
Array | put_partial_data ( PoolByteArray data ) |
void | put_string ( String value ) |
void | put_u16 ( int value ) |
void | put_u32 ( int value ) |
void | put_u64 ( int value ) |
void | put_u8 ( int value ) |
void | put_utf8_string ( String value ) |
void | put_var ( Variant value, bool full_objects=false ) |
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.
Property Descriptions¶
- bool big_endian
Setter | set_big_endian(value) |
Getter | is_big_endian_enabled() |
If true
, this StreamPeer
will using big-endian format for encoding and decoding.
Method Descriptions¶
- int get_16 ( )
Get a signed 16 bit value from the stream.
- int get_32 ( )
Get a signed 32 bit value from the stream.
- int get_64 ( )
Get a signed 64 bit value from the stream.
- int get_8 ( )
Get a signed byte from the stream.
- int get_available_bytes ( ) const
Returns the amount of bytes this StreamPeer
has available.
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 block until the desired amount is received. This function returns two values, an Error code and a data array.
- float get_double ( )
Get a double-precision float from the stream.
- float get_float ( )
Get a single-precision float from the stream.
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 Error code, and a data array.
Get a 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 put_string.
- int get_u16 ( )
Get an unsigned 16 bit value from the stream.
- int get_u32 ( )
Get an unsigned 32 bit value from the stream.
- int get_u64 ( )
Get an unsigned 64 bit value from the stream.
- int get_u8 ( )
Get an unsigned byte from the stream.
Get a utf8 string with byte-length bytes
from the stream (this decodes the string sent as utf8). If bytes
is negative (default) the length will be read from the stream using the reverse process of put_utf8_string.
Get a Variant from the stream. When allow_objects
is true
decoding objects is allowed.
WARNING: Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).
- void put_16 ( int value )
Put a signed 16 bit value into the stream.
- void put_32 ( int value )
Put a signed 32 bit value into the stream.
- void put_64 ( int value )
Put a signed 64 bit value into the stream.
- void put_8 ( int value )
Put a signed byte into the stream.
- Error put_data ( PoolByteArray data )
Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code.
- void put_double ( float value )
Put a double-precision float into the stream.
- void put_float ( float value )
Put a single-precision float into the stream.
- Array put_partial_data ( PoolByteArray data )
Send 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.
- void put_string ( String value )
Put a zero-terminated ascii string into the stream prepended by a 32 bits unsigned integer representing its size.
- void put_u16 ( int value )
Put an unsigned 16 bit value into the stream.
- void put_u32 ( int value )
Put an unsigned 32 bit value into the stream.
- void put_u64 ( int value )
Put an unsigned 64 bit value into the stream.
- void put_u8 ( int value )
Put an unsigned byte into the stream.
- void put_utf8_string ( String value )
Put a zero-terminated utf8 string into the stream prepended by a 32 bits unsigned integer representing its size.
Put a Variant into the stream. When full_objects
is true
encoding objects is allowed (and can potentially include code).