提交 28dd7929 编写于 作者: Y Yangys

Update ErrorCode

Signed-off-by: NYangys <yangyousheng@huawei.com>
上级 8b87fd19
...@@ -108,6 +108,7 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void ...@@ -108,6 +108,7 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|---------|-------------------------------------------------------| |---------|-------------------------------------------------------|
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
| 2300003 | URL using bad/illegal format or missing URL. | | 2300003 | URL using bad/illegal format or missing URL. |
| 2300007 | Couldn't connect to server. | | 2300007 | Couldn't connect to server. |
| 2300028 | Timeout was reached. | | 2300028 | Timeout was reached. |
...@@ -156,6 +157,7 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR ...@@ -156,6 +157,7 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|---------|-------------------------------------------------------| |---------|-------------------------------------------------------|
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
| 2300001 | Unsupported protocol. | | 2300001 | Unsupported protocol. |
| 2300003 | URL using bad/illegal format or missing URL. | | 2300003 | URL using bad/illegal format or missing URL. |
| 2300005 | Couldn't resolve proxy name. | | 2300005 | Couldn't resolve proxy name. |
...@@ -243,6 +245,7 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\> ...@@ -243,6 +245,7 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|---------|-------------------------------------------------------| |---------|-------------------------------------------------------|
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
| 2300001 | Unsupported protocol. | | 2300001 | Unsupported protocol. |
| 2300003 | URL using bad/illegal format or missing URL. | | 2300003 | URL using bad/illegal format or missing URL. |
| 2300005 | Couldn't resolve proxy name. | | 2300005 | Couldn't resolve proxy name. |
......
...@@ -53,6 +53,13 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void ...@@ -53,6 +53,13 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -83,6 +90,12 @@ bind\(address: NetAddress\): Promise<void\> ...@@ -83,6 +90,12 @@ bind\(address: NetAddress\): Promise<void\>
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | | ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**返回值:** **返回值:**
...@@ -122,6 +135,13 @@ send\(options: UDPSendOptions, callback: AsyncCallback<void\>\): void ...@@ -122,6 +135,13 @@ 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 | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -161,6 +181,13 @@ send\(options: UDPSendOptions\): Promise<void\> ...@@ -161,6 +181,13 @@ send\(options: UDPSendOptions\): Promise<void\>
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 | | options | [UDPSendOptions](#udpsendoptions) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -265,6 +292,12 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void ...@@ -265,6 +292,12 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
| -------- | ------------------------------------------------------ | ---- | ---------- | | -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 | | callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -345,6 +378,12 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi ...@@ -345,6 +378,12 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi
| options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 | | options | [UDPExtraOptions](#udpextraoptions) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -398,6 +437,13 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\> ...@@ -398,6 +437,13 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\>
| :-------------- | :--------------------------------------------------- | | :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 | | Promise\<void\> | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -438,6 +484,12 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock ...@@ -438,6 +484,12 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 是 | 回调函数。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -466,6 +518,12 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So ...@@ -466,6 +518,12 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -495,6 +553,12 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void ...@@ -495,6 +553,12 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void
| type | string | 是 | 订阅的事件类型。<br />- 'listening':数据包消息事件。<br />- 'close':关闭事件。 | | type | string | 是 | 订阅的事件类型。<br />- 'listening':数据包消息事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 | | callback | Callback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -526,6 +590,12 @@ off\(type: 'listening' | 'close', callback?: Callback<void\>\): void ...@@ -526,6 +590,12 @@ off\(type: 'listening' | 'close', callback?: Callback<void\>\): void
| type | string | 是 | 订阅事件类型。<br />- 'listening':数据包消息事件。<br />- 'close':关闭事件。 | | type | string | 是 | 订阅事件类型。<br />- 'listening':数据包消息事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 | | callback | Callback\<void\> | 否 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -562,6 +632,11 @@ on\(type: 'error', callback: ErrorCallback\): void ...@@ -562,6 +632,11 @@ on\(type: 'error', callback: ErrorCallback\): void
| type | string | 是 | 订阅的事件类型。'error':error事件。 | | type | string | 是 | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 | | callback | ErrorCallback | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
...@@ -591,6 +666,12 @@ off\(type: 'error', callback?: ErrorCallback\): void ...@@ -591,6 +666,12 @@ off\(type: 'error', callback?: ErrorCallback\): void
| type | string | 是 | 订阅的事件类型。'error':error事件。 | | type | string | 是 | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 | | callback | ErrorCallback | 否 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -669,7 +750,7 @@ Socket的连接信息。 ...@@ -669,7 +750,7 @@ Socket的连接信息。
## UDP 错误码说明 ## UDP 错误码说明
UDP 错误码映射形式为:2301000 + 内核错误码。 UDP 其余错误码映射形式为:2301000 + 内核错误码。
错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-socket.md) 错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-socket.md)
...@@ -715,6 +796,12 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void ...@@ -715,6 +796,12 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -752,6 +839,13 @@ bind\(address: NetAddress\): Promise<void\> ...@@ -752,6 +839,13 @@ bind\(address: NetAddress\): Promise<void\>
| :-------------- | :------------------------------------------------------- | | :-------------- | :------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 | | Promise\<void\> | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -782,6 +876,13 @@ connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void ...@@ -782,6 +876,13 @@ 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 | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -818,6 +919,13 @@ connect\(options: TCPConnectOptions\): Promise<void\> ...@@ -818,6 +919,13 @@ connect\(options: TCPConnectOptions\): Promise<void\>
| :-------------- | :--------------------------------------------------------- | | :-------------- | :--------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 | | Promise\<void\> | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -851,6 +959,13 @@ send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void ...@@ -851,6 +959,13 @@ 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 | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -898,6 +1013,13 @@ send\(options: TCPSendOptions\): Promise<void\> ...@@ -898,6 +1013,13 @@ send\(options: TCPSendOptions\): Promise<void\>
| :-------------- | :------------------------------------------------- | | :-------------- | :------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回通过TCPSocket连接发送数据的结果。 | | Promise\<void\> | 以Promise形式返回通过TCPSocket连接发送数据的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -935,6 +1057,11 @@ close\(callback: AsyncCallback<void\>\): void ...@@ -935,6 +1057,11 @@ close\(callback: AsyncCallback<void\>\): void
| -------- | --------------------- | ---- | ---------- | | -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -966,6 +1093,12 @@ close\(\): Promise<void\> ...@@ -966,6 +1093,12 @@ close\(\): Promise<void\>
| :-------------- | :----------------------------------------- | | :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭TCPSocket连接的结果。 | | Promise\<void\> | 以Promise形式返回关闭TCPSocket连接的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -998,6 +1131,12 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void ...@@ -998,6 +1131,12 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
| -------- | ------------------------------------------------- | ---- | ---------- | | -------- | ------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[NetAddress](#netaddress)> | 是 | 回调函数。 | | callback | AsyncCallback<[NetAddress](#netaddress)> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -1037,6 +1176,12 @@ getRemoteAddress\(\): Promise<NetAddress\> ...@@ -1037,6 +1176,12 @@ getRemoteAddress\(\): Promise<NetAddress\>
| :------------------------------------------ | :------------------------------------------ | | :------------------------------------------ | :------------------------------------------ |
| Promise<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。 | | Promise<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -1075,6 +1220,11 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void ...@@ -1075,6 +1220,11 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
| -------- | ------------------------------------------------------ | ---- | ---------- | | -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 | | callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -1115,6 +1265,11 @@ getState\(\): Promise<SocketStateBase\> ...@@ -1115,6 +1265,11 @@ getState\(\): Promise<SocketStateBase\>
| :----------------------------------------------- | :----------------------------------------- | | :----------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TCPSocket状态的结果。 | | Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TCPSocket状态的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -1155,6 +1310,13 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi ...@@ -1155,6 +1310,13 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi
| options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 | | options | [TCPExtraOptions](#tcpextraoptions) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 | | callback | AsyncCallback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
```js ```js
...@@ -1209,6 +1371,12 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\> ...@@ -1209,6 +1371,12 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\>
| :-------------- | :--------------------------------------------------- | | :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 | | Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -1253,6 +1421,12 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock ...@@ -1253,6 +1421,12 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 是 | 回调函数。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -1281,6 +1455,12 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So ...@@ -1281,6 +1455,12 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。 | | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -1310,6 +1490,11 @@ on\(type: 'connect' | 'close', callback: Callback<void\>\): void ...@@ -1310,6 +1490,11 @@ on\(type: 'connect' | 'close', callback: Callback<void\>\): void
| type | string | 是 | 订阅的事件类型。<br />- 'connect':连接事件。<br />- 'close':关闭事件。 | | type | string | 是 | 订阅的事件类型。<br />- 'connect':连接事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 | | callback | Callback\<void\> | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
...@@ -1342,6 +1527,12 @@ off\(type: 'connect' | 'close', callback?: Callback<void\>\): void ...@@ -1342,6 +1527,12 @@ off\(type: 'connect' | 'close', callback?: Callback<void\>\): void
| type | string | 是 | 订阅的事件类型。<br />- 'connect':连接事件。<br />- 'close':关闭事件。 | | type | string | 是 | 订阅的事件类型。<br />- 'connect':连接事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 | | callback | Callback\<void\> | 否 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -1378,6 +1569,12 @@ on\(type: 'error', callback: ErrorCallback\): void ...@@ -1378,6 +1569,12 @@ on\(type: 'error', callback: ErrorCallback\): void
| type | string | 是 | 订阅的事件类型。'error':error事件。 | | type | string | 是 | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 | | callback | ErrorCallback | 是 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -1406,6 +1603,12 @@ off\(type: 'error', callback?: ErrorCallback\): void ...@@ -1406,6 +1603,12 @@ off\(type: 'error', callback?: ErrorCallback\): void
| type | string | 是 | 订阅的事件类型。'error':error事件。 | | type | string | 是 | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 | | callback | ErrorCallback | 否 | 回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
**示例:** **示例:**
```js ```js
...@@ -1461,7 +1664,7 @@ TCPSocket连接的其他属性。 ...@@ -1461,7 +1664,7 @@ TCPSocket连接的其他属性。
## TCP 错误码说明 ## TCP 错误码说明
TCP 错误码映射形式为:2301000 + 内核错误码。 TCP 其余错误码映射形式为:2301000 + 内核错误码。
错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-socket.md) 错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-socket.md)
......
...@@ -106,9 +106,10 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void ...@@ -106,9 +106,10 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|-------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -145,9 +146,10 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback< ...@@ -145,9 +146,10 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|-------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -194,9 +196,10 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\> ...@@ -194,9 +196,10 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|-------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -231,9 +234,10 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void ...@@ -231,9 +234,10 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|-------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -276,9 +280,10 @@ send\(data: string | ArrayBuffer\): Promise<boolean\> ...@@ -276,9 +280,10 @@ send\(data: string | ArrayBuffer\): Promise<boolean\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|--------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -314,9 +319,10 @@ close\(callback: AsyncCallback<boolean\>\): void ...@@ -314,9 +319,10 @@ close\(callback: AsyncCallback<boolean\>\): void
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|-------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -352,9 +358,10 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void ...@@ -352,9 +358,10 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|--------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
...@@ -398,9 +405,10 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\> ...@@ -398,9 +405,10 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\>
**错误码:** **错误码:**
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
|--------|---------------------------| | ------- | ----------------------- |
| 401 | Parameter error. | | 401 | Parameter error. |
| 201 | Permission denied. |
**示例:** **示例:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册