StreamPeer¶
Inherited By: StreamPeerBuffer, StreamPeerSSL, StreamPeerTCP
Category: Core
Brief Description¶
Abstraction and base class for stream-based protocols.
Member Functions¶
| 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 ) |
| int | get_u16 ( ) |
| int | get_u32 ( ) |
| int | get_u64 ( ) |
| int | get_u8 ( ) |
| String | get_utf8_string ( int bytes ) |
| Variant | get_var ( ) |
| bool | is_big_endian_enabled ( ) const |
| void | put_16 ( int val ) |
| void | put_32 ( int val ) |
| void | put_64 ( int val ) |
| void | put_8 ( int val ) |
| int | put_data ( PoolByteArray data ) |
| void | put_double ( float val ) |
| void | put_float ( float val ) |
| Array | put_partial_data ( PoolByteArray data ) |
| void | put_u16 ( int val ) |
| void | put_u32 ( int val ) |
| void | put_u64 ( int val ) |
| void | put_u8 ( int val ) |
| void | put_utf8_string ( String val ) |
| void | put_var ( Variant val ) |
| void | set_big_endian ( bool enable ) |
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.
Member Function Description¶
- 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
Return the amount of bytes this StreamPeer has available.
Return 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.
Return 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.
- 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 16 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).
- Variant get_var ( )
Get a Variant from the stream.
- bool is_big_endian_enabled ( ) const
Return whether this StreamPeer is using big-endian format.
- void put_16 ( int val )
Put a signed 16 bit value into the stream.
- void put_32 ( int val )
Put a signed 32 bit value into the stream.
- void put_64 ( int val )
Put a signed 64 bit value into the stream.
- void put_8 ( int val )
Put a signed byte into the stream.
- int 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 val )
Put a double-precision float into the stream.
- void put_float ( float val )
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_u16 ( int val )
Put an unsigned 16 bit value into the stream.
- void put_u32 ( int val )
Put an unsigned 32 bit value into the stream.
- void put_u64 ( int val )
Put an unsigned 64 bit value into the stream.
- void put_u8 ( int val )
Put an unsigned byte into the stream.
- void put_utf8_string ( String val )
Put a zero-terminated utf8 string into the stream.
- void put_var ( Variant val )
Put a Variant into the stream.
- void set_big_endian ( bool enable )
Set this StreamPeer to use big-endian format. Default is false.