Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 2eaa9440 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!17529 Add tls on off 

Merge pull request !17529 from Yangys/Release3.2_tlsonoff
上级 a6e64489 52f5139c
显示空白变更内容
内联 并排
Showing with 327 addition and 145 deletion
zh-cn/application-dev/connectivity/net-sharing.md
浏览文件 @ 2eaa9440
......@@ -60,7 +60,7 @@
4. 接收到共享状态开启的回调，开启共享成功。
```js
// 从@ohos.net.sharing中导入sharing命名空间
// 从@ohos.net.sharing中导入sharing命名空间
import sharing from '@ohos.net.sharing'
// 注册监听共享状态的改变
......@@ -85,7 +85,7 @@ sharing.startSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => {
4. 接收到共享状态关闭的回调，停止共享成功。
```js
// 从@ohos.net.sharing中导入sharing命名空间
// 从@ohos.net.sharing中导入sharing命名空间
import sharing from '@ohos.net.sharing'
// 注册监听共享状态的改变
......@@ -110,7 +110,7 @@ sharing.stopSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => {
4. 调用stopSharing方法，来停止指定类型共享，共享网络数据量清零。
```js
// 从@ohos.net.sharing中导入sharing命名空间
// 从@ohos.net.sharing中导入sharing命名空间
import sharing from '@ohos.net.sharing'
// 调用startSharing方法，来开启指定类型共享
......
zh-cn/application-dev/connectivity/socket-connection.md
浏览文件 @ 2eaa9440
......@@ -87,43 +87,42 @@ UDP与TCP流程大体类似，下面以TCP为例：
7. Socket连接使用完毕后，主动关闭。
```js
import socket from '@ohos.net.socket'
```js
import socket from '@ohos.net.socket'
// 创建一个TCPSocket连接，返回一个TCPSocket对象。
let tcp = socket.constructTCPSocketInstance();
// 创建一个TCPSocket连接，返回一个TCPSocket对象。
let tcp = socket.constructTCPSocketInstance();
// 订阅TCPSocket相关的订阅事件
tcp.on('message', value => {
// 订阅TCPSocket相关的订阅事件
tcp.on('message', value => {
console.log("on message")
let buffer = value.message
let dataView = new DataView(buffer)
let str = ""
for (let i = 0;i < dataView.byteLength; ++i) {
for (let i = 0; i < dataView.byteLength; ++i) {
str += String.fromCharCode(dataView.getUint8(i))
}
console.log("on connect received:" + str)
});
tcp.on('connect', () => {
});
tcp.on('connect', () => {
console.log("on connect")
});
tcp.on('close', () => {
});
tcp.on('close', () => {
console.log("on close")
});
});
// 绑定本地IP地址和端口。
let bindAddress = {
// 绑定IP地址和端口。
let bindAddress = {
address: '192.168.xx.xx',
port: 1234, // 绑定端口，如1234
family: 1
};
tcp.bind(bindAddress, err => {
};
tcp.bind(bindAddress, err => {
if (err) {
console.log('bind fail');
return;
}
console.log('bind success');
// 连接到指定的IP地址和端口。
let connectAddress = {
address: '192.168.xx.xx',
......@@ -138,7 +137,6 @@ UDP与TCP流程大体类似，下面以TCP为例：
return;
}
console.log('connect success');
// 发送数据
tcp.send({
data: 'Hello, server!'
......@@ -150,18 +148,17 @@ UDP与TCP流程大体类似，下面以TCP为例：
console.log('send success');
})
});
});
// 连接使用完毕后，主动关闭。取消相关事件的订阅。
setTimeout(() => {
});
// 连接使用完毕后，主动关闭。取消相关事件的订阅。
setTimeout(() => {
tcp.close((err) => {
console.log('close socket.')
});
tcp.off('message');
tcp.off('connect');
tcp.off('close');
}, 30 * 1000);
```
}, 30 * 1000);
```
## 应用通过TLS Socket进行加密数据传输
......@@ -206,7 +203,7 @@ tlsTwoWay.on('close', () => {
});
// 绑定本地IP地址和端口。
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: xxxx, family: 1}, err => {
tlsTwoWay.bind({ address: '192.168.xxx.xxx', port: xxxx, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -278,7 +275,7 @@ tlsTwoWay.on('close', () => {
});
// 绑定本地IP地址和端口。
tlsOneWay.bind({address: '192.168.xxx.xxx', port: xxxx, family: 1}, err => {
tlsOneWay.bind({ address: '192.168.xxx.xxx', port: xxxx, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ 2eaa9440
......@@ -64,6 +64,9 @@ httpRequest.request(
);
```
> **说明：**
> console.info()输出的数据中包含换行符会导致数据出现截断现象。
## http.createHttp
createHttp(): HttpRequest
......@@ -97,7 +100,7 @@ request(url: string, callback: AsyncCallback\<HttpResponse\>):void
根据URL地址，发起HTTP网络请求，使用callback方式作为异步方法。
> **说明：**
> 此接口仅支持数据大小为5M以内的数据传输。
> 此接口仅支持数据大小为5M以内的数据接收。
**需要权限**：ohos.permission.INTERNET
......@@ -148,7 +151,7 @@ request(url: string, options: HttpRequestOptions, callback: AsyncCallback\<HttpR
根据URL地址和相关配置项，发起HTTP网络请求，使用callback方式作为异步方法。
> **说明：**
> 此接口仅支持数据大小为5M以内的数据传输。
> 此接口仅支持数据大小为5M以内的数据接收。
**需要权限**：ohos.permission.INTERNET
......@@ -234,7 +237,7 @@ request(url: string, options? : HttpRequestOptions): Promise\<HttpResponse\>
根据URL地址，发起HTTP网络请求，使用Promise方式作为异步方法。
> **说明：**
> 此接口仅支持数据大小为5M以内的数据传输。
> 此接口仅支持数据大小为5M以内的数据接收。
**需要权限**：ohos.permission.INTERNET
......@@ -330,9 +333,7 @@ destroy(): void
httpRequest.destroy();
```
```
### on('headerReceive')
### on('headerReceive')<sup>(deprecated)</sup>
on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void
......@@ -358,7 +359,7 @@ httpRequest.on('headerReceive', (data) => {
});
```
### off('headerReceive')
### off('headerReceive')<sup>(deprecated)</sup>
off(type: 'headerReceive', callback?: AsyncCallback\<Object\>): void
......@@ -469,7 +470,7 @@ httpRequest.once('headersReceive', (header) => {
| usingCache<sup>9+</sup> | boolean | 否 | 是否使用缓存，默认为true。 |
| priority<sup>9+</sup> | number | 否 | 优先级，范围\[0,1000]，默认是0。 |
| header | Object | 否 | HTTP请求头字段。默认{'Content-Type': 'application/json'}。 |
| readTimeout | number | 否 | 读取超时时间。单位为毫秒（ms），默认为60000ms。 |
| readTimeout | number | 否 | 读取超时时间。单位为毫秒（ms），默认为60000ms。<br />设置为0表示不会出现超时情况。 |
| connectTimeout | number | 否 | 连接超时时间。单位为毫秒（ms），默认为60000ms。 |
| usingProtocol<sup>9+</sup> | [HttpProtocol](#httpprotocol9) | 否 | 使用协议。默认值由系统自动指定。 |
......
zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md
浏览文件 @ 2eaa9440
......@@ -416,7 +416,7 @@ on(type: 'interfaceStateChange', callback: Callback\<{ iface: string, active: bo
**示例：**
```js
ethernet.on('interfaceStateChange', (data) => {
ethernet.on('interfaceStateChange', (data) => {
console.log('on interfaceSharingStateChange：' + JSON.stringify(data));
});
```
......
zh-cn/application-dev/reference/apis/js-apis-net-policy.md
浏览文件 @ 2eaa9440
......@@ -12,9 +12,9 @@
import policy from '@ohos.net.policy'
```
## policy.setBackgroundPolicy
## policy.setBackgroundAllowed
setBackgroundPolicy(isAllowed: boolean, callback: AsyncCallback\<void>): void
setBackgroundAllowed(isAllowed: boolean, callback: AsyncCallback\<void>): void
设置后台网络策略，使用callback方式作为异步方法。
......@@ -42,18 +42,16 @@ setBackgroundPolicy(isAllowed: boolean, callback: AsyncCallback\<void>): void
**示例：**
```js
policy.setBackgroundPolicy(Boolean(Number.parseInt(this.isBoolean))), (error, data) => {
this.callBack(error, data);
policy.setBackgroundAllowed(Boolean(Number.parseInt(this.isBoolean)), (error) => {
this.callBack(error);
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
}
)
})
;
```
## policy.setBackgroundPolicy
## policy.setBackgroundAllowed
setBackgroundPolicy(isAllowed: boolean): Promise\<void>
setBackgroundAllowed(isAllowed: boolean): Promise\<void>
设置后台网络策略，使用Promise方式作为异步方法。
......@@ -86,9 +84,8 @@ setBackgroundPolicy(isAllowed: boolean): Promise\<void>
**示例：**
```js
policy.setBackgroundPolicy(Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
policy.setBackgroundAllowed(Boolean(Number.parseInt(this.isBoolean))).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -194,8 +191,8 @@ setPolicyByUid(uid: number, policy: NetUidPolicy, callback: AsyncCallback\<void>
let param = {
uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy)
}
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy), (error, data) => {
this.callBack(error, data);
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy), (error) => {
console.log(JSON.stringify(error))
});
```
......@@ -238,9 +235,8 @@ setPolicyByUid(uid: number, policy: NetUidPolicy): Promise\<void>;
let param = {
uid: Number.parseInt(this.firstParam), policy: Number.parseInt(this.currentNetUidPolicy)
}
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy)).then(function (error, data) {
policy.setPolicyByUid(Number.parseInt(this.firstParam), Number.parseInt(this.currentNetUidPolicy)).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -509,8 +505,8 @@ let param = {
};
this.netQuotaPolicyList.push(param);
policy.setNetQuotaPolicies(this.netQuotaPolicyList, (error, data) => {
this.callBack(error, data);
policy.setNetQuotaPolicies(this.netQuotaPolicyList, (error) => {
console.log(JSON.stringify(error))
});
```
......@@ -563,9 +559,8 @@ let param = {
};
this.netQuotaPolicyList.push(param);
policy.setNetQuotaPolicies(this.netQuotaPolicyList).then(function (error, data) {
policy.setNetQuotaPolicies(this.netQuotaPolicyList).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -600,8 +595,8 @@ restoreAllPolicies(iccid: string, callback: AsyncCallback\<void>): void
```js
this.firstParam = iccid;
policy.restoreAllPolicies(this.firstParam, (error, data) => {
this.callBack(error, data);
policy.restoreAllPolicies(this.firstParam, (error) => {
console.log(JSON.stringify(error))
});
```
......@@ -641,9 +636,8 @@ restoreAllPolicies(iccid: string): Promise\<void>;
```js
this.firstParam = iccid;
policy.restoreAllPolicies(this.firstParam).then(function (error, data) {
policy.restoreAllPolicies(this.firstParam).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -724,7 +718,6 @@ isUidNetAllowed(uid: number, isMetered: boolean): Promise\<boolean>;
**示例：**
```js
let param = {
uid: Number.parseInt(this.firstParam), isMetered: Boolean(Number.parseInt(this.isBoolean))
}
......@@ -766,7 +759,6 @@ isUidNetAllowed(uid: number, iface: string, callback: AsyncCallback\<boolean>):
**示例：**
```js
let param = {
uid: Number.parseInt(this.firstParam), iface: this.secondParam
}
......@@ -818,7 +810,6 @@ policy.isUidNetAllowed(Number.parseInt(this.firstParam), this.secondParam).then(
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
## policy.setDeviceIdleAllowList
......@@ -855,8 +846,8 @@ setDeviceIdleAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback\
let param = {
uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
}
policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error, data) => {
this.callBack(error, data);
policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error) => {
console.log(JSON.stringify(error))
});
```
......@@ -899,9 +890,8 @@ setDeviceIdleAllowList(uid: number, isAllowed: boolean): Promise\<void>;
let param = {
uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
}
policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
policy.setDeviceIdleAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -1080,8 +1070,8 @@ resetPolicies(iccid: string, callback: AsyncCallback\<void>): void
```js
this.firstParam = iccid
policy.resetPolicies(this.firstParam, (error, data) => {
this.callBack(error, data);
policy.resetPolicies(this.firstParam, (error) => {
console.log(JSON.stringify(error))
});
```
......@@ -1124,9 +1114,8 @@ policy.getUidsByPolicy(Number.parseInt(this.firstParam)).then(function (error, d
})
this.firstParam = iccid
policy.resetPolicies(this.firstParam).then(function (error, data) {
policy.resetPolicies(this.firstParam).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -1252,8 +1241,8 @@ setPowerSaveAllowList(uid: number, isAllowed: boolean, callback: AsyncCallback\<
let param = {
uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
}
policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error, data) => {
this.callBack(error, data);
policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean)), (error) => {
console.log(JSON.stringify(error))
});
```
......@@ -1296,9 +1285,8 @@ setPowerSaveAllowList(uid: number, isAllowed: boolean): Promise\<void>;
let param = {
uid: Number.parseInt(this.firstParam), isAllowed: Boolean(Number.parseInt(this.isBoolean))
}
policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error, data) {
policy.setPowerSaveAllowList(Number.parseInt(this.firstParam), Boolean(Number.parseInt(this.isBoolean))).then(function (error) {
console.log(JSON.stringify(error))
console.log(JSON.stringify(data))
})
```
......@@ -1393,7 +1381,7 @@ on(type: "netUidPolicyChange", callback: Callback\<{ uid: number, policy: NetUid
```js
policy.on('netUidPolicyChange', (data) => {
this.log('on netUidPolicyChange：' + JSON.stringify(data));
this.log('on netUidPolicyChange: ' + JSON.stringify(data));
})
```
......@@ -1418,7 +1406,7 @@ on(type: "netUidRuleChange", callback: Callback\<{ uid: number, rule: NetUidRule
```js
policy.on('netUidRuleChange', (data) => {
this.log('on netUidRuleChange：' + JSON.stringify(data));
this.log('on netUidRuleChange: ' + JSON.stringify(data));
})
```
......@@ -1443,7 +1431,7 @@ on(type: "netMeteredIfacesChange", callback: Callback\<Array\<string>>): void
```js
policy.on('netMeteredIfacesChange', (data) => {
this.log('on netMeteredIfacesChange：' + JSON.stringify(data));
this.log('on netMeteredIfacesChange: ' + JSON.stringify(data));
})
```
......@@ -1468,7 +1456,7 @@ on(type: "netQuotaPolicyChange", callback: Callback\<Array\<NetQuotaPolicy>>): v
```js
policy.on('netQuotaPolicyChange', (data) => {
this.log('on netQuotaPolicyChange：' + JSON.stringify(data));
this.log('on netQuotaPolicyChange: ' + JSON.stringify(data));
})
```
......@@ -1493,7 +1481,7 @@ on(type: "netBackgroundPolicyChange", callback: Callback\<boolean>): void
```js
policy.on('netBackgroundPolicyChange', (data) => {
this.log('on netBackgroundPolicyChange：' + JSON.stringify(data));
this.log('on netBackgroundPolicyChange: ' + JSON.stringify(data));
})
```
......
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ 2eaa9440
......@@ -42,6 +42,9 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void
绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方式作为异步方法。
> **说明：**
> 客户端使用该方法创建socket。
**需要权限**：ohos.permission.INTERNET
**系统能力**：SystemCapability.Communication.NetStack
......@@ -79,6 +82,9 @@ bind(address: NetAddress): Promise\<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。
> **说明：**
> 客户端使用该方法创建socket。
**需要权限**：ohos.permission.INTERNET
**系统能力**：SystemCapability.Communication.NetStack
......@@ -733,6 +739,9 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void
绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方法作为异步方法。
> **说明：**
> 客户端使用该方法创建socket。
**需要权限**：ohos.permission.INTERNET
**系统能力**：SystemCapability.Communication.NetStack
......@@ -770,6 +779,9 @@ bind(address: NetAddress): Promise\<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。
> **说明：**
> 客户端使用该方法创建socket。
**需要权限**：ohos.permission.INTERNET
**系统能力**：SystemCapability.Communication.NetStack
......@@ -1605,7 +1617,7 @@ bind(address: NetAddress, callback: AsyncCallback\<void\>): void
**示例：**
```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -1648,7 +1660,7 @@ bind(address: NetAddress): Promise\<void\>
**示例：**
```js
let promise = tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1});
let promise = tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
promise.then(() => {
console.log('bind success');
}).catch(err => {
......@@ -1680,7 +1692,7 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
**示例：**
```js
let promise = tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
let promise = tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -1720,7 +1732,7 @@ getState(): Promise\<SocketStateBase\>
**示例：**
```js
let promiseBind = tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1});
let promiseBind = tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
promiseBind.then(() => {
console.log('bind success');
}).catch((err) => {
......@@ -1760,7 +1772,7 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
**示例：**
```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -1772,7 +1784,7 @@ tls.setExtraOptions({
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: {on: true, linger: 10},
socketLinger: { on: true, linger: 10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
......@@ -1784,7 +1796,6 @@ tls.setExtraOptions({
}
console.log('setExtraOptions success');
});
```
### setExtraOptions<sup>9+</sup>
......@@ -1818,7 +1829,7 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\>
**示例：**
```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -1829,7 +1840,7 @@ let promise = tls.setExtraOptions({
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: {on: true, linger: 10},
socketLinger: { on: true, linger: 10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
......@@ -1842,6 +1853,191 @@ promise.then(() => {
});
```
### on('message')
on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void;
订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。 |
**示例：**
```js
let tls = socket.constructTLSSocketInstance();
tls.on('message', value => {
for (var i = 0; i < value.message.length; i++) {
let messages = value.message[i]
let message = String.fromCharCode(messages);
let messageView = '';
messageView += item;
}
console.log('on message message: ' + JSON.stringify(messageView));
console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
});
```
### off('message')
off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
取消订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。
> **说明：**
> 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。message：接收到的消息；remoteInfo：socket连接信息。|
**示例：**
```js
let tls = socket.constructTLSSocketInstance();
let callback = value => {
for (var i = 0; i < value.message.length; i++) {
let messages = value.message[i]
let message = String.fromCharCode(messages);
let messageView = '';
messageView += item;
}
console.log('on message message: ' + JSON.stringify(messageView));
console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
tls.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('message', callback);
```
### on('connect' | 'close')
on(type: 'connect' | 'close', callback: Callback\<void\>): void
订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'connect'：连接事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 是 | 回调函数。 |
**示例：**
```js
let tls = socket.constructTLSSocketInstance();
tls.on('connect', () => {
console.log("on connect success")
});
tls.on('close', () => {
console.log("on close success")
});
```
### off('connect' | 'close')
off(type: 'connect' | 'close', callback?: Callback\<void\>): void
取消订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。
> **说明：**
> 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 订阅的事件类型。<br />- 'connect'：连接事件。<br />- 'close'：关闭事件。 |
| callback | Callback\<void\> | 否 | 回调函数。 |
**示例：**
```js
let tls = socket.constructTLSSocketInstance();
let callback1 = () => {
console.log("on connect success");
}
tls.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('connect', callback1);
tls.off('connect');
let callback2 = () => {
console.log("on close success");
}
tls.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('close', callback2);
```
### on('error')
on(type: 'error', callback: ErrorCallback): void
订阅TLSSocket连接的error事件。使用callback方式作为异步方法。
**系统能力**：SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
**示例：**
```js
let tls = socket.constructTLSSocketInstance();
tls.on('error', err => {
console.log("on error, err:" + JSON.stringify(err))
});
```
### off('error')
off(type: 'error', callback?: ErrorCallback): void
取消订阅TLSSocket连接的error事件。使用callback方式作为异步方法。
> **说明：**
> 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------------ |
| type | string | 是 | 订阅的事件类型。'error'：error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
**示例：**
```js
let tls = socket.constructTLSSocketInstance();
let callback = err => {
console.log("on error, err:" + JSON.stringify(err));
}
tls.on('error', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
tls.off('error', callback);
```
### connect<sup>9+</sup>
connect(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void
......@@ -1881,7 +2077,7 @@ connect(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void
```js
let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
tlsTwoWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -1912,7 +2108,7 @@ tlsTwoWay.connect(options, (err, data) => {
});
let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
tlsOneWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -1980,7 +2176,7 @@ connect(options: TLSConnectOptions): Promise\<void\>
```js
let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
tlsTwoWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......@@ -2012,7 +2208,7 @@ tlsTwoWay.connect(options).then(data => {
});
let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind({address: '192.168.xxx.xxx', port: 8080, family: 1}, err => {
tlsOneWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
if (err) {
console.log('bind fail');
return;
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或