Welcome to the Godot Reference Fork and the Godot Proposals Fork alternatives. Why?

StreamPeer

0 0 vote
Article Rating

Inherits: Reference < Object

Inherited By: StreamPeerBuffer, StreamPeerGDNative, StreamPeerSSL, StreamPeerTCP

Abstraction and base class for stream-based protocols.

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.

Properties

boolbig_endianfalse

Methods

intget_16 ( )
intget_32 ( )
intget_64 ( )
intget_8 ( )
intget_available_bytes ( ) const
Arrayget_data ( int bytes )
floatget_double ( )
floatget_float ( )
Arrayget_partial_data ( int bytes )
Stringget_string ( int bytes=-1 )
intget_u16 ( )
intget_u32 ( )
intget_u64 ( )
intget_u8 ( )
Stringget_utf8_string ( int bytes=-1 )
Variantget_var ( bool allow_objects=false )
voidput_16 ( int value )
voidput_32 ( int value )
voidput_64 ( int value )
voidput_8 ( int value )
Errorput_data ( PoolByteArray data )
voidput_double ( float value )
voidput_float ( float value )
Arrayput_partial_data ( PoolByteArray data )
voidput_string ( String value )
voidput_u16 ( int value )
voidput_u32 ( int value )
voidput_u64 ( int value )
voidput_u8 ( int value )
voidput_utf8_string ( String value )
voidput_var ( Variant value, bool full_objects=false )

Property Descriptions

Defaultfalse
Setterset_big_endian(value)
Getteris_big_endian_enabled()

If true, this StreamPeer will using big-endian format for encoding and decoding.

Method Descriptions

Gets a signed 16-bit value from the stream.


Gets a signed 32-bit value from the stream.


Gets a signed 64-bit value from the stream.


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


Gets a double-precision float from the stream.


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


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

Gets an unsigned 16-bit value from the stream.


  • int get_u32 ( )

Gets an unsigned 32-bit value from the stream.


  • int get_u64 ( )

Gets an unsigned 64-bit value from the stream.


Gets an unsigned byte from the stream.


Gets an 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 put_utf8_string.


Gets a Variant from the stream. If allow_objects is true, decoding objects is allowed.

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.


  • void put_16 ( int value )

Puts a signed 16-bit value into the stream.


  • void put_32 ( int value )

Puts a signed 32-bit value into the stream.


  • void put_64 ( int value )

Puts a signed 64-bit value into the stream.


  • void put_8 ( int value )

Puts a signed byte into the stream.


Sends 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 )

Puts a double-precision float into the stream.


  • void put_float ( float value )

Puts a single-precision float into the stream.


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.


  • void put_string ( String value )

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 put_data:

put_data("Hello world".to_ascii())

  • void put_u16 ( int value )

Puts an unsigned 16-bit value into the stream.


  • void put_u32 ( int value )

Puts an unsigned 32-bit value into the stream.


  • void put_u64 ( int value )

Puts an unsigned 64-bit value into the stream.


  • void put_u8 ( int value )

Puts an unsigned byte into the stream.


  • void put_utf8_string ( String value )

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 put_data:

put_data("Hello world".to_utf8())

  • void put_var ( Variant value, bool full_objects=false )

Puts a Variant into the stream. If full_objects is true encoding objects is allowed (and can potentially include code).

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x