跳转至

StreamPeer

继承

Reference

简要描述

基于流的协议的抽象和基类。

描述

StreamPeer是基于流的协议(例如TCP或UNIX套接字)的抽象和基类。

成员

类型 属性名 默认值
bool big_endian false

方法

返回值类型 方法名称
int get_16()
int get_32()
int get_64()
int get_8()
int get_available_bytes() const
Array get_data(bytes: int)
float get_double()
float get_float()
Array get_partial_data(bytes: int)
String get_string(bytes: int = -1)
int get_u16()
int get_u32()
int get_u64()
int get_u8()
String get_utf8_string(bytes: int = -1)
Variant get_var(allow_objects: bool = false)
void put_16(value: int)
void put_32(value: int)
void put_64(value: int)
void put_8(value: int)
int put_data(data: PoolByteArray)
void put_double(value: float)
void put_float(value: float)
Array put_partial_data(data: PoolByteArray)
void put_string(value: String)
void put_u16(value: int)
void put_u32(value: int)
void put_u64(value: int)
void put_u8(value: int)
void put_utf8_string(value: String)
void put_var(value: Variant, full_objects: bool = false)

常量

成员说明

  • bool big_endian
Default false
setter set_big_endian(value)
getter is_big_endian_enabled

方法说明

  • get_16 get_16()

从流中获取一个带符号的16位值。


  • get_32 get_32()

从流中获取一个带符号的32位值。


  • get_64 get_64()

从流中获取一个带符号的64位值。


  • get_8 get_8()

从流中获取一个带符号的字节。


  • get_available_bytes get_available_bytes() const

返回此StreamPeer可用的字节数。


  • get_data get_data(bytes: int)

返回带有bytes数目字节的块数据。


  • get_double get_double()

从流中获取双精度浮点数。


  • get_float get_float()

从流中获取单精度浮点数。


  • get_partial_data get_partial_data(bytes: int)

返回带有bytes数目字节的块数据。


  • get_string get_string(bytes: int = -1)

从流中获取字节长度为bytes的字符串。


  • get_u16 get_u16()

从流中获取一个无符号的16位值。


  • get_u32 get_u32()

从流中获取一个无符号的32位值。


  • get_u64 get_u64()

从流中获取一个无符号的64位值。


  • get_u8 get_u8()

从流中获取一个无符号字节。


  • get_utf8_string get_utf8_string(bytes: int = -1)

从流中获取字节长度为bytes的UTF-8字符串(此字符串将解码为UTF-8的字符串)。


  • get_var get_var(allow_objects: bool = false)

从流中获取一个Variant。

**警告:**反序列化的对象可以包含要执行的代码。


  • put_16 put_16(value: int)

将带符号的16位值放入流中。


  • put_32 put_32(value: int)

将带符号的32位值放入流中。


  • put_64 put_64(value: int)

将带符号的64位值放入流中。


  • put_8 put_8(value: int)

将一个带符号的字节放入流中。


  • put_data put_data(data: PoolByteArray)

通过连接发送大量数据,必要时阻止直到数据发送完成。


  • put_double put_double(value: float)

将双精度浮点数放入流中。


  • put_float put_float(value: float)

将单精度浮点数放入流中。


  • put_partial_data put_partial_data(data: PoolByteArray)

通过连接发送数据块。


  • put_string put_string(value: String)

将一个以零结尾的ASCII字符串放入流中,该字符串前面是一个32位无符号整数,该整数表示其大小。

注意:要放置ASCII字符串而不加大小,可以使用put_data

put_data("Hello world".to_ascii())

  • put_u16 put_u16(value: int)

将无符号的16位值放入流中。


  • put_u32 put_u32(value: int)

将无符号的32位值放入流中。


  • put_u64 put_u64(value: int)

将无符号的64位值放入流中。


  • put_u8 put_u8(value: int)

将无符号字节放入流中。


  • put_utf8_string put_utf8_string(value: String)

将一个以零结尾的UTF-8字符串放入流中,该字符串前面是一个32位无符号整数,该整数表示其大小。

注意:要放置UTF-8字符串而不加大小,可以使用put_data

put_data("Hello world".to_utf8())

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

将Variant放入流中。