StreamPeerTLS

继承: StreamPeer < RefCounted < Object

处理 TLS 连接的流对等体。

描述

处理 TLS 连接的流对等体。此对象可用于连接到 TLS 服务器或接受单个 TLS 客户端连接。

注意:当导出到 Android 时,确保在导出项目或使用一键部署之前,在 Android 导出预设中启用 INTERNET 权限。否则,任何形式的网络通信都会被 Android 阻止。

教程

方法

Error

accept_stream(stream: StreamPeer, server_options: TLSOptions)

Error

connect_to_stream(stream: StreamPeer, common_name: String, client_options: TLSOptions = null)

void

disconnect_from_stream()

Status

get_status() const

StreamPeer

get_stream() const

void

poll()


枚举

enum Status: 🔗

Status STATUS_DISCONNECTED = 0

状态,表示 StreamPeerTLS 已断开连接。

Status STATUS_HANDSHAKING = 1

状态,表示 StreamPeerTLS 处于握手阶段。

Status STATUS_CONNECTED = 2

状态,表示 StreamPeerTLS 已连接至主机。

Status STATUS_ERROR = 3

状态,表示 StreamPeerTLS 处于出错状态。

Status STATUS_ERROR_HOSTNAME_MISMATCH = 4

错误状态,表示主机的 TLS 证书域名与请求验证的域名不匹配。


方法说明

Error accept_stream(stream: StreamPeer, server_options: TLSOptions) 🔗

以服务器的身份接受对等体连接,使用给定的服务器选项 server_options。见 TLSOptions.server


Error connect_to_stream(stream: StreamPeer, common_name: String, client_options: TLSOptions = null) 🔗

使用底层 StreamPeer stream 连接到对等体,并对远程证书是否由给定的 common_name 签名进行验证。传入 client_options 可以自定义信任的证书颁发机构,也可以禁用通用名称验证。见 TLSOptions.clientTLSOptions.client_unsafe


void disconnect_from_stream() 🔗

与主机断开连接。


Status get_status() const 🔗

返回连接的状态。取值见 Status


StreamPeer get_stream() const 🔗

返回底层 StreamPeer 连接,在 accept_streamconnect_to_stream 中使用。


void poll() 🔗

轮询连接以检查传入的字节。在 StreamPeer.get_available_bytes 之前调用它以使其正常工作。