StreamPeer

Inherited By: , StreamPeerGDNative, , StreamPeerTCP

Category: Core

Abstraction and base class for stream-based protocols.

Properties

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.

• big_endian

If , 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.

• get_32 ( )

Get a signed 32 bit value from the stream.

• int get_64 ( )

Get a signed 64 bit value from the stream.

• 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.

• get_double ( )

• float get_float ( )

Get a single-precision float from the stream.

• get_partial_data ( int bytes )

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_string ( int bytes=-1 )

Get a string with byte-length from the stream. If bytes is negative (default) the length will be read from the stream using the reverse process of .

• int get_u16 ( )

Get an unsigned 16 bit value from the stream.

• get_u32 ( )

Get an unsigned 32 bit value from the stream.

• int get_u64 ( )

Get an unsigned 64 bit value from the stream.

• get_u8 ( )

Get an unsigned byte from the stream.

• String get_utf8_string ( bytes=-1 )

Get a utf8 string with byte-length bytes from the stream (this decodes the string sent as utf8). If is negative (default) the length will be read from the stream using the reverse process of put_utf8_string.

• get_var ( bool allow_objects=false )

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 ( value )

Put a signed 16 bit value into the stream.

• void put_32 ( int value )

Put a signed 64 bit value into the stream.

• void put_8 ( value )

Put a signed byte into the stream.

• Error put_data ( 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 ( value )

Put a single-precision float into the stream.

• Array put_partial_data ( 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 ( 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 ( 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 ( value )

• void put_var ( Variant value, full_objects=false )

Put a Variant into the stream. When is true encoding objects is allowed (and can potentially include code).