Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 701f216e 编写于 作者: C clevercong
浏览文件
操作

format files. 

Signed-off-by: Nclevercong <lichunlin2@huawei.com>
上级 ecfa3d6c
显示空白变更内容
内联 并排
Showing with 1180 addition and 1181 deletion
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ 701f216e
......@@ -86,18 +86,18 @@ createHttp\(\): HttpRequest
创建一个http，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header 事件。每一个HttpRequest对象对应一个Http请求。如需发起多个Http请求，须为每个Http请求创建对应HttpRequest对象。
- 返回值
**返回值：**
| 类型 | 说明 |
| :---------- | :----------------------------------------------------------- |
| HttpRequest | 返回一个HttpRequest对象，里面包括request、destroy、on和off方法。 |
| 类型 | 说明 |
| :---------- | :----------------------------------------------------------- |
| HttpRequest | 返回一个HttpRequest对象，里面包括request、destroy、on和off方法。 |
- 示例
**示例：**
```
import http from '@ohos.net.http';
let httpRequest = http.createHttp();
```
```
import http from '@ohos.net.http';
let httpRequest = http.createHttp();
```
## HttpRequest<a name="section775213486457"></a>
......@@ -110,18 +110,18 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
根据URL地址，发起HTTP网络请求，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ----------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ----------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest = http.createHttp();
httpRequest.request("EXAMPLE_URL", (err, data) => {
```
let httpRequest = http.createHttp();
httpRequest.request("EXAMPLE_URL", (err, data) => {
if (!err) {
console.info('Result:' + data.result);
console.info('code:' + data.responseCode);
......@@ -130,9 +130,8 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
} else {
console.info('error:' + err.data);
}
});
```
});
```
### request<a name="section1361727114718"></a>
......@@ -140,27 +139,27 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
根据URL地址和相关配置项，发起HTTP网络请求，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | -------------------------------------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 |
| callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | -------------------------------------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 |
| callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.request("EXAMPLE_URL",
{
```
let httpRequest= http.createHttp();
httpRequest.request("EXAMPLE_URL",
{
method: 'GET',
header: {
'Content-Type': 'application/json'
},
readTimeout: 60000,
connectTimeout: 60000
},(err, data) => {
},(err, data) => {
if (!err) {
console.info('Result:' + data.result);
console.info('code:' + data.responseCode);
......@@ -173,8 +172,8 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
} else {
console.info('error:' + err.data);
}
});
```
});
```
### request<a name="section47538114482"></a>
......@@ -183,33 +182,33 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
根据URL地址，发起HTTP网络请求，使用Promise方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------ | ---- | -------------------------------------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------ | ---- | -------------------------------------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------------- | :-------------------------------- |
| Promise<[HttpResponse](#section12262183471518)> | 以Promise形式返回发起请求的结果。 |
| 类型 | 说明 |
| :-------------------- | :-------------------------------- |
| Promise<[HttpResponse](#section12262183471518)> | 以Promise形式返回发起请求的结果。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", {
```
let httpRequest= http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", {
method: "GET",
connectTimeout: 60000,
readTimeout: 60000,
header: {
'Content-Type': 'application/json'
}
});
promise.then((value) => {
});
promise.then((value) => {
console.info('Result:' + value.result);
console.info('code:' + value.responseCode);
console.info('header:' + value.header);
......@@ -218,11 +217,10 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
console.info('header['Status-Line']:' + value.header['Status-Line']);
console.info('header.Date:' + value.header.Date);
console.info('header.Server:' + value.header.Server);
}).catch((err) => {
}).catch((err) => {
console.error(`errCode:${err.code}, errMessage:${err.data}`);
});
```
});
```
### destroy<a name="section613614500483"></a>
......@@ -230,13 +228,12 @@ destroy\(\): void
中断请求任务。
- 示例
```
let httpRequest= http.createHttp();
httpRequest.destroy();
```
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.destroy();
```
### on\('headerReceive'\)<a name="section617831813498"></a>
......@@ -247,25 +244,25 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\):void
>![](public_sys-resources/icon-note.gif) **说明：**
> 此接口已废弃，建议使用on\('headersReceive'\)替代。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------- |
| type | string | 是 | 订阅的事件类型，如：'headerReceive'。 |
| callback | AsyncCallback\<Object\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------- |
| type | string | 是 | 订阅的事件类型，如：'headerReceive'。 |
| callback | AsyncCallback\<Object\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => {
```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => {
if (!err) {
console.info('header: ' + data.header);
} else {
console.info('error:' + err.data);
}
});
```
});
```
### off\('headerReceive'\)<a name="section017612118508"></a>
......@@ -280,26 +277,26 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void
>
>2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------- |
| type | string | 是 | 取消订阅的事件类型，'headerReceive'。 |
| callback | AsyncCallback\<Object\> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------------- |
| type | string | 是 | 取消订阅的事件类型，'headerReceive'。 |
| callback | AsyncCallback\<Object\> | 否 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => {
```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => {
if (!err) {
console.info('header: ' + data.header);
} else {
console.info('error:' + err.data);
}
});
httpRequest.off('headerReceive');
```
});
httpRequest.off('headerReceive');
```
### on\('headersReceive'\)<sup>8+</sup><a name="section6178318134982"></a>
......@@ -307,21 +304,21 @@ on\(type: 'headersReceive', callback: Callback<Object\>\):void
订阅HTTP Response Header 事件。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ---------------------------------- |
| type | string | 是 | 订阅的事件类型：'headersReceive'。 |
| callback | Callback\<Object\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ---------------------------------- |
| type | string | 是 | 订阅的事件类型：'headersReceive'。 |
| callback | Callback\<Object\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.on('headersReceive', (data) => {
```
let httpRequest= http.createHttp();
httpRequest.on('headersReceive', (data) => {
console.info('header: ' + data.header);
});
```
});
```
### off\('headersReceive'\)<sup>8+</sup><a name="section0176121185082"></a>
......@@ -333,19 +330,19 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\):void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | -------------------------------------- |
| type | string | 是 | 取消订阅的事件类型：'headersReceive'。 |
| callback | Callback\<Object\> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | -------------------------------------- |
| type | string | 是 | 取消订阅的事件类型：'headersReceive'。 |
| callback | Callback\<Object\> | 否 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.off('headersReceive');
```
```
let httpRequest= http.createHttp();
httpRequest.off('headersReceive');
```
### once\('headersReceive'\)<sup>8+</sup><a name="section68221041134718"></a>
......@@ -353,21 +350,21 @@ once\(type: "headersReceive", callback: Callback<Object\>\): void
订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ---------------------------------- |
| type | string | 是 | 订阅的事件类型：'headersReceive'。 |
| callback | Callback\<Object\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | ---------------------------------- |
| type | string | 是 | 订阅的事件类型：'headersReceive'。 |
| callback | Callback\<Object\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.once('headersReceive', (data) => {
```
let httpRequest= http.createHttp();
httpRequest.once('headersReceive', (data) => {
console.info('header: ' + data.header);
});
```
});
```
## HttpRequestOptions<a name="section12262183471518"></a>
......
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ 701f216e
......@@ -75,18 +75,18 @@ constructUDPSocketInstance\(\): UDPSocket
创建一个UDPSocket对象。
- 返回值
**返回值：**
| 类型 | 说明 |
| :--------------------------------- | :---------------------- |
| [UDPSocket](#section1957294511568) | 返回一个UDPSocket对象。 |
| 类型 | 说明 |
| :--------------------------------- | :---------------------- |
| [UDPSocket](#section1957294511568) | 返回一个UDPSocket对象。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
```
```
let udp = socket.constructUDPSocketInstance();
```
## UDPSocket<a name="section1957294511568"></a>
......@@ -99,25 +99,25 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
if (err) {
console.log('bind fail');
return;
}
console.log('bind success');
})
```
})
```
### bind<a name="section12433131831219"></a>
......@@ -126,30 +126,30 @@ bind\(address: NetAddress\): Promise<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式异步返回UDPSocket绑定的结果。 |
| 类型 | 说明 |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式异步返回UDPSocket绑定的结果。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address: '192.168.xx.xxx', port: 8080, family: 1});
promise .then(() => {
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address: '192.168.xx.xxx', port: 8080, family: 1});
promise .then(() => {
console.log('bind success');
}).catch(err => {
}).catch(err => {
console.log('bind fail');
});
```
});
```
### send<a name="section1859172655111"></a>
......@@ -158,32 +158,32 @@ send\(options: UDPSendOptions, callback: AsyncCallback<void\>\): void
通过UDPSocket连接发送数据。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数，参考[UDPSendOptions](#section13297558184010)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数，参考[UDPSendOptions](#section13297558184010)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.send({
```
let udp = socket.constructUDPSocketInstance();
udp.send({
data:'Hello, server!',
address: {
address:'192.168.xx.xxx',
port:xxxx,
family:1
}
}, err=> {
}, err=> {
if (err) {
console.log('send fail');
return;
}
console.log('send success');
})
```
})
```
### send<a name="section61591275527"></a>
......@@ -192,36 +192,36 @@ send\(options: UDPSendOptions\): Promise<void\>
通过UDPSocket连接发送数据。使用Promise方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数，参考[UDPSendOptions](#section13297558184010)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数，参考[UDPSendOptions](#section13297558184010)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :--------------------------------------------- |
| Promise\<void\> | 以Promise形式返回UDPSocket连接发送数据的结果。 |
| 类型 | 说明 |
| :-------------- | :--------------------------------------------- |
| Promise\<void\> | 以Promise形式返回UDPSocket连接发送数据的结果。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.send({
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.send({
data:'Hello, server!',
address: {
address:'192.168.xx.xxx',
port:xxxx,
family:1
}
});
promise.then(() => {
});
promise.then(() => {
console.log('send success');
}).catch(err => {
}).catch(err => {
console.log('send fail');
});
```
});
```
### close<a name="section068563155214"></a>
......@@ -230,24 +230,24 @@ close\(callback: AsyncCallback<void\>\): void
关闭UDPSocket连接。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.close(err => {
```
let udp = socket.constructUDPSocketInstance();
udp.close(err => {
if (err) {
console.log('close fail');
return;
}
console.log('close success');
})
```
})
```
### close<a name="section1788163335319"></a>
......@@ -256,23 +256,23 @@ close\(\): Promise<void\>
关闭UDPSocket连接。使用Promise方式作为异步方法。
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭UDPSocket连接的结果。 |
| 类型 | 说明 |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭UDPSocket连接的结果。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.close();
promise.then(() => {
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.close();
promise.then(() => {
console.log('close success');
}).catch(err => {
}).catch(err => {
console.log('close fail');
});
```
});
```
### getState<a name="section1028719549533"></a>
......@@ -284,17 +284,17 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section7382103811272)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
if (err) {
console.log('bind fail');
return;
......@@ -307,8 +307,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
}
console.log('getState success:' + JSON.stringify(data));
})
})
```
})
```
### getState<a name="section1333814412551"></a>
......@@ -320,17 +320,17 @@ getState\(\): Promise<SocketStateBase\>
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section7382103811272)方法调用成功后，才可调用此方法。
- 返回值
**返回值：**
| 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取UDPSocket状态的结果。 |
| 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取UDPSocket状态的结果。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
if (err) {
console.log('bind fail');
return;
......@@ -342,8 +342,8 @@ getState\(\): Promise<SocketStateBase\>
}).catch(err => {
console.log('getState fail');
});
})
```
})
```
### setExtraOptions<a name="section16890953175514"></a>
......@@ -355,19 +355,19 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section7382103811272)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性，参考[UDPExtraOptions](#section1650575184117)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性，参考[UDPExtraOptions](#section1650575184117)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1}, err=> {
```
let udp = socket.constructUDPSocketInstance();
udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1}, err=> {
if (err) {
console.log('bind fail');
return;
......@@ -386,8 +386,8 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi
}
console.log('setExtraOptions success');
})
})
```
})
```
### setExtraOptions<a name="section5493159165611"></a>
......@@ -399,24 +399,24 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\>
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section7382103811272)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性，参考[UDPExtraOptions](#section1650575184117)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性，参考[UDPExtraOptions](#section1650575184117)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 |
| 类型 | 说明 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1});
promise.then(() => {
```
let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1});
promise.then(() => {
console.log('bind success');
let promise1 = udp.setExtraOptions({
receiveBufferSize:1000,
......@@ -430,10 +430,10 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\>
}).catch(err => {
console.log('setExtraOptions fail');
});
}).catch(err => {
}).catch(err => {
console.log('bind fail');
});
```
});
```
### on\('message'\)<a name="section1632573015551"></a>
......@@ -442,21 +442,21 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.on('message', value => {
```
let udp = socket.constructUDPSocketInstance();
udp.on('message', value => {
console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo);
});
```
});
```
### off\('message'\)<a name="section789519374558"></a>
......@@ -468,25 +468,25 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
let callback = value =>{
```
let udp = socket.constructUDPSocketInstance();
let callback = value =>{
console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo);
}
udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('message', callback);
udp.off('message');
```
}
udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('message', callback);
udp.off('message');
```
### on\('listening' | 'close'\)<a name="section20461174410557"></a>
......@@ -495,24 +495,24 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void
订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'listening'：数据包消息事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'listening'：数据包消息事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => {
```
let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => {
console.log("on listening success"));
});
udp.on('close', () => {
});
udp.on('close', () => {
console.log("on close success" );
});
```
});
```
### off\('listening' | 'close'\)<a name="section649105218559"></a>
......@@ -524,32 +524,32 @@ off\(type: 'listening' | 'close', callback?: Callback<void\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅事件类型。<br />- 'listening'：数据包消息事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅事件类型。<br />- 'listening'：数据包消息事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance();
let callback1 = () =>{
```
let udp = socket.constructUDPSocketInstance();
let callback1 = () =>{
console.log("on listening, success");
}
udp.on('listening', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('listening', callback1);
udp.off('listening');
let callback2 = () =>{
}
udp.on('listening', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('listening', callback1);
udp.off('listening');
let callback2 = () =>{
console.log("on close, success");
}
udp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('close', callback2);
udp.off('close');
```
}
udp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('close', callback2);
udp.off('close');
```
### on\('error'\)<a name="section16745135855515"></a>
......@@ -558,22 +558,22 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance()
udp.on('error', err => {
```
let udp = socket.constructUDPSocketInstance()
udp.on('error', err => {
console.log("on error, err:" + JSON.stringify(err))
});
```
});
```
### off\('error'\)<a name="section49111157568"></a>
......@@ -585,25 +585,25 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
- 示例
**示例：**
```
let udp = socket.constructUDPSocketInstance()
let callback = err =>{
```
let udp = socket.constructUDPSocketInstance()
let callback = err =>{
console.log("on error, err:" + JSON.stringify(err));
}
udp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('error', callback);
udp.off('error');
```
}
udp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
udp.off('error', callback);
udp.off('error');
```
## NetAddress<a name="section159132241295"></a>
......@@ -664,17 +664,17 @@ constructTCPSocketInstance\(\): TCPSocket
创建一个TCPSocket对象。
- 返回值
**返回值：**
| 类型 | 说明 |
| :--------------------------------- | :---------------------- |
| [TCPSocket](#section1180211014548) | 返回一个TCPSocket对象。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
```
```
let tcp = socket.constructTCPSocketInstance();
```
## TCPSocket<a name="section1180211014548"></a>
......@@ -687,26 +687,26 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方法作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
```
let tcp = socket.constructTCPSocketInstance();
tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
if (err) {
console.log('bind fail');
return;
}
console.log('bind success');
})
```
})
```
### bind<a name="section27150134582"></a>
......@@ -715,29 +715,29 @@ bind\(address NetAddress\): Promise<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#section159132241295) | 是 | 目标地址信息，参考[NetAddress](#section159132241295)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 |
| 类型 | 说明 |
| :-------------- | :------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1});
promise.then(() => {
console.log('bind success');
}).catch(err => {
}).catch(err => {
console.log('bind fail');
});
```
});
```
### connect<a name="section82761299586"></a>
......@@ -746,25 +746,25 @@ connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void
连接到指定的IP地址和端口。使用callback方法作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数，参考[TCPConnectOptions](#section13821005712)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数，参考[TCPConnectOptions](#section13821005712)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}, err => {
```
let tcp = socket.constructTCPSocketInstance();
tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}, err => {
if (err) {
console.log('connect fail');
return;
}
console.log('connect success');
})
```
})
```
### connect<a name="section374992304"></a>
......@@ -773,29 +773,29 @@ connect\(options: TCPConnectOptions\): Promise<void\>
连接到指定的IP地址和端口。使用promise方法作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数，参考[TCPConnectOptions](#section13821005712)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数，参考[TCPConnectOptions](#section13821005712)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :--------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 |
| 类型 | 说明 |
| :-------------- | :--------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success')
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### send<a name="section74991317709"></a>
......@@ -807,19 +807,19 @@ send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数，参考[TCPSendOptions](#section1689232415715)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数，参考[TCPSendOptions](#section1689232415715)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success');
tcp.send({
data:'Hello, server!'
......@@ -830,10 +830,10 @@ send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void
}
console.log('send success');
})
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### send<a name="section2841321507"></a>
......@@ -845,24 +845,24 @@ send\(options: TCPSendOptions\): Promise<void\>
>![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数，参考[TCPSendOptions](#section1689232415715)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数，参考[TCPSendOptions](#section1689232415715)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回通过TCPSocket连接发送数据的结果。 |
| 类型 | 说明 |
| :-------------- | :------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回通过TCPSocket连接发送数据的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
console.log('connect success');
let promise2 = tcp.send({
data:'Hello, server!'
......@@ -872,10 +872,10 @@ send\(options: TCPSendOptions\): Promise<void\>
}).catch(err => {
console.log('send fail');
});
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### close<a name="section71701043701"></a>
......@@ -884,25 +884,25 @@ close\(callback: AsyncCallback<void\>\): void
关闭TCPSocket连接。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
tcp.close(err => {
```
let tcp = socket.constructTCPSocketInstance();
tcp.close(err => {
if (err) {
console.log('close fail');
return;
}
console.log('close success');
})
```
})
```
### close<a name="section13523755306"></a>
......@@ -911,23 +911,23 @@ close\(\): Promise<void\>
关闭TCPSocket连接。使用Promise方式作为异步方法。
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭TCPSocket连接的结果。 |
| 类型 | 说明 |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭TCPSocket连接的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.close();
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.close();
promise.then(() => {
console.log('close success');
}).catch(err => {
}).catch(err => {
console.log('close fail');
});
```
});
```
### getRemoteAddress<a name="section1268431414115"></a>
......@@ -939,18 +939,18 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[NetAddress](#section159132241295)> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback<[NetAddress](#section159132241295)> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success');
tcp.getRemoteAddress((err, data) => {
if (err) {
......@@ -959,10 +959,10 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
}
console.log('getRemoteAddresssuccess:' + JSON.stringify(data));
})
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### getRemoteAddress<a name="section89019337116"></a>
......@@ -974,18 +974,18 @@ getRemoteAddress\(\): Promise<NetAddress\>
>![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 返回值
**返回值：**
| 类型 | 说明 |
| :------------------------------------------ | :------------------------------------------ |
| Promise<[NetAddress](#section159132241295)> | 以Promise形式返回获取对端socket地址的结果。 |
| 类型 | 说明 |
| :------------------------------------------ | :------------------------------------------ |
| Promise<[NetAddress](#section159132241295)> | 以Promise形式返回获取对端socket地址的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
console.log('connect success');
let promise2 = tcp.getRemoteAddress();
promise2.then(() => {
......@@ -993,10 +993,10 @@ getRemoteAddress\(\): Promise<NetAddress\>
}).catch(err => {
console.log('getRemoteAddressfail');
});
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### getState<a name="section830554511115"></a>
......@@ -1008,19 +1008,19 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success');
tcp.getState((err, data) => {
if (err) {
......@@ -1029,10 +1029,10 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
}
console.log('getState success:' + JSON.stringify(data));
});
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### getState<a name="section3460522026"></a>
......@@ -1044,19 +1044,19 @@ getState\(\): Promise<SocketStateBase\>
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 返回值
**返回值：**
| 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取TCPSocket状态的结果。 |
| 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取TCPSocket状态的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success');
let promise1 = tcp.getState();
promise1.then(() => {
......@@ -1064,10 +1064,10 @@ getState\(\): Promise<SocketStateBase\>
}).catch(err => {
console.log('getState fail');
});
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### setExtraOptions<a name="section738911419219"></a>
......@@ -1079,19 +1079,19 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#section13892555115718)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#section13892555115718)。 |
| callback | AsyncCallback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success');
tcp.setExtraOptions({
keepAlive: true,
......@@ -1109,10 +1109,10 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi
}
console.log('setExtraOptions success');
});
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### setExtraOptions<a name="section1847278215"></a>
......@@ -1124,25 +1124,25 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\>
>![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后，才可调用此方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#section13892555115718)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性，参考[TCPExtraOptions](#section13892555115718)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 |
| 类型 | 说明 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
```
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
console.log('connect success');
let promise1 = tcp.setExtraOptions({
keepAlive: true,
......@@ -1159,10 +1159,10 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\>
}).catch(err => {
console.log('setExtraOptions fail');
});
}).catch(err => {
}).catch(err => {
console.log('connect fail');
});
```
});
```
### on\('message'\)<a name="section642292019182"></a>
......@@ -1171,21 +1171,21 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
tcp.on('message', value => {
```
let tcp = socket.constructTCPSocketInstance();
tcp.on('message', value => {
console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo)
});
```
});
```
### off\('message'\)<a name="section8426920151811"></a>
......@@ -1197,25 +1197,25 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let callback = value =>{
```
let tcp = socket.constructTCPSocketInstance();
let callback = value =>{
console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
}
tcp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('message', callback);
tcp.off('message');
```
}
tcp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('message', callback);
tcp.off('message');
```
### on\('connect' | 'close'\)<a name="section6429202001812"></a>
......@@ -1224,25 +1224,25 @@ on\(type: 'connect' | 'close', callback: Callback<void\>\): void
订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'connect'：连接事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'connect'：连接事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
tcp.on('connect', () => {
```
let tcp = socket.constructTCPSocketInstance();
tcp.on('connect', () => {
console.log("on connect success")
});
tcp.on('close', data => {
});
tcp.on('close', data => {
console.log("on close success")
});
```
});
```
### off\('connect' | 'close'\)<a name="section54325209187"></a>
......@@ -1254,32 +1254,32 @@ off\(type: 'connect' | 'close', callback: Callback<void\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'connect'：连接事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'connect'：连接事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let callback1 = () =>{
```
let tcp = socket.constructTCPSocketInstance();
let callback1 = () =>{
console.log("on connect success");
}
tcp.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('connect', callback1);
tcp.off('connect');
let callback2 = () =>{
}
tcp.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('connect', callback1);
tcp.off('connect');
let callback2 = () =>{
console.log("on close success");
}
tcp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('close', callback2);
tcp.off('close');
```
}
tcp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('close', callback2);
tcp.off('close');
```
### on\('error'\)<a name="section19436172061817"></a>
......@@ -1288,21 +1288,21 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
tcp.on('error', err => {
```
let tcp = socket.constructTCPSocketInstance();
tcp.on('error', err => {
console.log("on error, err:" + JSON.stringify(err))
});
```
});
```
### off\('error'\)<a name="section6438202013182"></a>
......@@ -1314,25 +1314,25 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
- 示例
**示例：**
```
let tcp = socket.constructTCPSocketInstance();
let callback = err =>{
```
let tcp = socket.constructTCPSocketInstance();
let callback = err =>{
console.log("on error, err:" + JSON.stringify(err));
}
tcp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('error', callback);
tcp.off('error');
```
}
tcp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tcp.off('error', callback);
tcp.off('error');
```
## TCPConnectOptions<a name="section13821005712"></a>
......
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @ 701f216e
......@@ -28,6 +28,8 @@
>![](public_sys-resources/icon-note.gif) **说明：**
>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>当前暂时不支持WebSocket，预计在MR版本支持。
使用WebSocket建立服务器与客户端的双向连接，需要先通过[createWebSocket](#section375081875219)方法创建[WebSocket](#section16411174314593)对象，然后通过[connect](WebSocket连接.md)方法连接到服务器。当连接成功后，客户端会收到[open](#section923017271834)事件的回调，之后客户端就可以通过[send](#section156451414213)方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到[message](#section1066819418488)事件的回调。当客户端不要此连接时，可以通过调用[close](#section202411451433)方法主动断开连接，之后客户端会收到[close](#section169378107484)事件的回调。
......@@ -96,17 +98,17 @@ createWebSocket\(\): WebSocket
创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。
- 返回值
**返回值：**
| 类型 | 说明 |
| :---------------------------------- | :----------------------------------------------------------- |
| [WebSocket](#section16411174314593) | 返回一个WebSocket对象，里面包括connect、send、close、on和off方法。 |
| 类型 | 说明 |
| :---------------------------------- | :----------------------------------------------------------- |
| [WebSocket](#section16411174314593) | 返回一个WebSocket对象，里面包括connect、send、close、on和off方法。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
```
```
let ws = webSocket.createWebSocket();
```
## WebSocket<a name="section16411174314593"></a>
......@@ -119,27 +121,27 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void
根据URL地址，建立一个WebSocket连接，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) => {
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) => {
if (!err) {
console.log("connect success");
} else {
console.log("connect fail, err:" + JSON.stringify(err))
}
});
```
});
```
### connect<a name="section18952991528"></a>
......@@ -148,33 +150,33 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<
根据URL地址和header，建立一个WebSocket连接，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#section11251233123910)。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#section11251233123910)。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, {
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, {
header: {
"key": "value",
"key2": "value2"
}
}, (err, value) => {
}, (err, value) => {
if (!err) {
console.log("connect success");
} else {
console.log("connect fail, err:" + JSON.stringify(err))
}
});
```
});
```
### connect<a name="section10573126422"></a>
......@@ -183,31 +185,31 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\>
根据URL地址和header，建立一个WebSocket连接，使用Promise方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------- | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#section11251233123910)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------- | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#section11251233123910)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :----------------- | :-------------------------------- |
| Promise\<boolean\> | 以Promise形式返回建立连接的结果。 |
| 类型 | 说明 |
| :----------------- | :-------------------------------- |
| Promise\<boolean\> | 以Promise形式返回建立连接的结果。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.connect(url);
promise.then((value) => {
```
let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.connect(url);
promise.then((value) => {
console.log("connect success")
}).catch((err) => {
}).catch((err) => {
console.log("connect fail, error:" + JSON.stringify(err))
});
```
});
```
### send<a name="section156451414213"></a>
......@@ -216,19 +218,19 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void
通过WebSocket连接发送数据，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------ |
| data | string \| ArrayBuffer <sup>8+</sup> | 是 | 发送的数据。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------ |
| data | string \| ArrayBuffer <sup>8+</sup> | 是 | 发送的数据。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) => {
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) => {
ws.send("Hello, server!", (err, value) => {
if (!err) {
console.log("send success");
......@@ -236,8 +238,8 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void
console.log("send fail, err:" + JSON.stringify(err))
}
});
});
```
});
```
### send<a name="section137609541324"></a>
......@@ -246,32 +248,32 @@ send\(data: string | ArrayBuffer\): Promise<boolean\>
通过WebSocket连接发送数据，使用Promise方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| data | string \| ArrayBuffer <sup>8+</sup> | 是 | 发送的数据。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| data | string \| ArrayBuffer <sup>8+</sup> | 是 | 发送的数据。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :----------------- | :-------------------------------- |
| Promise\<boolean\> | 以Promise形式返回发送数据的结果。 |
| 类型 | 说明 |
| :----------------- | :-------------------------------- |
| Promise\<boolean\> | 以Promise形式返回发送数据的结果。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) => {
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err, value) => {
let promise = ws.send("Hello, server!");
promise.then((value) => {
console.log("send success")
}).catch((err) => {
console.log("send fail, error:" + JSON.stringify(err))
});
});
```
});
```
### close<a name="section202411451433"></a>
......@@ -280,25 +282,25 @@ close\(callback: AsyncCallback<boolean\>\): void
关闭WebSocket连接，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------- |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------- |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.close((err, value) => {
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.close((err, value) => {
if (!err) {
console.log("close success")
} else {
console.log("close fail, err is " + JSON.stringify(err))
}
});
```
});
```
### close<a name="section10491513437"></a>
......@@ -307,29 +309,29 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void
根据可选参数code和reason，关闭WebSocket连接，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#section12262183471518)。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#section12262183471518)。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.close({
```
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.close({
code: 1000,
reason: "your reason"
}, (err, value) => {
}, (err, value) => {
if (!err) {
console.log("close success")
} else {
console.log("close fail, err is " + JSON.stringify(err))
}
});
```
});
```
### close<a name="section118451219536"></a>
......@@ -338,33 +340,33 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\>
根据可选参数code和reason，关闭WebSocket连接，使用Promise方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------- | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#section12262183471518)。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------- | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#section12262183471518)。 |
- 返回值
**返回值：**
| 类型 | 说明 |
| :--------------- | :-------------------------------- |
| Promise<boolean> | 以Promise形式返回关闭连接的结果。 |
| 类型 | 说明 |
| :----------------- | :-------------------------------- |
| Promise\<boolean\> | 以Promise形式返回关闭连接的结果。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.close({
```
let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.close({
code: 1000,
reason: "your reason"
});
promise.then((value) => {
});
promise.then((value) => {
console.log("close success")
}).catch((err) => {
}).catch((err) => {
console.log("close fail, err is " + JSON.stringify(err))
});
```
});
```
### on\('open'\)<a name="section923017271834"></a>
......@@ -373,22 +375,22 @@ on\(type: 'open', callback: AsyncCallback<Object\>\): void
订阅WebSocket的打开事件，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open'：WebSocket的打开事件。 |
| callback | AsyncCallback\<Object\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open'：WebSocket的打开事件。 |
| callback | AsyncCallback\<Object\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.on('open', (err, value) => {
```
let ws = webSocket.createWebSocket();
ws.on('open', (err, value) => {
console.log("on open, status:" + value.status + ", message:" + value.message);
});
```
});
```
### off\('open'\)<a name="section207051331730"></a>
......@@ -400,24 +402,24 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open'：WebSocket的打开事件。 |
| callback | AsyncCallback\<Object\> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open'：WebSocket的打开事件。 |
| callback | AsyncCallback\<Object\> | 否 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
let callback1 = (err, value) => {
```
let ws = webSocket.createWebSocket();
let callback1 = (err, value) => {
console.log("on open, status:" + value.status + ", message:" + value.message);
}
ws.on('open', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅
ws.off('open', callback1);
```
}
ws.on('open', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅
ws.off('open', callback1);
```
### on\('message'\)<a name="section1066819418488"></a>
......@@ -429,22 +431,22 @@ on\(type: 'message', callback: AsyncCallback<string | ArrayBuffer\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback\<string \| ArrayBuffer <sup>8+</sup>\> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback\<string \| ArrayBuffer <sup>8+</sup>\> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.on('message', (err, value) => {
```
let ws = webSocket.createWebSocket();
ws.on('message', (err, value) => {
console.log("on message, message:" + value);
});
```
});
```
### off\('message'\)<a name="section1467019413484"></a>
......@@ -457,19 +459,19 @@ off\(type: 'message', callback?: AsyncCallback<string | ArrayBuffer\>\): void
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback\<string \|ArrayBuffer <sup>8+</sup>\> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback\<string \|ArrayBuffer <sup>8+</sup>\> | 否 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.off('message');
```
```
let ws = webSocket.createWebSocket();
ws.off('message');
```
### on\('close'\)<a name="section169378107484"></a>
......@@ -478,21 +480,21 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\
订阅WebSocket的关闭事件，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close'：WebSocket的关闭事件。 |
| callback | AsyncCallback<{ code: number, reason: string }> | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close'：WebSocket的关闭事件。 |
| callback | AsyncCallback<{ code: number, reason: string }> | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.on('close', (err, value) => {
```
let ws = webSocket.createWebSocket();
ws.on('close', (err, value) => {
console.log("on close, code is " + value.code + ", reason is " + value.reason);
});
```
});
```
### off\('close'\)<a name="section993911074812"></a>
......@@ -504,20 +506,20 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close'：WebSocket的关闭事件。 |
| callback | AsyncCallback<{ code: number, reason: string }> | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close'：WebSocket的关闭事件。 |
| callback | AsyncCallback<{ code: number, reason: string }> | 否 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.off('close');
```
```
let ws = webSocket.createWebSocket();
ws.off('close');
```
### on\('error'\)<a name="section2997161484815"></a>
......@@ -526,22 +528,22 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅WebSocket的Error事件，使用callback方式作为异步方法。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error'：WebSocket的Error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error'：WebSocket的Error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.on('error', (err) => {
```
let ws = webSocket.createWebSocket();
ws.on('error', (err) => {
console.log("on error, error:" + JSON.stringify(err))
});
```
});
```
### off\('error'\)<a name="section13999114164815"></a>
......@@ -553,19 +555,19 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
- 参数
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error'：WebSocket的Error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error'：WebSocket的Error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
- 示例
**示例：**
```
let ws = webSocket.createWebSocket();
ws.off('error');
```
```
let ws = webSocket.createWebSocket();
ws.off('error');
```
## WebSocketRequestOptions<a name="section11251233123910"></a>
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或