diff --git a/zh-cn/application-dev/reference/apis/js-apis-socket.md b/zh-cn/application-dev/reference/apis/js-apis-socket.md index b7f2263fee241e2056b2db61d936c4b645016272..435fec85b1f462c0404badec4c695ddeed045173 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-socket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-socket.md @@ -22,8 +22,8 @@ constructUDPSocketInstance(): UDPSocket **返回值：** -| 类型 | 说明 | -| :---------------------- | :---------------------- | +| 类型 | 说明 | +| :--------------------------------- | :---------------------- | | [UDPSocket](#udpsocket) | 返回一个UDPSocket对象。 | **示例：** @@ -48,17 +48,17 @@ bind(address: NetAddress, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | --------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | | address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -85,16 +85,16 @@ bind(address: NetAddress): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------- | ---- | --------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | | address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **返回值：** @@ -128,17 +128,17 @@ send(options: UDPSendOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------- | ---- | ---------------------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数，参考[UDPSendOptions](#udpsendoptions)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -174,16 +174,16 @@ send(options: UDPSendOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------- | ---- | ---------------------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数，参考[UDPSendOptions](#udpsendoptions)。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **返回值：** @@ -282,15 +282,15 @@ getState(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------------------- | ---- | ---------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------ | ---- | ---------- | | callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -327,8 +327,8 @@ getState(): Promise\ **返回值：** -| 类型 | 说明 | -| :--------------------------------------------- | :----------------------------------------- | +| 类型 | 说明 | +| :----------------------------------------------- | :----------------------------------------- | | Promise\<[SocketStateBase](#socketstatebase)\> | 以Promise形式返回获取UDPSocket状态的结果。 | **示例：** @@ -366,17 +366,17 @@ setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性，参考[UDPExtraOptions](#udpextraoptions)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -419,8 +419,8 @@ setExtraOptions(options: UDPExtraOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性，参考[UDPExtraOptions](#udpextraoptions)。 | **返回值：** @@ -431,10 +431,10 @@ setExtraOptions(options: UDPExtraOptions): Promise\ **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -655,7 +655,7 @@ udp.off('error'); **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------------------------------------------------------------ | | address | string | 是 | 本地绑定的ip地址。 | | port | number | 否 | 端口号 ，范围0~65535。如果不指定系统随机分配端口。 | @@ -667,10 +667,10 @@ UDPSocket发送参数。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ---------------------------------- | ---- | -------------- | -| data | string \| ArrayBuffer7+ | 是 | 发送的数据。 | -| address | [NetAddress](#netaddress) | 是 | 目标地址信息。 | +| data | string \| ArrayBuffer7+ | 是 | 发送的数据。 | +| address | [NetAddress](#netaddress) | 是 | 目标地址信息。 | ## UDPExtraOptions7+ @@ -678,12 +678,12 @@ UDPSocket连接的其他属性。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | -| ----------------- | ------- | ---- | ----------------------------------------- | -| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 | +| 名称 | 类型 | 必填 | 说明 | +| ----------------- | ------- | ---- | -------------------------------- | +| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 | | receiveBufferSize | number | 否 | 接收缓冲区大小（单位：Byte），默认为0。 | | sendBufferSize | number | 否 | 发送缓冲区大小（单位：Byte），默认为0。 | -| reuseAddress | boolean | 否 | 是否重用地址。默认为false。 | +| reuseAddress | boolean | 否 | 是否重用地址。默认为false。 | | socketTimeout | number | 否 | 套接字超时时间，单位毫秒（ms），默认为0。 | ## SocketStateBase7+ @@ -692,7 +692,7 @@ Socket的状态信息。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------- | ------- | ---- | ---------- | | isBound | boolean | 是 | 是否绑定。 | | isClose | boolean | 是 | 是否关闭。 | @@ -704,7 +704,7 @@ Socket的连接信息。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------------------------------------------------------------ | | address | string | 是 | 本地绑定的ip地址。 | | family | string | 是 | 网络协议类型，可选类型：
- IPv4
- IPv6
默认为IPv4。 | @@ -727,8 +727,8 @@ constructTCPSocketInstance(): TCPSocket **返回值：** -| 类型 | 说明 | -| :---------------------- | :---------------------- | +| 类型 | 说明 | + | :--------------------------------- | :---------------------- | | [TCPSocket](#tcpsocket) | 返回一个TCPSocket对象。 | **示例：** @@ -756,17 +756,17 @@ bind(address: NetAddress, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | --------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | | address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -796,8 +796,8 @@ bind(address: NetAddress): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------- | ---- | --------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | | address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | **返回值：** @@ -808,10 +808,10 @@ bind(address: NetAddress): Promise\ **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -840,17 +840,17 @@ connect(options: TCPConnectOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPConnectOptions](#tcpconnectoptions) | 是 | TCPSocket连接的参数，参考[TCPConnectOptions](#tcpconnectoptions)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -877,8 +877,8 @@ connect(options: TCPConnectOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPConnectOptions](#tcpconnectoptions) | 是 | TCPSocket连接的参数，参考[TCPConnectOptions](#tcpconnectoptions)。 | **返回值：** @@ -889,10 +889,10 @@ connect(options: TCPConnectOptions): Promise\ **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -921,17 +921,17 @@ send(options: TCPSendOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPSendOptions](#tcpsendoptions) | 是 | TCPSocket发送请求的参数，参考[TCPSendOptions](#tcpsendoptions)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -967,8 +967,8 @@ send(options: TCPSendOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPSendOptions](#tcpsendoptions) | 是 | TCPSocket发送请求的参数，参考[TCPSendOptions](#tcpsendoptions)。 | **返回值：** @@ -979,10 +979,10 @@ send(options: TCPSendOptions): Promise\ **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -1022,9 +1022,9 @@ close(callback: AsyncCallback\): void **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -1057,9 +1057,9 @@ close(): Promise\ **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -1088,15 +1088,15 @@ getRemoteAddress(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ---------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------- | ---- | ---------- | | callback | AsyncCallback<[NetAddress](#netaddress)> | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -1129,15 +1129,15 @@ getRemoteAddress(): Promise\ **返回值：** -| 类型 | 说明 | -| :--------------------------------- | :------------------------------------------ | +| 类型 | 说明 | +| :------------------------------------------ | :------------------------------------------ | | Promise<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -1172,15 +1172,15 @@ getState(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------------------- | ---- | ---------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------ | ---- | ---------- | | callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -1213,15 +1213,15 @@ getState(): Promise\ **返回值：** -| 类型 | 说明 | -| :------------------------------------------- | :----------------------------------------- | +| 类型 | 说明 | +| :----------------------------------------------- | :----------------------------------------- | | Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TCPSocket状态的结果。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 201 | Permission denied. | **示例：** @@ -1254,8 +1254,8 @@ getSocketFd(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------ | ---- | ---------- | | callback | AsyncCallback\ | 是 | 回调函数，当成功时，返回socket的文件描述符，失败时，返回undefined。 | **示例：** @@ -1294,8 +1294,8 @@ getSocketFd(): Promise\ **返回值：** -| 类型 | 说明 | -| :---------------- | :------------------------------------ | +| 类型 | 说明 | +| :----------------------------------------------- | :----------------------------------------- | | Promise\ | 以Promise形式返回socket的文件描述符。 | **示例：** @@ -1337,17 +1337,17 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#tcpextraoptions)。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -1389,8 +1389,8 @@ setExtraOptions(options: TCPExtraOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#tcpextraoptions)。 | **返回值：** @@ -1401,10 +1401,10 @@ setExtraOptions(options: TCPExtraOptions): Promise\ **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------ | -| 401 | Parameter error. | -| 201 | Permission denied. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | **示例：** @@ -1628,10 +1628,10 @@ TCPSocket连接的参数。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | -| ------- | ------------------------- | ---- | -------------------------- | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------- | ---- | -------------------------- | | address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 | -| timeout | number | 否 | 超时时间，单位毫秒（ms）。 | +| timeout | number | 否 | 超时时间，单位毫秒（ms）。 | ## TCPSendOptions7+ @@ -1639,10 +1639,10 @@ TCPSocket发送请求的参数。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | -| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | -| data | string\| ArrayBuffer7+ | 是 | 发送的数据。 | -| encoding | string | 否 | 字符编码(UTF-8，UTF-16BE，UTF-16LE，UTF-16，US-AECII，ISO-8859-1)，默认为UTF-8。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| data | string\| ArrayBuffer7+ | 是 | 发送的数据。 | +| encoding | string | 否 | 字符编码(UTF-8，UTF-16BE，UTF-16LE，UTF-16，US-AECII，ISO-8859-1)，默认为UTF-8。 | ## TCPExtraOptions7+ @@ -1650,16 +1650,16 @@ TCPSocket连接的其他属性。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ----------------- | ------- | ---- | ------------------------------------------------------------ | | keepAlive | boolean | 否 | 是否保持连接。默认为false。 | | OOBInline | boolean | 否 | 是否为OOB内联。默认为false。 | | TCPNoDelay | boolean | 否 | TCPSocket连接是否无时延。默认为false。 | | socketLinger | Object | 是 | socket是否继续逗留。
- on：是否逗留（true：逗留；false：不逗留）。
- linger：逗留时长，单位毫秒（ms），取值范围为0~65535。
当入参on设置为true时，才需要设置。 | -| receiveBufferSize | number | 否 | 接收缓冲区大小（单位：Byte），默认为0。 | -| sendBufferSize | number | 否 | 发送缓冲区大小（单位：Byte），默认为0。 | +| receiveBufferSize | number | 否 | 接收缓冲区大小（单位：Byte），默认为0。 | +| sendBufferSize | number | 否 | 发送缓冲区大小（单位：Byte），默认为0。 | | reuseAddress | boolean | 否 | 是否重用地址。默认为false。 | -| socketTimeout | number | 否 | 套接字超时时间，单位毫秒（ms），默认为0。 | +| socketTimeout | number | 否 | 套接字超时时间，单位毫秒（ms），默认为0。 | ## socket.constructTCPSocketServerInstance10+ @@ -1671,8 +1671,8 @@ constructTCPSocketServerInstance(): TCPSocketServer **返回值：** -| 类型 | 说明 | -| :------------------------------------ | :---------------------------- | +| 类型 | 说明 | +| :---------------------------------- | :---------------------------- | | [TCPSocketServer](#tcpsocketserver10) | 返回一个TCPSocketServer对象。 | **示例：** @@ -1700,10 +1700,10 @@ listen(address: NetAddress, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------- | ---- | -------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | --------------------------------------------- | | address | [NetAddress](#netaddress7) | 是 | 目标地址信息。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** @@ -1745,15 +1745,15 @@ listen(address: NetAddress): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | -------------------------- | ---- | -------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------------- | ---- | --------------------------------------------- | | address | [NetAddress](#netaddress7) | 是 | 目标地址信息。 | **返回值：** -| 类型 | 说明 | -| :-------------- | :------------------------------------------------------ | -| Promise\ | 以Promise形式返回, 成功返回空，失败返回错误码错误信息。 | +| 类型 | 说明 | +| :-------------- | :----------------------------------------------------------- | +| Promise\ | 以Promise形式返回, 成功返回空，失败返回错误码错误信息。| **错误码：** @@ -1794,8 +1794,8 @@ getState(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------------- | ---- | ---------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------------- | ---- | ---------- | | callback | AsyncCallback<[SocketStateBase](#socketstatebase7)> | 是 | 回调函数。 | **错误码：** @@ -1842,8 +1842,8 @@ getState(): Promise\ **返回值：** -| 类型 | 说明 | -| :-------------------------------------------- | :----------------------------------------- | +| 类型 | 说明 | +| :------------------------------------------- | :----------------------------------------- | | Promise<[SocketStateBase](#socketstatebase7)> | 以Promise形式返回获取TCPSocket状态的结果。 | **错误码：** @@ -1887,10 +1887,10 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------ | ---- | ------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPExtraOptions](#tcpextraoptions7) | 是 | TCPSocketServer连接的其他属性。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** @@ -1945,14 +1945,14 @@ setExtraOptions(options: TCPExtraOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------------------ | ---- | ------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPExtraOptions](#tcpextraoptions7) | 是 | TCPSocketServer连接的其他属性。 | **返回值：** -| 类型 | 说明 | -| :-------------- | :------------------------------------------------------ | +| 类型 | 说明 | +| :-------------- | :--------------------------------------------------------- | | Promise\ | 以Promise形式返回，成功返回空，失败返回错误码错误信息。 | **错误码：** @@ -2004,9 +2004,9 @@ on(type: 'connect', callback: Callback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------- | -| type | string | 是 | 订阅的事件类型。'connect'：连接事件。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------------------------- | +| type | string | 是 | 订阅的事件类型。'connect'：连接事件。 | | callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 是 | 回调函数。 | **错误码：** @@ -2037,9 +2037,9 @@ off(type: 'connect', callback?: Callback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------- | -| type | string | 是 | 订阅的事件类型。'connect'：连接事件。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------------------------- | +| type | string | 是 | 订阅的事件类型。'connect'：连接事件。 | | callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 否 | 回调函数。 | **错误码：** @@ -2142,8 +2142,8 @@ TCPSocketConnection连接，即TCPSocket客户端与服务端的连接。在调 ### 属性 -| 名称 | 类型 | 必填 | 说明 | -| -------- | ------ | ---- | ------------------------------------- | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ----------------------------------------- | | clientId | number | 是 | 客户端与TCPSocketServer建立连接的id。 | ### send10+ @@ -2161,10 +2161,10 @@ send(options: TCPSendOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------- | ---- | ----------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPSendOptions](#tcpsendoptions7) | 是 | TCPSocketConnection发送请求的参数。 | -| callback | AsyncCallback\ | 是 | 回调函数。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | **错误码：** @@ -2204,14 +2204,14 @@ send(options: TCPSendOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------- | ---- | ----------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPSendOptions](#tcpsendoptions7) | 是 | TCPSocketConnection发送请求的参数。 | **返回值：** -| 类型 | 说明 | -| :-------------- | :------------------------------------------------------ | +| 类型 | 说明 | +| :-------------- | :----------------------------------------------------------- | | Promise\ | 以Promise形式返回，成功返回空，失败返回错误码错误信息。 | **错误码：** @@ -2287,8 +2287,8 @@ close(): Promise\ **返回值：** -| 类型 | 说明 | -| :-------------- | :------------------------------------------------------ | +| 类型 | 说明 | +| :-------------- | :------------------------------------------- | | Promise\ | 以Promise形式返回，成功返回空，失败返回错误码错误信息。 | **错误码：** @@ -2327,8 +2327,8 @@ getRemoteAddress(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------- | ---- | ---------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------- | | callback | AsyncCallback<[NetAddress](#netaddress7)> | 是 | 回调函数。 | **错误码：** @@ -2370,8 +2370,8 @@ getRemoteAddress(): Promise\ **返回值：** -| 类型 | 说明 | -| :---------------------------------- | :------------------------------------------ | +| 类型 | 说明 | +| :--------------------------------- | :------------------------------------------ | | Promise<[NetAddress](#netaddress7)> | 以Promise形式返回获取对端socket地址的结果。 | **错误码：** @@ -2406,10 +2406,10 @@ on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: Socket **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | -| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 是 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 是 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 | **错误码：** @@ -2448,10 +2448,10 @@ off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: Sock **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | -| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 否 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 否 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 | **错误码：** @@ -2639,8 +2639,8 @@ constructTLSSocketInstance(): TLSSocket **返回值:** -| 类型 | 说明 | -| :----------------------- | :---------------------- | +| 类型 | 说明 | +| :--------------------------------- | :---------------------- | | [TLSSocket](#tlssocket9) | 返回一个TLSSocket对象。 | **示例：** @@ -2665,19 +2665,19 @@ bind(address: NetAddress, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | ------------------------------------------------------------ | -| address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | -| callback | AsyncCallback\ | 是 | 回调函数。成功返回TLSSocket绑定本机的IP地址和端口的结果。 失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | +| address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | +| callback | AsyncCallback\ | 是 | 回调函数。成功返回TLSSocket绑定本机的IP地址和端口的结果。 失败返回错误码，错误信息。| **错误码：** -| 错误码ID | 错误信息 | -| -------- | ----------------------- | -| 401 | Parameter error. | -| 201 | Permission denied. | -| 2303198 | Address already in use. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | +| 2303198 | Address already in use. | +| 2300002 | System internal error. | **示例：** @@ -2703,24 +2703,24 @@ bind(address: NetAddress): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------------- | ---- | --------------------------------------------- | -| address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | +| address | [NetAddress](#netaddress) | 是 | 目标地址信息，参考[NetAddress](#netaddress)。 | **返回值：** -| 类型 | 说明 | -| :-------------- | :----------------------------------------------------------- | +| 类型 | 说明 | +| :-------------- | :------------------------------------------------------- | | Promise\ | 以Promise形式返回TLSSocket绑定本机的IP地址和端口的结果。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ----------------------- | -| 401 | Parameter error. | -| 201 | Permission denied. | -| 2303198 | Address already in use. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ----------------------- | +| 401 | Parameter error. | +| 201 | Permission denied. | +| 2303198 | Address already in use. | +| 2300002 | System internal error. | **示例：** @@ -2743,16 +2743,16 @@ getState(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------------- | ---- | ---------------------------------------------------------- | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------ | ---- | ---------- | | callback | AsyncCallback\<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。成功返回TLSSocket状态，失败返回错误码,错误信息。 | **错误码：** | 错误码ID | 错误信息 | -| -------- | ------------------------------- | -| 2303188 | Socket operation on non-socket. | -| 2300002 | System internal error. | +| ------- | ------------------------------ | +| 2303188 | Socket operation on non-socket.| +| 2300002 | System internal error. | **示例：** @@ -2783,16 +2783,16 @@ getState(): Promise\ **返回值：** -| 类型 | 说明 | -| :-------------------------------------------- | :----------------------------------------------------------- | -| Promise\<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TLSSocket状态的结果。失败返回错误码，错误信息。 | +| 类型 | 说明 | +| :----------------------------------------------- | :----------------------------------------- | +| Promise\<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TLSSocket状态的结果。失败返回错误码，错误信息。| **错误码：** | 错误码ID | 错误信息 | -| -------- | ------------------------------- | -| 2303188 | Socket operation on non-socket. | -| 2300002 | System internal error. | +| ------- | ------------------------------ | +| 2303188 | Socket operation on non-socket.| +| 2300002 | System internal error. | **示例：** @@ -2821,18 +2821,18 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#tcpextraoptions)。 | -| callback | AsyncCallback\ | 是 | 回调函数。成功返回设置TCPSocket连接的其他属性的结果，失败返回错误码，错误信息。 | +| callback | AsyncCallback\ | 是 | 回调函数。成功返回设置TCPSocket连接的其他属性的结果，失败返回错误码，错误信息。| **错误码：** | 错误码ID | 错误信息 | -| -------- | ------------------------------- | -| 401 | Parameter error. | -| 2303188 | Socket operation on non-socket. | -| 2300002 | System internal error. | +| ------- | ----------------------------- | +| 401 | Parameter error. | +| 2303188 | Socket operation on non-socket.| +| 2300002 | System internal error. | **示例：** @@ -2873,23 +2873,23 @@ setExtraOptions(options: TCPExtraOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ----------------------------------- | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#tcpextraoptions)。 | **返回值：** -| 类型 | 说明 | -| :-------------- | :----------------------------------------------------------- | +| 类型 | 说明 | +| :-------------- | :--------------------------------------------------- | | Promise\ | 以Promise形式返回设置TCPSocket连接的其他属性的结果。失败返回错误码，错误信息。 | **错误码：** | 错误码ID | 错误信息 | -| -------- | ------------------------------- | -| 401 | Parameter error. | -| 2303188 | Socket operation on non-socket. | -| 2300002 | System internal error. | +| ------- | ------------------------------ | +| 401 | Parameter error. | +| 2303188 | Socket operation on non-socket.| +| 2300002 | System internal error. | **示例：** @@ -2928,9 +2928,9 @@ on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: Socket **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | | callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 | **示例：** @@ -2962,9 +2962,9 @@ off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: Soc **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 | **示例：** @@ -3113,30 +3113,30 @@ connect(options: TLSConnectOptions, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------------------------------ | -| options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | TLSSocket连接所需要的参数。 | -| callback | AsyncCallback\ | 是 | 回调函数，成功无返回，失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------| ----| --------------- | +| options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | TLSSocket连接所需要的参数。| +| callback | AsyncCallback\ | 是 | 回调函数，成功无返回，失败返回错误码，错误信息。| **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------------------------------- | -| 401 | Parameter error. | -| 2303104 | Interrupted system call. | -| 2303109 | Bad file number. | -| 2303111 | Resource temporarily unavailable try again. | -| 2303188 | Socket operation on non-socket. | -| 2303191 | Protocol wrong type for socket. | -| 2303198 | Address already in use. | -| 2303199 | Cannot assign requested address. | -| 2303210 | Connection timed out. | -| 2303501 | SSL is null. | -| 2303502 | Error in tls reading. | -| 2303503 | Error in tls writing | -| 2303505 | Error occurred in the tls system call. | -| 2303506 | Error clearing tls connection. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 401 | Parameter error. | +| 2303104 | Interrupted system call. | +| 2303109 | Bad file number. | +| 2303111 | Resource temporarily unavailable try again. | +| 2303188 | Socket operation on non-socket. | +| 2303191 | Protocol wrong type for socket. | +| 2303198 | Address already in use. | +| 2303199 | Cannot assign requested address. | +| 2303210 | Connection timed out. | +| 2303501 | SSL is null. | +| 2303502 | Error in tls reading. | +| 2303503 | Error in tls writing | +| 2303505 | Error occurred in the tls system call. | +| 2303506 | Error clearing tls connection. | +| 2300002 | System internal error. | **示例：** @@ -3207,35 +3207,35 @@ connect(options: TLSConnectOptions): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ------------------ | -| options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | 连接所需要的参数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------| ----| --------------- | +| options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | 连接所需要的参数。| **返回值：** -| 类型 | 说明 | -| --------------- | --------------------------------------------------------- | -| Promise\ | 以Promise形式返回，成功无返回，失败返回错误码，错误信息。 | +| 类型 | 说明 | +| ------------------------------------------- | ----------------------------- | +| Promise\ | 以Promise形式返回，成功无返回，失败返回错误码，错误信息。| **错误码：** -| 错误码ID | 错误信息 | -| -------- | ------------------------------------------- | -| 401 | Parameter error. | -| 2303104 | Interrupted system call. | -| 2303109 | Bad file number. | -| 2303111 | Resource temporarily unavailable try again. | -| 2303188 | Socket operation on non-socket. | -| 2303191 | Protocol wrong type for socket. | -| 2303198 | Address already in use. | -| 2303199 | Cannot assign requested address. | -| 2303210 | Connection timed out. | -| 2303501 | SSL is null. | -| 2303502 | Error in tls reading. | -| 2303503 | Error in tls writing | -| 2303505 | Error occurred in the tls system call. | -| 2303506 | Error clearing tls connection. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 401 | Parameter error. | +| 2303104 | Interrupted system call. | +| 2303109 | Bad file number. | +| 2303111 | Resource temporarily unavailable try again. | +| 2303188 | Socket operation on non-socket. | +| 2303191 | Protocol wrong type for socket. | +| 2303198 | Address already in use. | +| 2303199 | Cannot assign requested address. | +| 2303210 | Connection timed out. | +| 2303501 | SSL is null. | +| 2303502 | Error in tls reading. | +| 2303503 | Error in tls writing | +| 2303505 | Error occurred in the tls system call. | +| 2303506 | Error clearing tls connection. | +| 2300002 | System internal error. | **示例：** @@ -3308,16 +3308,16 @@ getRemoteAddress(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------- | ---- | ---------- | | callback | AsyncCallback\<[NetAddress](#netaddress)\> | 是 | 回调函数。成功返回对端的socket地址，失败返回错误码，错误信息。 | **错误码：** | 错误码ID | 错误信息 | -| -------- | ------------------------------- | -| 2303188 | Socket operation on non-socket. | -| 2300002 | System internal error. | +| ------- | ----------------------------- | +| 2303188 | Socket operation on non-socket.| +| 2300002 | System internal error. | **示例：** @@ -3341,16 +3341,16 @@ getRemoteAddress(): Promise\ **返回值：** -| 类型 | 说明 | -| :---------------------------------- | :----------------------------------------------------------- | +| 类型 | 说明 | +| :------------------------------------------ | :------------------------------------------ | | Promise\<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。失败返回错误码，错误信息。 | **错误码：** | 错误码ID | 错误信息 | -| -------- | ------------------------------- | -| 2303188 | Socket operation on non-socket. | -| 2300002 | System internal error. | +| ------- | ------------------------------ | +| 2303188 | Socket operation on non-socket.| +| 2300002 | System internal error. | **示例：** @@ -3373,17 +3373,17 @@ getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------- | ---- | -------------------------------------------------------- | -| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数，成功返回本地的证书，失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------| ---- | ---------------| +| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数，成功返回本地的证书，失败返回错误码，错误信息。| **错误码：** -| 错误码ID | 错误信息 | -| -------- | ---------------------- | -| 2303501 | SSL is null. | -| 2303504 | Error looking up x509. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2303504 | Error looking up x509. | +| 2300002 | System internal error. | **示例：** @@ -3407,17 +3407,17 @@ getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\> **返回值：** -| 类型 | 说明 | -| ----------------------------------------------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| -------------- | -------------------- | | Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回本地的数字证书的结果。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ---------------------- | -| 2303501 | SSL is null. | -| 2303504 | Error looking up x509. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2303504 | Error looking up x509. | +| 2300002 | System internal error. | **示例：** @@ -3439,16 +3439,16 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------ | -| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数，返回服务端的证书。失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------| ---- | ---------------| +| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数，返回服务端的证书。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ---------------------- | -| 2303501 | SSL is null. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2300002 | System internal error. | **示例：** @@ -3472,16 +3472,16 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\> **返回值：** -| 类型 | 说明 | -| ----------------------------------------------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| -------------- | -------------------- | | Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ---------------------- | -| 2303501 | SSL is null. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2300002 | System internal error. | **示例：** @@ -3503,17 +3503,17 @@ getProtocol(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------------------------- | -| callback | AsyncCallback\ | 是 | 回调函数，返回通信的协议。失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------| ---- | ---------------| +| callback | AsyncCallback\ | 是 | 回调函数，返回通信的协议。失败返回错误码，错误信息。| **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 2303501 | SSL is null. | -| 2303505 | Error occurred in the tls system call. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ----------------------------- | +| 2303501 | SSL is null. | +| 2303505 | Error occurred in the tls system call. | +| 2300002 | System internal error. | **示例：** @@ -3537,17 +3537,17 @@ getProtocol():Promise\ **返回值：** -| 类型 | 说明 | -| ----------------- | ------------------------------------------------------- | +| 类型 | 说明 | +| -------------- | -------------------- | | Promise\ | 以Promise形式返回通信的协议。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 2303501 | SSL is null. | -| 2303505 | Error occurred in the tls system call. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2303505 | Error occurred in the tls system call. | +| 2300002 | System internal error. | **示例：** @@ -3569,18 +3569,18 @@ getCipherSuite(callback: AsyncCallback\\>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\\> | 是 | 回调函数，返回通信双方支持的加密套件。 失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------| ---- | ---------------| +| callback | AsyncCallback\\> | 是 | 回调函数，返回通信双方支持的加密套件。 失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 2303501 | SSL is null. | -| 2303502 | Error in tls reading. | -| 2303505 | Error occurred in the tls system call. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2303502 | Error in tls reading. | +| 2303505 | Error occurred in the tls system call. | +| 2300002 | System internal error. | **示例：** @@ -3604,18 +3604,18 @@ getCipherSuite(): Promise\\> **返回值：** -| 类型 | 说明 | -| -------------------------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| ---------------------- | --------------------- | | Promise\\> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 2303501 | SSL is null. | -| 2303502 | Error in tls reading. | -| 2303505 | Error occurred in the tls system call. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2303502 | Error in tls reading. | +| 2303505 | Error occurred in the tls system call. | +| 2300002 | System internal error. | **示例：** @@ -3637,16 +3637,16 @@ getSignatureAlgorithms(callback: AsyncCallback\\>): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\\> | 是 | 回调函数，返回双方支持的签名算法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------| ---- | ---------------| +| callback | AsyncCallback\\> | 是 | 回调函数，返回双方支持的签名算法。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ---------------------- | -| 2303501 | SSL is null. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2300002 | System internal error. | **示例：** @@ -3670,16 +3670,16 @@ getSignatureAlgorithms(): Promise\\> **返回值：** -| 类型 | 说明 | -| -------------------------- | --------------------------------------------- | +| 类型 | 说明 | +| ---------------------- | -------------------- | | Promise\\> | 以Promise形式返回获取到的双方支持的签名算法。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | ---------------------- | -| 2303501 | SSL is null. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | ------------------------------ | +| 2303501 | SSL is null. | +| 2300002 | System internal error. | **示例：** @@ -3701,21 +3701,21 @@ send(data: string, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | ------------------------------------------------------------ | -| data | string | 是 | 发送的数据内容。 | -| callback | AsyncCallback\ | 是 | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -----------------------------| ---- | ---------------| +| data | string | 是 | 发送的数据内容。 | +| callback | AsyncCallback\ | 是 | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 401 | Parameter error. | -| 2303501 | SSL is null. | -| 2303503 | Error in tls writing. | -| 2303505 | Error occurred in the tls system call. | -| 2303506 | Error clearing tls connection. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 401 | Parameter error. | +| 2303501 | SSL is null. | +| 2303503 | Error in tls writing. | +| 2303505 | Error occurred in the tls system call. | +| 2303506 | Error clearing tls connection. | +| 2300002 | System internal error. | **示例：** @@ -3739,25 +3739,25 @@ send(data: string): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ---------------- | -| data | string | 是 | 发送的数据内容。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -----------------------------| ---- | ---------------| +| data | string | 是 | 发送的数据内容。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 401 | Parameter error. | -| 2303501 | SSL is null. | -| 2303503 | Error in tls writing. | -| 2303505 | Error occurred in the tls system call. | -| 2303506 | Error clearing tls connection. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 401 | Parameter error. | +| 2303501 | SSL is null. | +| 2303503 | Error in tls writing. | +| 2303505 | Error occurred in the tls system call. | +| 2303506 | Error clearing tls connection. | +| 2300002 | System internal error. | **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| -------------- | -------------------- | | Promise\ | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 | **示例：** @@ -3780,19 +3780,19 @@ close(callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码，错误信息。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -----------------------------| ---- | ---------------| +| callback | AsyncCallback\ | 是 | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 401 | Parameter error. | -| 2303501 | SSL is null. | -| 2303505 | Error occurred in the tls system call. | -| 2303506 | Error clearing tls connection. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 401 | Parameter error. | +| 2303501 | SSL is null. | +| 2303505 | Error occurred in the tls system call. | +| 2303506 | Error clearing tls connection. | +| 2300002 | System internal error. | **示例：** @@ -3816,19 +3816,19 @@ close(): Promise\ **返回值：** -| 类型 | 说明 | -| --------------- | ------------------------------------------------------------ | +| 类型 | 说明 | +| -------------- | -------------------- | | Promise\ | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码，错误信息。 | **错误码：** -| 错误码ID | 错误信息 | -| -------- | -------------------------------------- | -| 401 | Parameter error. | -| 2303501 | SSL is null. | -| 2303505 | Error occurred in the tls system call. | -| 2303506 | Error clearing tls connection. | -| 2300002 | System internal error. | +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 401 | Parameter error. | +| 2303501 | SSL is null. | +| 2303505 | Error occurred in the tls system call. | +| 2303506 | Error clearing tls connection. | +| 2300002 | System internal error. | **示例：** @@ -3846,11 +3846,11 @@ TLS连接的操作。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | -| ------------- | -------------------------------------- | ---- | ------------------------------------------------ | -| address | [NetAddress](#netaddress) | 是 | 网关地址。 | -| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。 | -| ALPNProtocols | Array\ | 否 | ALPN协议，支持["spdy/1", "http/1.1"]，默认为[]。 | +| 名称 | 类型 | 必填 | 说明 | +| -------------- | ------------------------------------- | --- |-------------- | +| address | [NetAddress](#netaddress) | 是 | 网关地址。 | +| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。| +| ALPNProtocols | Array\ | 否 | ALPN协议，支持["spdy/1", "http/1.1"]，默认为[]。 | ## TLSSecureOptions9+ @@ -3858,16 +3858,16 @@ TLS安全相关操作，其中ca证书为必选参数，其他参数为可选参 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | -| --------------------- | -------------------------------------------------------- | ---- | ---------------------------------------------- | -| ca | string \| Array\ | 是 | 服务端的ca证书，用于认证校验服务端的数字证书。 | -| cert | string | 否 | 本地客户端的数字证书。 | -| key | string | 否 | 本地数字证书的私钥。 | -| password | string | 否 | 读取私钥的密码。 | -| protocols | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)\> | 否 | TLS的协议版本，默认为"TLSv1.2"。 | -| useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 | -| signatureAlgorithms | string | 否 | 通信过程中的签名算法，默认为"" 。 | -| cipherSuite | string | 否 | 通信过程中的加密套件，默认为"" 。 | +| 名称 | 类型 | 必填 | 说明 | +| --------------------- | ------------------------------------------------------ | --- |----------------------------------- | +| ca | string \| Array\ | 是 | 服务端的ca证书，用于认证校验服务端的数字证书。| +| cert | string | 否 | 本地客户端的数字证书。 | +| key | string | 否 | 本地数字证书的私钥。 | +| password | string | 否 | 读取私钥的密码。 | +| protocols | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)\> | 否 | TLS的协议版本，默认为"TLSv1.2"。 | +| useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 | +| signatureAlgorithms | string | 否 | 通信过程中的签名算法，默认为"" 。 | +| cipherSuite | string | 否 | 通信过程中的加密套件，默认为"" 。 | ## Protocol9+ @@ -3875,10 +3875,10 @@ TLS通信的协议版本。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 值 | 说明 | -| ------ | --------- | --------------------- | -| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 | -| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 | +| 名称 | 值 | 说明 | +| --------- | --------- |------------------ | +| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 | +| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 | ## X509CertRawData9+ @@ -4608,9 +4608,6 @@ off(type: 'connect', callback?: Callback\): void 取消订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。 > **说明：** -> -> listen方法调用成功后，才可调用此方法。 -> > 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 **系统能力**：SystemCapability.Communication.NetStack @@ -4727,9 +4724,7 @@ off(type: 'error', callback?: ErrorCallback): void 取消订阅TLSSocketServer连接的error事件。使用callback方式作为异步方法。 > **说明：** -> > listen方法调用成功后，才可调用此方法。 -> > 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 **系统能力**：SystemCapability.Communication.NetStack