“84007c1708a9c1d136256d3d86f002af543596c8”上不存在“...github.com/git@gitcode.net:seven_feifei/ms-operator.git”
提交 1aa75df3 编写于 作者: X xujie

fix

Signed-off-by: Nxujie <xujie223@huawei.com>
上级 624dc52f
...@@ -23,7 +23,7 @@ constructUDPSocketInstance(): UDPSocket ...@@ -23,7 +23,7 @@ constructUDPSocketInstance(): UDPSocket
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------------------- | :---------------------- | | :---------------------- | :---------------------- |
| [UDPSocket](#udpsocket) | 返回一个UDPSocket对象。 | | [UDPSocket](#udpsocket) | 返回一个UDPSocket对象。 |
**示例:** **示例:**
...@@ -49,14 +49,14 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void ...@@ -49,14 +49,14 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | | -------- | ------------------------- | ---- | --------------------------------------------- |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -86,13 +86,13 @@ bind(address: NetAddress): Promise\<void\> ...@@ -86,13 +86,13 @@ bind(address: NetAddress): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | | ------- | ------------------------- | ---- | --------------------------------------------- |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -129,14 +129,14 @@ send(options: UDPSendOptions, callback: AsyncCallback\<void\>): void ...@@ -129,14 +129,14 @@ send(options: UDPSendOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------- | ---- | ---------------------------------------------------------- |
| options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 | | options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -175,13 +175,13 @@ send(options: UDPSendOptions): Promise\<void\> ...@@ -175,13 +175,13 @@ send(options: UDPSendOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | --------------------------------- | ---- | ---------------------------------------------------------- |
| options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 | | options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -283,13 +283,13 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void ...@@ -283,13 +283,13 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- | | -------- | -------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 | | callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -328,7 +328,7 @@ getState(): Promise\<SocketStateBase\> ...@@ -328,7 +328,7 @@ getState(): Promise\<SocketStateBase\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- | | :--------------------------------------------- | :----------------------------------------- |
| Promise\<[SocketStateBase](#socketstatebase)\> | 以Promise形式返回获取UDPSocket状态的结果。 | | Promise\<[SocketStateBase](#socketstatebase)\> | 以Promise形式返回获取UDPSocket状态的结果。 |
**示例:** **示例:**
...@@ -367,14 +367,14 @@ setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\<void\>): void ...@@ -367,14 +367,14 @@ setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 | | options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -420,7 +420,7 @@ setExtraOptions(options: UDPExtraOptions): Promise\<void\> ...@@ -420,7 +420,7 @@ setExtraOptions(options: UDPExtraOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 | | options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 |
**返回值:** **返回值:**
...@@ -432,7 +432,7 @@ setExtraOptions(options: UDPExtraOptions): Promise\<void\> ...@@ -432,7 +432,7 @@ setExtraOptions(options: UDPExtraOptions): Promise\<void\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -679,7 +679,7 @@ UDPSocket连接的其他属性。 ...@@ -679,7 +679,7 @@ UDPSocket连接的其他属性。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | -------------------------------- | | ----------------- | ------- | ---- | ----------------------------------------- |
| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 | | broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
| receiveBufferSize | number | 否 | 接收缓冲区大小(单位:Byte),默认为0。 | | receiveBufferSize | number | 否 | 接收缓冲区大小(单位:Byte),默认为0。 |
| sendBufferSize | number | 否 | 发送缓冲区大小(单位:Byte),默认为0。 | | sendBufferSize | number | 否 | 发送缓冲区大小(单位:Byte),默认为0。 |
...@@ -728,7 +728,7 @@ constructTCPSocketInstance(): TCPSocket ...@@ -728,7 +728,7 @@ constructTCPSocketInstance(): TCPSocket
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------------------- | :---------------------- | | :---------------------- | :---------------------- |
| [TCPSocket](#tcpsocket) | 返回一个TCPSocket对象。 | | [TCPSocket](#tcpsocket) | 返回一个TCPSocket对象。 |
**示例:** **示例:**
...@@ -757,14 +757,14 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void ...@@ -757,14 +757,14 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | | -------- | ------------------------- | ---- | --------------------------------------------- |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -797,7 +797,7 @@ bind(address: NetAddress): Promise\<void\> ...@@ -797,7 +797,7 @@ bind(address: NetAddress): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | | ------- | ------------------------- | ---- | --------------------------------------------- |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
**返回值:** **返回值:**
...@@ -809,7 +809,7 @@ bind(address: NetAddress): Promise\<void\> ...@@ -809,7 +809,7 @@ bind(address: NetAddress): Promise\<void\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -841,14 +841,14 @@ connect(options: TCPConnectOptions, callback: AsyncCallback\<void\>): void ...@@ -841,14 +841,14 @@ connect(options: TCPConnectOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPConnectOptions](#tcpconnectoptions) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#tcpconnectoptions)。 | | options | [TCPConnectOptions](#tcpconnectoptions) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#tcpconnectoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -878,7 +878,7 @@ connect(options: TCPConnectOptions): Promise\<void\> ...@@ -878,7 +878,7 @@ connect(options: TCPConnectOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPConnectOptions](#tcpconnectoptions) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#tcpconnectoptions)。 | | options | [TCPConnectOptions](#tcpconnectoptions) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#tcpconnectoptions)。 |
**返回值:** **返回值:**
...@@ -890,7 +890,7 @@ connect(options: TCPConnectOptions): Promise\<void\> ...@@ -890,7 +890,7 @@ connect(options: TCPConnectOptions): Promise\<void\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -922,14 +922,14 @@ send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void ...@@ -922,14 +922,14 @@ send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPSendOptions](#tcpsendoptions) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 | | options | [TCPSendOptions](#tcpsendoptions) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -968,7 +968,7 @@ send(options: TCPSendOptions): Promise\<void\> ...@@ -968,7 +968,7 @@ send(options: TCPSendOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPSendOptions](#tcpsendoptions) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 | | options | [TCPSendOptions](#tcpsendoptions) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 |
**返回值:** **返回值:**
...@@ -980,7 +980,7 @@ send(options: TCPSendOptions): Promise\<void\> ...@@ -980,7 +980,7 @@ send(options: TCPSendOptions): Promise\<void\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -1023,7 +1023,7 @@ close(callback: AsyncCallback\<void\>): void ...@@ -1023,7 +1023,7 @@ close(callback: AsyncCallback\<void\>): void
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -1058,7 +1058,7 @@ close(): Promise\<void\> ...@@ -1058,7 +1058,7 @@ close(): Promise\<void\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -1089,13 +1089,13 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void ...@@ -1089,13 +1089,13 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---------- | | -------- | ---------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[NetAddress](#netaddress)> | 是 | 回调函数。 | | callback | AsyncCallback<[NetAddress](#netaddress)> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -1130,13 +1130,13 @@ getRemoteAddress(): Promise\<NetAddress\> ...@@ -1130,13 +1130,13 @@ getRemoteAddress(): Promise\<NetAddress\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------------------------------ | :------------------------------------------ | | :--------------------------------- | :------------------------------------------ |
| Promise<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。 | | Promise<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -1173,13 +1173,13 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void ...@@ -1173,13 +1173,13 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- | | -------- | -------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 | | callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -1214,13 +1214,13 @@ getState(): Promise\<SocketStateBase\> ...@@ -1214,13 +1214,13 @@ getState(): Promise\<SocketStateBase\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- | | :------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TCPSocket状态的结果。 | | Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TCPSocket状态的结果。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 201 | Permission denied. | | 201 | Permission denied. |
**示例:** **示例:**
...@@ -1255,7 +1255,7 @@ getSocketFd(callback: AsyncCallback\<number\>): void ...@@ -1255,7 +1255,7 @@ getSocketFd(callback: AsyncCallback\<number\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- | | -------- | ----------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<number\> | 是 | 回调函数,当成功时,返回socket的文件描述符,失败时,返回undefined。 | | callback | AsyncCallback\<number\> | 是 | 回调函数,当成功时,返回socket的文件描述符,失败时,返回undefined。 |
**示例:** **示例:**
...@@ -1295,7 +1295,7 @@ getSocketFd(): Promise\<number\> ...@@ -1295,7 +1295,7 @@ getSocketFd(): Promise\<number\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- | | :---------------- | :------------------------------------ |
| Promise\<number\> | 以Promise形式返回socket的文件描述符。 | | Promise\<number\> | 以Promise形式返回socket的文件描述符。 |
**示例:** **示例:**
...@@ -1338,14 +1338,14 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void ...@@ -1338,14 +1338,14 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -1390,7 +1390,7 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\> ...@@ -1390,7 +1390,7 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
**返回值:** **返回值:**
...@@ -1402,7 +1402,7 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\> ...@@ -1402,7 +1402,7 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ------------------ |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
...@@ -1629,7 +1629,7 @@ TCPSocket连接的参数。 ...@@ -1629,7 +1629,7 @@ TCPSocket连接的参数。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------------------- | | ------- | ------------------------- | ---- | -------------------------- |
| address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 | | address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 |
| timeout | number | 否 | 超时时间,单位毫秒(ms)。 | | timeout | number | 否 | 超时时间,单位毫秒(ms)。 |
...@@ -1640,7 +1640,7 @@ TCPSocket发送请求的参数。 ...@@ -1640,7 +1640,7 @@ TCPSocket发送请求的参数。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ | | -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| data | string\| ArrayBuffer<sup>7+</sup> | 是 | 发送的数据。 | | data | string\| ArrayBuffer<sup>7+</sup> | 是 | 发送的数据。 |
| encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 | | encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |
...@@ -1672,7 +1672,7 @@ constructTCPSocketServerInstance(): TCPSocketServer ...@@ -1672,7 +1672,7 @@ constructTCPSocketServerInstance(): TCPSocketServer
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :---------------------------------- | :---------------------------- | | :------------------------------------ | :---------------------------- |
| [TCPSocketServer](#tcpsocketserver10) | 返回一个TCPSocketServer对象。 | | [TCPSocketServer](#tcpsocketserver10) | 返回一个TCPSocketServer对象。 |
**示例:** **示例:**
...@@ -1701,7 +1701,7 @@ listen(address: NetAddress, callback: AsyncCallback\<void\>): void ...@@ -1701,7 +1701,7 @@ listen(address: NetAddress, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------------------------------------------- | | -------- | -------------------------- | ---- | -------------- |
| address | [NetAddress](#netaddress7) | 是 | 目标地址信息。 | | address | [NetAddress](#netaddress7) | 是 | 目标地址信息。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
...@@ -1746,14 +1746,14 @@ listen(address: NetAddress): Promise\<void\> ...@@ -1746,14 +1746,14 @@ listen(address: NetAddress): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------- | ---- | --------------------------------------------- | | ------- | -------------------------- | ---- | -------------- |
| address | [NetAddress](#netaddress7) | 是 | 目标地址信息。 | | address | [NetAddress](#netaddress7) | 是 | 目标地址信息。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :----------------------------------------------------------- | | :-------------- | :------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回, 成功返回空,失败返回错误码错误信息。| | Promise\<void\> | 以Promise形式返回, 成功返回空,失败返回错误码错误信息。 |
**错误码:** **错误码:**
...@@ -1795,7 +1795,7 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void ...@@ -1795,7 +1795,7 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------- | | -------- | --------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#socketstatebase7)> | 是 | 回调函数。 | | callback | AsyncCallback<[SocketStateBase](#socketstatebase7)> | 是 | 回调函数。 |
**错误码:** **错误码:**
...@@ -1843,7 +1843,7 @@ getState(): Promise\<SocketStateBase\> ...@@ -1843,7 +1843,7 @@ getState(): Promise\<SocketStateBase\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------------------------------- | :----------------------------------------- | | :-------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#socketstatebase7)> | 以Promise形式返回获取TCPSocket状态的结果。 | | Promise<[SocketStateBase](#socketstatebase7)> | 以Promise形式返回获取TCPSocket状态的结果。 |
**错误码:** **错误码:**
...@@ -1888,7 +1888,7 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void ...@@ -1888,7 +1888,7 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------------------ | ---- | ------------------------------- |
| options | [TCPExtraOptions](#tcpextraoptions7) | 是 | TCPSocketServer连接的其他属性。 | | options | [TCPExtraOptions](#tcpextraoptions7) | 是 | TCPSocketServer连接的其他属性。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
...@@ -1946,13 +1946,13 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\> ...@@ -1946,13 +1946,13 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ------------------------------------ | ---- | ------------------------------- |
| options | [TCPExtraOptions](#tcpextraoptions7) | 是 | TCPSocketServer连接的其他属性。 | | options | [TCPExtraOptions](#tcpextraoptions7) | 是 | TCPSocketServer连接的其他属性。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :--------------------------------------------------------- | | :-------------- | :------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 | | Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
**错误码:** **错误码:**
...@@ -2005,7 +2005,7 @@ on(type: 'connect', callback: Callback\<TCPSocketConnection\>): void ...@@ -2005,7 +2005,7 @@ on(type: 'connect', callback: Callback\<TCPSocketConnection\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------- | | -------- | ------------------------------------------------------- | ---- | ------------------------------------- |
| type | string | 是 | 订阅的事件类型。'connect':连接事件。 | | type | string | 是 | 订阅的事件类型。'connect':连接事件。 |
| callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 是 | 回调函数。 | | callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 是 | 回调函数。 |
...@@ -2038,7 +2038,7 @@ off(type: 'connect', callback?: Callback\<TCPSocketConnection\>): void ...@@ -2038,7 +2038,7 @@ off(type: 'connect', callback?: Callback\<TCPSocketConnection\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------------------------- | | -------- | ------------------------------------------------------- | ---- | ------------------------------------- |
| type | string | 是 | 订阅的事件类型。'connect':连接事件。 | | type | string | 是 | 订阅的事件类型。'connect':连接事件。 |
| callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 否 | 回调函数。 | | callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 否 | 回调函数。 |
...@@ -2143,7 +2143,7 @@ TCPSocketConnection连接,即TCPSocket客户端与服务端的连接。在调 ...@@ -2143,7 +2143,7 @@ TCPSocketConnection连接,即TCPSocket客户端与服务端的连接。在调
### 属性 ### 属性
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ----------------------------------------- | | -------- | ------ | ---- | ------------------------------------- |
| clientId | number | 是 | 客户端与TCPSocketServer建立连接的id。 | | clientId | number | 是 | 客户端与TCPSocketServer建立连接的id。 |
### send<sup>10+</sup> ### send<sup>10+</sup>
...@@ -2162,7 +2162,7 @@ send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void ...@@ -2162,7 +2162,7 @@ send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------- | ---- | ----------------------------------- |
| options | [TCPSendOptions](#tcpsendoptions7) | 是 | TCPSocketConnection发送请求的参数。 | | options | [TCPSendOptions](#tcpsendoptions7) | 是 | TCPSocketConnection发送请求的参数。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
...@@ -2205,13 +2205,13 @@ send(options: TCPSendOptions): Promise\<void\> ...@@ -2205,13 +2205,13 @@ send(options: TCPSendOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ---------------------------------- | ---- | ----------------------------------- |
| options | [TCPSendOptions](#tcpsendoptions7) | 是 | TCPSocketConnection发送请求的参数。 | | options | [TCPSendOptions](#tcpsendoptions7) | 是 | TCPSocketConnection发送请求的参数。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :----------------------------------------------------------- | | :-------------- | :------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 | | Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
**错误码:** **错误码:**
...@@ -2288,7 +2288,7 @@ close(): Promise\<void\> ...@@ -2288,7 +2288,7 @@ close(): Promise\<void\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :------------------------------------------- | | :-------------- | :------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 | | Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
**错误码:** **错误码:**
...@@ -2328,7 +2328,7 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void ...@@ -2328,7 +2328,7 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------- | | -------- | ----------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[NetAddress](#netaddress7)> | 是 | 回调函数。 | | callback | AsyncCallback<[NetAddress](#netaddress7)> | 是 | 回调函数。 |
**错误码:** **错误码:**
...@@ -2371,7 +2371,7 @@ getRemoteAddress(): Promise\<NetAddress\> ...@@ -2371,7 +2371,7 @@ getRemoteAddress(): Promise\<NetAddress\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------------------- | :------------------------------------------ | | :---------------------------------- | :------------------------------------------ |
| Promise<[NetAddress](#netaddress7)> | 以Promise形式返回获取对端socket地址的结果。 | | Promise<[NetAddress](#netaddress7)> | 以Promise形式返回获取对端socket地址的结果。 |
**错误码:** **错误码:**
...@@ -2407,7 +2407,7 @@ on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: Socket ...@@ -2407,7 +2407,7 @@ on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: Socket
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 是 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 是 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 |
...@@ -2449,7 +2449,7 @@ off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: Sock ...@@ -2449,7 +2449,7 @@ off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: Sock
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 否 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 否 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 |
...@@ -2640,7 +2640,7 @@ constructTLSSocketInstance(): TLSSocket ...@@ -2640,7 +2640,7 @@ constructTLSSocketInstance(): TLSSocket
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :--------------------------------- | :---------------------- | | :----------------------- | :---------------------- |
| [TLSSocket](#tlssocket9) | 返回一个TLSSocket对象。 | | [TLSSocket](#tlssocket9) | 返回一个TLSSocket对象。 |
**示例:** **示例:**
...@@ -2666,14 +2666,14 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void ...@@ -2666,14 +2666,14 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。成功返回TLSSocket绑定本机的IP地址和端口的结果。 失败返回错误码,错误信息。| | callback | AsyncCallback\<void\> | 是 | 回调函数。成功返回TLSSocket绑定本机的IP地址和端口的结果。 失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
| 2303198 | Address already in use. | | 2303198 | Address already in use. |
...@@ -2704,19 +2704,19 @@ bind(address: NetAddress): Promise\<void\> ...@@ -2704,19 +2704,19 @@ bind(address: NetAddress): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | | ------- | ------------------------- | ---- | --------------------------------------------- |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :------------------------------------------------------- | | :-------------- | :----------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TLSSocket绑定本机的IP地址和端口的结果。失败返回错误码,错误信息。 | | Promise\<void\> | 以Promise形式返回TLSSocket绑定本机的IP地址和端口的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------- | | -------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. | | 201 | Permission denied. |
| 2303198 | Address already in use. | | 2303198 | Address already in use. |
...@@ -2744,14 +2744,14 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void ...@@ -2744,14 +2744,14 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- | | -------- | --------------------------------------------------- | ---- | ---------------------------------------------------------- |
| callback | AsyncCallback\<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。成功返回TLSSocket状态,失败返回错误码,错误信息。 | | callback | AsyncCallback\<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。成功返回TLSSocket状态,失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ------------------------------- |
| 2303188 | Socket operation on non-socket.| | 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
**示例:** **示例:**
...@@ -2784,14 +2784,14 @@ getState(): Promise\<SocketStateBase\> ...@@ -2784,14 +2784,14 @@ getState(): Promise\<SocketStateBase\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- | | :-------------------------------------------- | :----------------------------------------------------------- |
| Promise\<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TLSSocket状态的结果。失败返回错误码,错误信息。| | Promise\<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TLSSocket状态的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ------------------------------- |
| 2303188 | Socket operation on non-socket.| | 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
**示例:** **示例:**
...@@ -2822,16 +2822,16 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void ...@@ -2822,16 +2822,16 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。成功返回设置TCPSocket连接的其他属性的结果,失败返回错误码,错误信息。| | callback | AsyncCallback\<void\> | 是 | 回调函数。成功返回设置TCPSocket连接的其他属性的结果,失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------------- | | -------- | ------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303188 | Socket operation on non-socket.| | 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
**示例:** **示例:**
...@@ -2874,21 +2874,21 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\> ...@@ -2874,21 +2874,21 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :-------------- | :--------------------------------------------------- | | :-------------- | :----------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。失败返回错误码,错误信息。 | | Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303188 | Socket operation on non-socket.| | 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
**示例:** **示例:**
...@@ -2929,7 +2929,7 @@ on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: Socket ...@@ -2929,7 +2929,7 @@ 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连接信息。 | | callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 |
...@@ -2963,7 +2963,7 @@ off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: Soc ...@@ -2963,7 +2963,7 @@ 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连接信息。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 |
...@@ -3114,14 +3114,14 @@ connect(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void ...@@ -3114,14 +3114,14 @@ connect(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------| ----| --------------- | | -------- | ---------------------------------------- | ---- | ------------------------------------------------ |
| options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | TLSSocket连接所需要的参数。| | options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | TLSSocket连接所需要的参数。 |
| callback | AsyncCallback\<void> | 是 | 回调函数,成功无返回,失败返回错误码,错误信息。| | callback | AsyncCallback\<void> | 是 | 回调函数,成功无返回,失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------------------- | | -------- | ------------------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303104 | Interrupted system call. | | 2303104 | Interrupted system call. |
| 2303109 | Bad file number. | | 2303109 | Bad file number. |
...@@ -3208,19 +3208,19 @@ connect(options: TLSConnectOptions): Promise\<void\> ...@@ -3208,19 +3208,19 @@ connect(options: TLSConnectOptions): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------| ----| --------------- | | ------- | ---------------------------------------- | ---- | ------------------ |
| options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | 连接所需要的参数。| | options | [TLSConnectOptions](#tlsconnectoptions9) | 是 | 连接所需要的参数。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------- | ----------------------------- | | --------------- | --------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回,成功无返回,失败返回错误码,错误信息。| | Promise\<void\> | 以Promise形式返回,成功无返回,失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------------------- | | -------- | ------------------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303104 | Interrupted system call. | | 2303104 | Interrupted system call. |
| 2303109 | Bad file number. | | 2303109 | Bad file number. |
...@@ -3309,14 +3309,14 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void ...@@ -3309,14 +3309,14 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---------- | | -------- | ------------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<[NetAddress](#netaddress)\> | 是 | 回调函数。成功返回对端的socket地址,失败返回错误码,错误信息。 | | callback | AsyncCallback\<[NetAddress](#netaddress)\> | 是 | 回调函数。成功返回对端的socket地址,失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------------- | | -------- | ------------------------------- |
| 2303188 | Socket operation on non-socket.| | 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
**示例:** **示例:**
...@@ -3342,14 +3342,14 @@ getRemoteAddress(): Promise\<NetAddress\> ...@@ -3342,14 +3342,14 @@ getRemoteAddress(): Promise\<NetAddress\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :------------------------------------------ | :------------------------------------------ | | :---------------------------------- | :----------------------------------------------------------- |
| Promise\<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。失败返回错误码,错误信息。 | | Promise\<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ------------------------------- |
| 2303188 | Socket operation on non-socket.| | 2303188 | Socket operation on non-socket. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
**示例:** **示例:**
...@@ -3374,13 +3374,13 @@ getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): ...@@ -3374,13 +3374,13 @@ getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>):
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------------------------------------- | ---- | -------------------------------------------------------- |
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数,成功返回本地的证书,失败返回错误码,错误信息。| | callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数,成功返回本地的证书,失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ---------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303504 | Error looking up x509. | | 2303504 | Error looking up x509. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3408,13 +3408,13 @@ getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\> ...@@ -3408,13 +3408,13 @@ getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | ----------------------------------------------- | ------------------------------------------------------------ |
| Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回本地的数字证书的结果。失败返回错误码,错误信息。 | | Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回本地的数字证书的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ---------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303504 | Error looking up x509. | | 2303504 | Error looking up x509. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3440,13 +3440,13 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata ...@@ -3440,13 +3440,13 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------ |
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数,返回服务端的证书。失败返回错误码,错误信息。 | | callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数,返回服务端的证书。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ---------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3473,13 +3473,13 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\> ...@@ -3473,13 +3473,13 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | ----------------------------------------------- | ------------------------------------------------------------ |
| Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码,错误信息。 | | Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ---------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3504,13 +3504,13 @@ getProtocol(callback: AsyncCallback\<string\>): void ...@@ -3504,13 +3504,13 @@ getProtocol(callback: AsyncCallback\<string\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback\<string\> | 是 | 回调函数,返回通信的协议。失败返回错误码,错误信息。| | callback | AsyncCallback\<string\> | 是 | 回调函数,返回通信的协议。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ----------------------------- | | -------- | -------------------------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. | | 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3538,13 +3538,13 @@ getProtocol():Promise\<string\> ...@@ -3538,13 +3538,13 @@ getProtocol():Promise\<string\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | ----------------- | ------------------------------------------------------- |
| Promise\<string\> | 以Promise形式返回通信的协议。失败返回错误码,错误信息。 | | Promise\<string\> | 以Promise形式返回通信的协议。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | -------------------------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. | | 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3570,13 +3570,13 @@ getCipherSuite(callback: AsyncCallback\<Array\<string\>\>): void ...@@ -3570,13 +3570,13 @@ getCipherSuite(callback: AsyncCallback\<Array\<string\>\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | -------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<Array\<string\>\> | 是 | 回调函数,返回通信双方支持的加密套件。 失败返回错误码,错误信息。 | | callback | AsyncCallback\<Array\<string\>\> | 是 | 回调函数,返回通信双方支持的加密套件。 失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | -------------------------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303502 | Error in tls reading. | | 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. | | 2303505 | Error occurred in the tls system call. |
...@@ -3605,13 +3605,13 @@ getCipherSuite(): Promise\<Array\<string\>\> ...@@ -3605,13 +3605,13 @@ getCipherSuite(): Promise\<Array\<string\>\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------- | | -------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<string\>\> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码,错误信息。 | | Promise\<Array\<string\>\> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | -------------------------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303502 | Error in tls reading. | | 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. | | 2303505 | Error occurred in the tls system call. |
...@@ -3638,13 +3638,13 @@ getSignatureAlgorithms(callback: AsyncCallback\<Array\<string\>\>): void ...@@ -3638,13 +3638,13 @@ getSignatureAlgorithms(callback: AsyncCallback\<Array\<string\>\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------| ---- | ---------------| | -------- | -------------------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<Array\<string\>\> | 是 | 回调函数,返回双方支持的签名算法。 | | callback | AsyncCallback\<Array\<string\>\> | 是 | 回调函数,返回双方支持的签名算法。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ---------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3671,13 +3671,13 @@ getSignatureAlgorithms(): Promise\<Array\<string\>\> ...@@ -3671,13 +3671,13 @@ getSignatureAlgorithms(): Promise\<Array\<string\>\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | -------------------- | | -------------------------- | --------------------------------------------- |
| Promise\<Array\<string\>\> | 以Promise形式返回获取到的双方支持的签名算法。 | | Promise\<Array\<string\>\> | 以Promise形式返回获取到的双方支持的签名算法。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | ------------------------------ | | -------- | ---------------------- |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2300002 | System internal error. | | 2300002 | System internal error. |
...@@ -3702,14 +3702,14 @@ send(data: string, callback: AsyncCallback\<void\>): void ...@@ -3702,14 +3702,14 @@ send(data: string, callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------------------------| ---- | ---------------| | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| data | string | 是 | 发送的数据内容。 | | data | string | 是 | 发送的数据内容。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 | | callback | AsyncCallback\<void\> | 是 | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------------------- | | -------- | -------------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303503 | Error in tls writing. | | 2303503 | Error in tls writing. |
...@@ -3740,13 +3740,13 @@ send(data: string): Promise\<void\> ...@@ -3740,13 +3740,13 @@ send(data: string): Promise\<void\>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------------------------| ---- | ---------------| | ------ | ------ | ---- | ---------------- |
| data | string | 是 | 发送的数据内容。 | | data | string | 是 | 发送的数据内容。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------------------- | | -------- | -------------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303503 | Error in tls writing. | | 2303503 | Error in tls writing. |
...@@ -3757,7 +3757,7 @@ send(data: string): Promise\<void\> ...@@ -3757,7 +3757,7 @@ send(data: string): Promise\<void\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | --------------- | ------------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 | | Promise\<void\> | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 |
**示例:** **示例:**
...@@ -3781,13 +3781,13 @@ close(callback: AsyncCallback\<void\>): void ...@@ -3781,13 +3781,13 @@ close(callback: AsyncCallback\<void\>): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------------------------| ---- | ---------------| | -------- | --------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<void\> | 是 | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码,错误信息。 | | callback | AsyncCallback\<void\> | 是 | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------------------- | | -------- | -------------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. | | 2303505 | Error occurred in the tls system call. |
...@@ -3817,13 +3817,13 @@ close(): Promise\<void\> ...@@ -3817,13 +3817,13 @@ close(): Promise\<void\>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | --------------- | ------------------------------------------------------------ |
| Promise\<void\> | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码,错误信息。 | | Promise\<void\> | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码,错误信息。 |
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | -------------------------------------------- | | -------- | -------------------------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 2303501 | SSL is null. | | 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. | | 2303505 | Error occurred in the tls system call. |
...@@ -3847,9 +3847,9 @@ TLS连接的操作。 ...@@ -3847,9 +3847,9 @@ TLS连接的操作。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------- | --- |-------------- | | ------------- | -------------------------------------- | ---- | ------------------------------------------------ |
| address | [NetAddress](#netaddress) | 是 | 网关地址。 | | address | [NetAddress](#netaddress) | 是 | 网关地址。 |
| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。| | secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。 |
| ALPNProtocols | Array\<string\> | 否 | ALPN协议,支持["spdy/1", "http/1.1"],默认为[]。 | | ALPNProtocols | Array\<string\> | 否 | ALPN协议,支持["spdy/1", "http/1.1"],默认为[]。 |
## TLSSecureOptions<sup>9+</sup> ## TLSSecureOptions<sup>9+</sup>
...@@ -3859,8 +3859,8 @@ TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参 ...@@ -3859,8 +3859,8 @@ TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- | | --------------------- | -------------------------------------------------------- | ---- | ---------------------------------------------- |
| ca | string \| Array\<string\> | 是 | 服务端的ca证书,用于认证校验服务端的数字证书。| | ca | string \| Array\<string\> | 是 | 服务端的ca证书,用于认证校验服务端的数字证书。 |
| cert | string | 否 | 本地客户端的数字证书。 | | cert | string | 否 | 本地客户端的数字证书。 |
| key | string | 否 | 本地数字证书的私钥。 | | key | string | 否 | 本地数字证书的私钥。 |
| password | string | 否 | 读取私钥的密码。 | | password | string | 否 | 读取私钥的密码。 |
...@@ -3876,7 +3876,7 @@ TLS通信的协议版本。 ...@@ -3876,7 +3876,7 @@ TLS通信的协议版本。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| --------- | --------- |------------------ | | ------ | --------- | --------------------- |
| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 | | TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 |
| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 | | TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 |
...@@ -4608,6 +4608,9 @@ off(type: 'connect', callback?: Callback\<TLSSocketConnection\>): void ...@@ -4608,6 +4608,9 @@ off(type: 'connect', callback?: Callback\<TLSSocketConnection\>): void
取消订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。 取消订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。
> **说明:** > **说明:**
>
> listen方法调用成功后,才可调用此方法。
>
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 > 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
...@@ -4724,6 +4727,9 @@ off(type: 'error', callback?: ErrorCallback): void ...@@ -4724,6 +4727,9 @@ off(type: 'error', callback?: ErrorCallback): void
取消订阅TLSSocketServer连接的error事件。使用callback方式作为异步方法。 取消订阅TLSSocketServer连接的error事件。使用callback方式作为异步方法。
> **说明:** > **说明:**
>
> listen方法调用成功后,才可调用此方法。
>
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 > 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack **系统能力**:SystemCapability.Communication.NetStack
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册