js-apis-socket.md 167.5 KB
Newer Older
1
# @ohos.net.socket (Socket连接)
C
clevercong 已提交
2

Y
Yangys 已提交
3 4
本模块提供利用Socket进行数据传输的能力,支持TCPSocket、UDPSocket、WebSocket和TLSSocket。

Y
Yangys 已提交
5
> **说明:**
C
clevercong 已提交
6
>
7
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
C
clevercong 已提交
8

C
clevercong 已提交
9
## 导入模块
C
clevercong 已提交
10

Z
zengyawen 已提交
11
```js
C
clevercong 已提交
12 13 14
import socket from '@ohos.net.socket';
```

X
xujie 已提交
15
## socket.constructUDPSocketInstance<sup>7+</sup>
C
clevercong 已提交
16

Y
Yangys 已提交
17
constructUDPSocketInstance(): UDPSocket
C
clevercong 已提交
18 19 20

创建一个UDPSocket对象。

C
clevercong 已提交
21
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
22

C
clevercong 已提交
23
**返回值:**
C
clevercong 已提交
24

C
clevercong 已提交
25 26
| 类型                               | 说明                    |
| :--------------------------------- | :---------------------- |
C
clevercong 已提交
27
| [UDPSocket](#udpsocket) | 返回一个UDPSocket对象。 |
C
clevercong 已提交
28

C
clevercong 已提交
29
**示例:**
C
clevercong 已提交
30

Z
zengyawen 已提交
31
```js
C
clevercong 已提交
32 33
let udp = socket.constructUDPSocketInstance();
```
C
clevercong 已提交
34

X
xujie 已提交
35
## UDPSocket<sup>7+</sup>
C
clevercong 已提交
36

C
clevercong 已提交
37
UDPSocket连接。在调用UDPSocket的方法前,需要先通过[socket.constructUDPSocketInstance](#socketconstructudpsocketinstance)创建UDPSocket对象。
C
clevercong 已提交
38

X
xujie 已提交
39
### bind<sup>7+</sup>
C
clevercong 已提交
40

Y
Yangys 已提交
41
bind(address: NetAddress, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
42 43 44

绑定IP地址和端口,端口可以指定或由系统随机分配。使用callback方式作为异步方法。

C
clevercong 已提交
45 46
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
47
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
48

C
clevercong 已提交
49
**参数:**
C
clevercong 已提交
50

C
clevercong 已提交
51 52
| 参数名   | 类型                               | 必填 | 说明                                                   |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
C
clevercong 已提交
53
| address  | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
C
clevercong 已提交
54
| callback | AsyncCallback\<void\>              | 是   | 回调函数。                                             |
C
clevercong 已提交
55

Y
Yangys 已提交
56 57 58 59 60 61 62
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
63
**示例:**
C
clevercong 已提交
64

Z
zengyawen 已提交
65
```js
C
clevercong 已提交
66
let udp = socket.constructUDPSocketInstance();
X
xujie 已提交
67
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
Y
Yangys 已提交
68 69 70 71 72
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
C
clevercong 已提交
73 74
})
```
C
clevercong 已提交
75

X
xujie 已提交
76
### bind<sup>7+</sup>
C
clevercong 已提交
77

Y
Yangys 已提交
78
bind(address: NetAddress): Promise\<void\>
C
clevercong 已提交
79 80 81

绑定IP地址和端口,端口可以指定或由系统随机分配。使用Promise方式作为异步方法。

C
clevercong 已提交
82 83
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
84
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
85

C
clevercong 已提交
86
**参数:**
C
clevercong 已提交
87

C
clevercong 已提交
88 89
| 参数名  | 类型                               | 必填 | 说明                                                   |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
C
clevercong 已提交
90
| address | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
C
clevercong 已提交
91

Y
Yangys 已提交
92 93 94 95 96 97
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |
C
clevercong 已提交
98

C
clevercong 已提交
99
**返回值:**
C
clevercong 已提交
100

C
clevercong 已提交
101 102 103
| 类型            | 说明                                       |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式异步返回UDPSocket绑定的结果。 |
C
clevercong 已提交
104

C
clevercong 已提交
105
**示例:**
C
clevercong 已提交
106

Z
zengyawen 已提交
107
```js
C
clevercong 已提交
108
let udp = socket.constructUDPSocketInstance();
Y
Yangys 已提交
109
let promise = udp.bind({ address: '192.168.xx.xxx', port: 8080, family: 1 });
Y
Yangys 已提交
110
promise.then(() => {
Y
Yangys 已提交
111
  console.log('bind success');
C
clevercong 已提交
112
}).catch(err => {
Y
Yangys 已提交
113
  console.log('bind fail');
C
clevercong 已提交
114 115
});
```
C
clevercong 已提交
116

X
xujie 已提交
117
### send<sup>7+</sup>
C
clevercong 已提交
118

Y
Yangys 已提交
119
send(options: UDPSendOptions, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
120 121 122

通过UDPSocket连接发送数据。使用callback方式作为异步方法。

123 124
发送数据前,需要先调用[UDPSocket.bind()](#bind)绑定IP地址和端口。

C
clevercong 已提交
125 126
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
127
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
128

C
clevercong 已提交
129 130 131 132
**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
133
| options  | [UDPSendOptions](#udpsendoptions) | 是   | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 |
C
clevercong 已提交
134 135
| callback | AsyncCallback\<void\>                    | 是   | 回调函数。                                                   |

Y
Yangys 已提交
136 137 138 139 140 141 142
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
143 144
**示例:**

Z
zengyawen 已提交
145
```js
C
clevercong 已提交
146 147
let udp = socket.constructUDPSocketInstance();
udp.send({
Y
Yangys 已提交
148 149 150 151 152 153
  data: 'Hello, server!',
  address: {
    address: '192.168.xx.xxx',
    port: xxxx,
    family: 1
  }
Y
Yangys 已提交
154
}, err => {
Y
Yangys 已提交
155 156 157 158 159
  if (err) {
    console.log('send fail');
    return;
  }
  console.log('send success');
C
clevercong 已提交
160 161
})
```
C
clevercong 已提交
162

X
xujie 已提交
163
### send<sup>7+</sup>
C
clevercong 已提交
164

Y
Yangys 已提交
165
send(options: UDPSendOptions): Promise\<void\>
C
clevercong 已提交
166 167 168

通过UDPSocket连接发送数据。使用Promise方式作为异步方法。

169 170
发送数据前,需要先调用[UDPSocket.bind()](#bind)绑定IP地址和端口。

C
clevercong 已提交
171 172
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
173
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
174

C
clevercong 已提交
175
**参数:**
C
clevercong 已提交
176

C
clevercong 已提交
177 178
| 参数名  | 类型                                     | 必填 | 说明                                                         |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
179
| options | [UDPSendOptions](#udpsendoptions) | 是   | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 |
C
clevercong 已提交
180

Y
Yangys 已提交
181 182 183 184 185 186 187
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
188
**返回值:**
C
clevercong 已提交
189

C
clevercong 已提交
190 191 192
| 类型            | 说明                                           |
| :-------------- | :--------------------------------------------- |
| Promise\<void\> | 以Promise形式返回UDPSocket连接发送数据的结果。 |
C
clevercong 已提交
193

C
clevercong 已提交
194
**示例:**
C
clevercong 已提交
195

Z
zengyawen 已提交
196
```js
C
clevercong 已提交
197 198
let udp = socket.constructUDPSocketInstance();
let promise = udp.send({
Y
Yangys 已提交
199 200 201 202 203 204
  data: 'Hello, server!',
  address: {
    address: '192.168.xx.xxx',
    port: xxxx,
    family: 1
  }
C
clevercong 已提交
205 206
});
promise.then(() => {
Y
Yangys 已提交
207
  console.log('send success');
C
clevercong 已提交
208
}).catch(err => {
Y
Yangys 已提交
209
  console.log('send fail');
C
clevercong 已提交
210 211
});
```
C
clevercong 已提交
212

X
xujie 已提交
213
### close<sup>7+</sup>
C
clevercong 已提交
214

Y
Yangys 已提交
215
close(callback: AsyncCallback\<void\>): void
C
clevercong 已提交
216 217 218

关闭UDPSocket连接。使用callback方式作为异步方法。

C
clevercong 已提交
219 220
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
221
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
222

C
clevercong 已提交
223
**参数:**
C
clevercong 已提交
224

C
clevercong 已提交
225 226 227
| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |
C
clevercong 已提交
228

C
clevercong 已提交
229
**示例:**
C
clevercong 已提交
230

Z
zengyawen 已提交
231
```js
C
clevercong 已提交
232 233
let udp = socket.constructUDPSocketInstance();
udp.close(err => {
Y
Yangys 已提交
234 235 236 237 238
  if (err) {
    console.log('close fail');
    return;
  }
  console.log('close success');
C
clevercong 已提交
239 240
})
```
C
clevercong 已提交
241

X
xujie 已提交
242
### close<sup>7+</sup>
C
clevercong 已提交
243

Y
Yangys 已提交
244
close(): Promise\<void\>
C
clevercong 已提交
245 246 247

关闭UDPSocket连接。使用Promise方式作为异步方法。

C
clevercong 已提交
248 249
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
250
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
251

C
clevercong 已提交
252
**返回值:**
C
clevercong 已提交
253

C
clevercong 已提交
254 255 256
| 类型            | 说明                                       |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭UDPSocket连接的结果。 |
C
clevercong 已提交
257

C
clevercong 已提交
258
**示例:**
C
clevercong 已提交
259

Z
zengyawen 已提交
260
```js
C
clevercong 已提交
261 262 263
let udp = socket.constructUDPSocketInstance();
let promise = udp.close();
promise.then(() => {
Y
Yangys 已提交
264
  console.log('close success');
C
clevercong 已提交
265
}).catch(err => {
Y
Yangys 已提交
266
  console.log('close fail');
C
clevercong 已提交
267 268
});
```
C
clevercong 已提交
269

X
xujie 已提交
270
### getState<sup>7+</sup>
C
clevercong 已提交
271

Y
Yangys 已提交
272
getState(callback: AsyncCallback\<SocketStateBase\>): void
C
clevercong 已提交
273 274 275

获取UDPSocket状态。使用callback方式作为异步方法。

Y
Yangys 已提交
276 277
> **说明:**
> bind方法调用成功后,才可调用此方法。
C
clevercong 已提交
278 279

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
280

C
clevercong 已提交
281
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
282

C
clevercong 已提交
283 284 285 286
**参数:**

| 参数名   | 类型                                                   | 必填 | 说明       |
| -------- | ------------------------------------------------------ | ---- | ---------- |
C
clevercong 已提交
287
| callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是   | 回调函数。 |
C
clevercong 已提交
288

Y
Yangys 已提交
289 290 291 292 293 294
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |

C
clevercong 已提交
295 296
**示例:**

Z
zengyawen 已提交
297
```js
C
clevercong 已提交
298 299
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
Y
Yangys 已提交
300 301 302 303 304 305
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  udp.getState((err, data) => {
Y
Yangys 已提交
306
    if (err) {
Y
Yangys 已提交
307 308
      console.log('getState fail');
      return;
Y
Yangys 已提交
309
    }
Y
Yangys 已提交
310 311
    console.log('getState success:' + JSON.stringify(data));
  })
C
clevercong 已提交
312 313
})
```
C
clevercong 已提交
314

X
xujie 已提交
315
### getState<sup>7+</sup>
C
clevercong 已提交
316

Y
Yangys 已提交
317
getState(): Promise\<SocketStateBase\>
C
clevercong 已提交
318 319 320

获取UDPSocket状态。使用Promise方式作为异步方法。

Y
Yangys 已提交
321 322
> **说明:**
> bind方法调用成功后,才可调用此方法。
C
clevercong 已提交
323 324

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
325

C
clevercong 已提交
326
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
327

C
clevercong 已提交
328
**返回值:**
C
clevercong 已提交
329

C
clevercong 已提交
330 331
| 类型                                             | 说明                                       |
| :----------------------------------------------- | :----------------------------------------- |
Y
Yangys 已提交
332
| Promise\<[SocketStateBase](#socketstatebase)\> | 以Promise形式返回获取UDPSocket状态的结果。 |
C
clevercong 已提交
333

C
clevercong 已提交
334
**示例:**
C
clevercong 已提交
335

Z
zengyawen 已提交
336
```js
C
clevercong 已提交
337
let udp = socket.constructUDPSocketInstance();
Y
Yangys 已提交
338
let promise = udp.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
Y
Yangys 已提交
339
promise.then(err => {
Y
Yangys 已提交
340 341 342 343 344 345 346 347 348 349 350
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  let promise = udp.getState();
  promise.then(data => {
    console.log('getState success:' + JSON.stringify(data));
  }).catch(err => {
    console.log('getState fail');
  });
Y
Yangys 已提交
351
});
C
clevercong 已提交
352
```
C
clevercong 已提交
353

X
xujie 已提交
354
### setExtraOptions<sup>7+</sup>
C
clevercong 已提交
355

Y
Yangys 已提交
356
setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
357 358 359

设置UDPSocket连接的其他属性。使用callback方式作为异步方法。

Y
Yangys 已提交
360 361
> **说明:**
> bind方法调用成功后,才可调用此方法。
C
clevercong 已提交
362 363

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
364

C
clevercong 已提交
365
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
366

C
clevercong 已提交
367 368 369 370
**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
371
| options  | [UDPExtraOptions](#udpextraoptions) | 是   | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 |
C
clevercong 已提交
372 373
| callback | AsyncCallback\<void\>                    | 是   | 回调函数。                                                   |

Y
Yangys 已提交
374 375 376 377 378 379
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |
C
clevercong 已提交
380 381 382

**示例:**

Z
zengyawen 已提交
383
```js
C
clevercong 已提交
384
let udp = socket.constructUDPSocketInstance();
Y
Yangys 已提交
385
udp.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
Y
Yangys 已提交
386 387 388 389 390 391 392 393 394 395 396 397
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  udp.setExtraOptions({
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: false,
    socketTimeout: 6000,
    broadcast: true
  }, err => {
Y
Yangys 已提交
398
    if (err) {
Y
Yangys 已提交
399 400
      console.log('setExtraOptions fail');
      return;
Y
Yangys 已提交
401
    }
Y
Yangys 已提交
402 403
    console.log('setExtraOptions success');
  })
C
clevercong 已提交
404 405
})
```
C
clevercong 已提交
406

X
xujie 已提交
407
### setExtraOptions<sup>7+</sup>
C
clevercong 已提交
408

Y
Yangys 已提交
409
setExtraOptions(options: UDPExtraOptions): Promise\<void\>
C
clevercong 已提交
410 411 412

设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。

Y
Yangys 已提交
413 414
> **说明:**
> bind方法调用成功后,才可调用此方法。
C
clevercong 已提交
415 416

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
417

C
clevercong 已提交
418
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
419

C
clevercong 已提交
420 421 422 423
**参数:**

| 参数名  | 类型                                     | 必填 | 说明                                                         |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
424
| options | [UDPExtraOptions](#udpextraoptions) | 是   | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 |
C
clevercong 已提交
425 426 427 428 429 430 431

**返回值:**

| 类型            | 说明                                                 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 |

Y
Yangys 已提交
432 433 434 435 436 437 438
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
439 440
**示例:**

Z
zengyawen 已提交
441
```js
C
clevercong 已提交
442
let udp = socket.constructUDPSocketInstance();
Y
Yangys 已提交
443
let promise = udp.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
C
clevercong 已提交
444
promise.then(() => {
Y
Yangys 已提交
445 446 447 448 449 450 451 452 453 454 455 456 457
  console.log('bind success');
  let promise1 = udp.setExtraOptions({
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: false,
    socketTimeout: 6000,
    broadcast: true
  });
  promise1.then(() => {
    console.log('setExtraOptions success');
  }).catch(err => {
    console.log('setExtraOptions fail');
  });
C
clevercong 已提交
458
}).catch(err => {
Y
Yangys 已提交
459
  console.log('bind fail');
C
clevercong 已提交
460 461
});
```
C
clevercong 已提交
462

X
xujie 已提交
463
### on('message')<sup>7+</sup>
C
clevercong 已提交
464

Y
Yangys 已提交
465
on(type: 'message', callback: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
C
clevercong 已提交
466 467 468

订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。

C
clevercong 已提交
469
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
470

C
clevercong 已提交
471
**参数:**
C
clevercong 已提交
472

C
clevercong 已提交
473 474 475
| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
Y
Yangys 已提交
476
| callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是   | 回调函数。                                |
C
clevercong 已提交
477

C
clevercong 已提交
478
**示例:**
C
clevercong 已提交
479

Z
zengyawen 已提交
480
```js
C
clevercong 已提交
481
let udp = socket.constructUDPSocketInstance();
X
xujie 已提交
482
let messageView = '';
C
clevercong 已提交
483
udp.on('message', value => {
Y
Yangys 已提交
484 485 486
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
X
xujie 已提交
487
    messageView += message;
Y
Yangys 已提交
488 489 490
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
C
clevercong 已提交
491 492
});
```
C
clevercong 已提交
493

X
xujie 已提交
494
### off('message')<sup>7+</sup>
C
clevercong 已提交
495

Y
Yangys 已提交
496
off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
C
clevercong 已提交
497 498 499

取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。

Y
Yangys 已提交
500 501
> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
C
clevercong 已提交
502

C
clevercong 已提交
503
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
504

C
clevercong 已提交
505
**参数:**
C
clevercong 已提交
506

C
clevercong 已提交
507 508 509
| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
C
clevercong 已提交
510
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否   | 回调函数。                                |
C
clevercong 已提交
511

C
clevercong 已提交
512
**示例:**
C
clevercong 已提交
513

Z
zengyawen 已提交
514
```js
C
clevercong 已提交
515
let udp = socket.constructUDPSocketInstance();
X
xujie 已提交
516
let messageView = '';
Y
Yangys 已提交
517
let callback = value => {
Y
Yangys 已提交
518 519 520
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
X
xujie 已提交
521
    messageView += message;
Y
Yangys 已提交
522 523 524
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
C
clevercong 已提交
525 526 527 528 529 530
}
udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('message', callback);
udp.off('message');
```
C
clevercong 已提交
531

X
xujie 已提交
532
### on('listening' | 'close')<sup>7+</sup>
C
clevercong 已提交
533

Y
Yangys 已提交
534
on(type: 'listening' | 'close', callback: Callback\<void\>): void
C
clevercong 已提交
535 536 537

订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。

C
clevercong 已提交
538
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
539

C
clevercong 已提交
540
**参数:**
C
clevercong 已提交
541

C
clevercong 已提交
542 543 544 545
| 参数名   | 类型             | 必填 | 说明                                                         |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type     | string           | 是   | 订阅的事件类型。<br />- 'listening':数据包消息事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 是   | 回调函数。                                                   |
C
clevercong 已提交
546

C
clevercong 已提交
547
**示例:**
C
clevercong 已提交
548

Z
zengyawen 已提交
549
```js
C
clevercong 已提交
550 551
let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => {
Y
Yangys 已提交
552
  console.log("on listening success");
C
clevercong 已提交
553 554
});
udp.on('close', () => {
Y
Yangys 已提交
555
  console.log("on close success");
C
clevercong 已提交
556 557
});
```
C
clevercong 已提交
558

X
xujie 已提交
559
### off('listening' | 'close')<sup>7+</sup>
C
clevercong 已提交
560

Y
Yangys 已提交
561
off(type: 'listening' | 'close', callback?: Callback\<void\>): void
C
clevercong 已提交
562 563 564

取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。

Y
Yangys 已提交
565 566
> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
C
clevercong 已提交
567

C
clevercong 已提交
568
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
569

C
clevercong 已提交
570 571 572 573 574 575 576 577 578
**参数:**

| 参数名   | 类型             | 必填 | 说明                                                         |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type     | string           | 是   | 订阅事件类型。<br />- 'listening':数据包消息事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 否   | 回调函数。                                                   |

**示例:**

Z
zengyawen 已提交
579
```js
C
clevercong 已提交
580
let udp = socket.constructUDPSocketInstance();
Y
Yangys 已提交
581
let callback1 = () => {
Y
Yangys 已提交
582
  console.log("on listening, success");
C
clevercong 已提交
583 584 585 586 587
}
udp.on('listening', callback1);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('listening', callback1);
udp.off('listening');
Y
Yangys 已提交
588
let callback2 = () => {
Y
Yangys 已提交
589
  console.log("on close, success");
C
clevercong 已提交
590 591 592 593 594 595
}
udp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('close', callback2);
udp.off('close');
```
C
clevercong 已提交
596

X
xujie 已提交
597
### on('error')<sup>7+</sup>
C
clevercong 已提交
598

Y
Yangys 已提交
599
on(type: 'error', callback: ErrorCallback): void
C
clevercong 已提交
600 601 602

订阅UDPSocket连接的error事件。使用callback方式作为异步方法。

C
clevercong 已提交
603
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
604

C
clevercong 已提交
605
**参数:**
C
clevercong 已提交
606

C
clevercong 已提交
607 608 609 610
| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |
C
clevercong 已提交
611

C
clevercong 已提交
612
**示例:**
C
clevercong 已提交
613

Z
zengyawen 已提交
614
```js
Z
zengyawen 已提交
615
let udp = socket.constructUDPSocketInstance();
C
clevercong 已提交
616
udp.on('error', err => {
Y
Yangys 已提交
617
  console.log("on error, err:" + JSON.stringify(err))
C
clevercong 已提交
618 619
});
```
C
clevercong 已提交
620

X
xujie 已提交
621
### off('error')<sup>7+</sup>
C
clevercong 已提交
622

Y
Yangys 已提交
623
off(type: 'error', callback?: ErrorCallback): void
C
clevercong 已提交
624 625 626

取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。

Y
Yangys 已提交
627 628
> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
C
clevercong 已提交
629

C
clevercong 已提交
630
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
631

C
clevercong 已提交
632
**参数:**
C
clevercong 已提交
633

C
clevercong 已提交
634 635 636 637
| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |
C
clevercong 已提交
638

C
clevercong 已提交
639
**示例:**
C
clevercong 已提交
640

Z
zengyawen 已提交
641
```js
Z
zengyawen 已提交
642
let udp = socket.constructUDPSocketInstance();
Y
Yangys 已提交
643
let callback = err => {
Y
Yangys 已提交
644
  console.log("on error, err:" + JSON.stringify(err));
C
clevercong 已提交
645 646 647 648 649 650
}
udp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('error', callback);
udp.off('error');
```
C
clevercong 已提交
651

X
xujie 已提交
652
## NetAddress<sup>7+</sup>
C
clevercong 已提交
653 654 655

目标地址信息。

Z
zengyawen 已提交
656
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
657

L
liyufan 已提交
658
| 名称  | 类型   | 必填 | 说明                                                         |
C
clevercong 已提交
659 660 661 662 663
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是   | 本地绑定的ip地址。                                           |
| port    | number | 否   | 端口号 ,范围0~65535。如果不指定系统随机分配端口。           |
| family  | number | 否   | 网络协议类型,可选类型:<br />- 1:IPv4<br />- 2:IPv6<br />默认为1。 |

X
xujie 已提交
664
## UDPSendOptions<sup>7+</sup>
C
clevercong 已提交
665 666 667

UDPSocket发送参数。

Z
zengyawen 已提交
668
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
669

L
liyufan 已提交
670
| 名称  | 类型                               | 必填 | 说明           |
C
clevercong 已提交
671
| ------- | ---------------------------------- | ---- | -------------- |
Z
zhuwenchao 已提交
672
| data    | string \| ArrayBuffer<sup>7+</sup>                          | 是   | 发送的数据。   |
C
clevercong 已提交
673
| address | [NetAddress](#netaddress) | 是   | 目标地址信息。 |
C
clevercong 已提交
674

X
xujie 已提交
675
## UDPExtraOptions<sup>7+</sup>
C
clevercong 已提交
676 677 678

UDPSocket连接的其他属性。

Z
zengyawen 已提交
679
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
680

L
liyufan 已提交
681
| 名称            | 类型    | 必填 | 说明                             |
C
clevercong 已提交
682 683
| ----------------- | ------- | ---- | -------------------------------- |
| broadcast         | boolean | 否   | 是否可以发送广播。默认为false。  |
X
xujie 已提交
684 685
| receiveBufferSize | number  | 否   | 接收缓冲区大小(单位:Byte),默认为0。   |
| sendBufferSize    | number  | 否   | 发送缓冲区大小(单位:Byte),默认为0。   |
C
clevercong 已提交
686
| reuseAddress      | boolean | 否   | 是否重用地址。默认为false。      |
X
xujie 已提交
687
| socketTimeout     | number  | 否   | 套接字超时时间,单位毫秒(ms),默认为0。 |
C
clevercong 已提交
688

X
xujie 已提交
689
## SocketStateBase<sup>7+</sup>
C
clevercong 已提交
690 691 692

Socket的状态信息。

Z
zengyawen 已提交
693
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
694

L
liyufan 已提交
695
| 名称      | 类型    | 必填 | 说明       |
C
clevercong 已提交
696 697 698 699 700
| ----------- | ------- | ---- | ---------- |
| isBound     | boolean | 是   | 是否绑定。 |
| isClose     | boolean | 是   | 是否关闭。 |
| isConnected | boolean | 是   | 是否连接。 |

X
xujie 已提交
701
## SocketRemoteInfo<sup>7+</sup>
C
clevercong 已提交
702 703 704

Socket的连接信息。

Z
zengyawen 已提交
705
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
706

L
liyufan 已提交
707
| 名称  | 类型   | 必填 | 说明                                                         |
C
clevercong 已提交
708 709 710 711 712 713
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是   | 本地绑定的ip地址。                                           |
| family  | string | 是   | 网络协议类型,可选类型:<br />- IPv4<br />- IPv6<br />默认为IPv4。 |
| port    | number | 是   | 端口号,范围0~65535。                                        |
| size    | number | 是   | 服务器响应信息的字节长度。                                   |

Y
Yangys 已提交
714
## UDP 错误码说明
Y
Yangys 已提交
715

Y
Yangys 已提交
716
UDP 其余错误码映射形式为:2301000 + Linux内核错误码。
Y
Yangys 已提交
717

Y
Yangys 已提交
718
错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-net-socket.md)
Y
Yangys 已提交
719

X
xujie 已提交
720
## socket.constructTCPSocketInstance<sup>7+</sup>
C
clevercong 已提交
721

Y
Yangys 已提交
722
constructTCPSocketInstance(): TCPSocket
C
clevercong 已提交
723 724 725

创建一个TCPSocket对象。

C
clevercong 已提交
726
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
727

C
clevercong 已提交
728
**返回值:**
C
clevercong 已提交
729

Y
Yangys 已提交
730
| 类型                               | 说明                    |
C
clevercong 已提交
731
  | :--------------------------------- | :---------------------- |
Y
Yangys 已提交
732
| [TCPSocket](#tcpsocket) | 返回一个TCPSocket对象。 |
C
clevercong 已提交
733

C
clevercong 已提交
734
**示例:**
C
clevercong 已提交
735

Z
zengyawen 已提交
736
```js
C
clevercong 已提交
737 738
let tcp = socket.constructTCPSocketInstance();
```
C
clevercong 已提交
739

X
xujie 已提交
740
## TCPSocket<sup>7+</sup>
C
clevercong 已提交
741

C
clevercong 已提交
742
TCPSocket连接。在调用TCPSocket的方法前,需要先通过[socket.constructTCPSocketInstance](#socketconstructtcpsocketinstance)创建TCPSocket对象。
C
clevercong 已提交
743

X
xujie 已提交
744
### bind<sup>7+</sup>
C
clevercong 已提交
745

Y
Yangys 已提交
746
bind(address: NetAddress, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
747 748 749

绑定IP地址和端口,端口可以指定或由系统随机分配。使用callback方法作为异步方法。

C
clevercong 已提交
750 751
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
752
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
753

C
clevercong 已提交
754
**参数:**
C
clevercong 已提交
755

C
clevercong 已提交
756 757
| 参数名   | 类型                               | 必填 | 说明                                                   |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
C
clevercong 已提交
758
| address  | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
C
clevercong 已提交
759
| callback | AsyncCallback\<void\>              | 是   | 回调函数。                                             |
C
clevercong 已提交
760

Y
Yangys 已提交
761 762 763 764 765 766
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |
C
clevercong 已提交
767

C
clevercong 已提交
768
**示例:**
C
clevercong 已提交
769

Z
zengyawen 已提交
770
```js
C
clevercong 已提交
771
let tcp = socket.constructTCPSocketInstance();
X
xujie 已提交
772
tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
Y
Yangys 已提交
773 774 775 776 777
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
C
clevercong 已提交
778 779
})
```
C
clevercong 已提交
780

X
xujie 已提交
781
### bind<sup>7+</sup>
C
clevercong 已提交
782

Y
Yangys 已提交
783
bind(address: NetAddress): Promise\<void\>
C
clevercong 已提交
784 785 786

绑定IP地址和端口,端口可以指定或由系统随机分配。使用Promise方法作为异步方法。

C
clevercong 已提交
787 788
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
789
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
790

C
clevercong 已提交
791
**参数:**
C
clevercong 已提交
792

C
clevercong 已提交
793 794
| 参数名  | 类型                               | 必填 | 说明                                                   |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
C
clevercong 已提交
795
| address | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
C
clevercong 已提交
796

C
clevercong 已提交
797
**返回值:**
C
clevercong 已提交
798

C
clevercong 已提交
799 800 801
| 类型            | 说明                                                     |
| :-------------- | :------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 |
C
clevercong 已提交
802

Y
Yangys 已提交
803 804 805 806 807 808 809
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
810
**示例:**
C
clevercong 已提交
811

Z
zengyawen 已提交
812
```js
C
clevercong 已提交
813
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
814
let promise = tcp.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
C
clevercong 已提交
815
promise.then(() => {
Y
Yangys 已提交
816
  console.log('bind success');
C
clevercong 已提交
817
}).catch(err => {
Y
Yangys 已提交
818
  console.log('bind fail');
C
clevercong 已提交
819 820
});
```
C
clevercong 已提交
821

X
xujie 已提交
822
### connect<sup>7+</sup>
C
clevercong 已提交
823

Y
Yangys 已提交
824
connect(options: TCPConnectOptions, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
825 826 827

连接到指定的IP地址和端口。使用callback方法作为异步方法。

Y
Yangys 已提交
828 829
> **说明:**
> bind方法调用成功后,才可调用此方法。
Y
Yangys 已提交
830

C
clevercong 已提交
831 832
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
833
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
834

C
clevercong 已提交
835
**参数:**
C
clevercong 已提交
836

C
clevercong 已提交
837 838
| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
839
| options  | [TCPConnectOptions](#tcpconnectoptions) | 是   | TCPSocket连接的参数,参考[TCPConnectOptions](#tcpconnectoptions)。 |
C
clevercong 已提交
840
| callback | AsyncCallback\<void\>                    | 是   | 回调函数。                                                   |
C
clevercong 已提交
841

Y
Yangys 已提交
842 843 844 845 846 847 848
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
849
**示例:**
C
clevercong 已提交
850

Z
zengyawen 已提交
851
```js
C
clevercong 已提交
852
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
853
tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 }, err => {
Y
Yangys 已提交
854 855 856 857 858
  if (err) {
    console.log('connect fail');
    return;
  }
  console.log('connect success');
C
clevercong 已提交
859 860
})
```
C
clevercong 已提交
861

X
xujie 已提交
862
### connect<sup>7+</sup>
C
clevercong 已提交
863

Y
Yangys 已提交
864
connect(options: TCPConnectOptions): Promise\<void\>
C
clevercong 已提交
865 866 867

连接到指定的IP地址和端口。使用promise方法作为异步方法。

C
clevercong 已提交
868 869
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
870
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
871

C
clevercong 已提交
872
**参数:**
C
clevercong 已提交
873

C
clevercong 已提交
874 875
| 参数名  | 类型                                     | 必填 | 说明                                                         |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
876
| options | [TCPConnectOptions](#tcpconnectoptions) | 是   | TCPSocket连接的参数,参考[TCPConnectOptions](#tcpconnectoptions)。 |
C
clevercong 已提交
877

C
clevercong 已提交
878
**返回值:**
C
clevercong 已提交
879

C
clevercong 已提交
880 881 882
| 类型            | 说明                                                       |
| :-------------- | :--------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 |
C
clevercong 已提交
883

Y
Yangys 已提交
884 885 886 887 888 889 890
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
891
**示例:**
C
clevercong 已提交
892

Z
zengyawen 已提交
893
```js
C
clevercong 已提交
894
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
895
let promise = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 });
C
clevercong 已提交
896
promise.then(() => {
Y
Yangys 已提交
897
  console.log('connect success')
C
clevercong 已提交
898
}).catch(err => {
Y
Yangys 已提交
899
  console.log('connect fail');
C
clevercong 已提交
900 901
});
```
C
clevercong 已提交
902

X
xujie 已提交
903
### send<sup>7+</sup>
C
clevercong 已提交
904

Y
Yangys 已提交
905
send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
906 907 908

通过TCPSocket连接发送数据。使用callback方式作为异步方法。

Y
Yangys 已提交
909 910
> **说明:**
> connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
911 912

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
913

C
clevercong 已提交
914
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
915

C
clevercong 已提交
916 917 918 919
**参数:**

| 参数名   | 类型                                    | 必填 | 说明                                                         |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
920
| options  | [TCPSendOptions](#tcpsendoptions) | 是   | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 |
C
clevercong 已提交
921 922
| callback | AsyncCallback\<void\>                   | 是   | 回调函数。                                                   |

Y
Yangys 已提交
923 924 925 926 927 928 929
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
930 931
**示例:**

Z
zengyawen 已提交
932
```js
C
clevercong 已提交
933
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
934
tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 }, () => {
Y
Yangys 已提交
935 936 937 938 939 940 941 942 943 944 945
  console.log('connect success');
  tcp.send({
    data: 'Hello, server!'
    //此处省略encoding, 默认为utf-8编码格式
  }, err => {
    if (err) {
      console.log('send fail');
      return;
    }
    console.log('send success');
  })
Y
Yangys 已提交
946
})
C
clevercong 已提交
947
```
C
clevercong 已提交
948

X
xujie 已提交
949
### send<sup>7+</sup>
C
clevercong 已提交
950

Y
Yangys 已提交
951
send(options: TCPSendOptions): Promise\<void\>
C
clevercong 已提交
952 953 954

通过TCPSocket连接发送数据。使用Promise方式作为异步方法。

Y
Yangys 已提交
955 956
> **说明:**
> connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
957 958

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
959

C
clevercong 已提交
960
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
961

C
clevercong 已提交
962 963 964 965
**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
966
| options | [TCPSendOptions](#tcpsendoptions) | 是   | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 |
C
clevercong 已提交
967 968 969 970 971 972 973

**返回值:**

| 类型            | 说明                                               |
| :-------------- | :------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回通过TCPSocket连接发送数据的结果。 |

Y
Yangys 已提交
974 975 976 977 978 979 980
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
981 982
**示例:**

Z
zengyawen 已提交
983
```js
C
clevercong 已提交
984
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
985
let promise1 = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 });
C
clevercong 已提交
986
promise1.then(() => {
Y
Yangys 已提交
987 988 989 990 991 992 993 994 995
  console.log('connect success');
  let promise2 = tcp.send({
    data: 'Hello, server!'
  });
  promise2.then(() => {
    console.log('send success');
  }).catch(err => {
    console.log('send fail');
  });
C
clevercong 已提交
996
}).catch(err => {
Y
Yangys 已提交
997
  console.log('connect fail');
C
clevercong 已提交
998 999
});
```
C
clevercong 已提交
1000

X
xujie 已提交
1001
### close<sup>7+</sup>
C
clevercong 已提交
1002

Y
Yangys 已提交
1003
close(callback: AsyncCallback\<void\>): void
C
clevercong 已提交
1004 1005 1006

关闭TCPSocket连接。使用callback方式作为异步方法。

C
clevercong 已提交
1007 1008
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
1009
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1010

C
clevercong 已提交
1011
**参数:**
C
clevercong 已提交
1012

C
clevercong 已提交
1013 1014 1015
| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |
C
clevercong 已提交
1016

Y
Yangys 已提交
1017 1018 1019 1020 1021
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |
C
clevercong 已提交
1022

C
clevercong 已提交
1023
**示例:**
C
clevercong 已提交
1024

Z
zengyawen 已提交
1025
```js
C
clevercong 已提交
1026 1027
let tcp = socket.constructTCPSocketInstance();
tcp.close(err => {
Y
Yangys 已提交
1028 1029 1030 1031 1032
  if (err) {
    console.log('close fail');
    return;
  }
  console.log('close success');
C
clevercong 已提交
1033 1034
})
```
C
clevercong 已提交
1035

X
xujie 已提交
1036
### close<sup>7+</sup>
C
clevercong 已提交
1037

Y
Yangys 已提交
1038
close(): Promise\<void\>
C
clevercong 已提交
1039 1040 1041

关闭TCPSocket连接。使用Promise方式作为异步方法。

C
clevercong 已提交
1042 1043
**需要权限**:ohos.permission.INTERNET

C
clevercong 已提交
1044
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1045

C
clevercong 已提交
1046
**返回值:**
C
clevercong 已提交
1047

C
clevercong 已提交
1048 1049 1050
| 类型            | 说明                                       |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭TCPSocket连接的结果。 |
C
clevercong 已提交
1051

Y
Yangys 已提交
1052 1053 1054 1055 1056 1057
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |

C
clevercong 已提交
1058
**示例:**
C
clevercong 已提交
1059

Z
zengyawen 已提交
1060
```js
C
clevercong 已提交
1061 1062 1063
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.close();
promise.then(() => {
Y
Yangys 已提交
1064
  console.log('close success');
C
clevercong 已提交
1065
}).catch(err => {
Y
Yangys 已提交
1066
  console.log('close fail');
C
clevercong 已提交
1067 1068
});
```
C
clevercong 已提交
1069

X
xujie 已提交
1070
### getRemoteAddress<sup>7+</sup>
C
clevercong 已提交
1071

Y
Yangys 已提交
1072
getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
C
clevercong 已提交
1073 1074 1075

获取对端Socket地址。使用callback方式作为异步方法。

Y
Yangys 已提交
1076 1077
> **说明:**
> connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
1078 1079

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
1080

C
clevercong 已提交
1081
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1082

C
clevercong 已提交
1083
**参数:**
C
clevercong 已提交
1084

C
clevercong 已提交
1085 1086
| 参数名   | 类型                                              | 必填 | 说明       |
| -------- | ------------------------------------------------- | ---- | ---------- |
C
clevercong 已提交
1087
| callback | AsyncCallback<[NetAddress](#netaddress)> | 是   | 回调函数。 |
C
clevercong 已提交
1088

Y
Yangys 已提交
1089 1090 1091 1092 1093 1094
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |

C
clevercong 已提交
1095
**示例:**
C
clevercong 已提交
1096

Z
zengyawen 已提交
1097
```js
C
clevercong 已提交
1098
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1099
tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 }, () => {
Y
Yangys 已提交
1100 1101 1102 1103 1104 1105 1106 1107
  console.log('connect success');
  tcp.getRemoteAddress((err, data) => {
    if (err) {
      console.log('getRemoteAddressfail');
      return;
    }
    console.log('getRemoteAddresssuccess:' + JSON.stringify(data));
  })
C
clevercong 已提交
1108 1109
});
```
C
clevercong 已提交
1110

X
xujie 已提交
1111
### getRemoteAddress<sup>7+</sup>
C
clevercong 已提交
1112

Y
Yangys 已提交
1113
getRemoteAddress(): Promise\<NetAddress\>
C
clevercong 已提交
1114 1115 1116

获取对端Socket地址。使用Promise方式作为异步方法。

Y
Yangys 已提交
1117 1118
> **说明:**
> connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
1119 1120

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
1121

C
clevercong 已提交
1122
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1123

C
clevercong 已提交
1124
**返回值:**
C
clevercong 已提交
1125

C
clevercong 已提交
1126 1127
| 类型                                        | 说明                                        |
| :------------------------------------------ | :------------------------------------------ |
C
clevercong 已提交
1128
| Promise<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。 |
C
clevercong 已提交
1129

Y
Yangys 已提交
1130 1131 1132 1133 1134 1135
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |

C
clevercong 已提交
1136
**示例:**
C
clevercong 已提交
1137

Z
zengyawen 已提交
1138
```js
C
clevercong 已提交
1139
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1140
let promise1 = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 });
C
clevercong 已提交
1141
promise1.then(() => {
Y
Yangys 已提交
1142 1143 1144 1145 1146 1147 1148
  console.log('connect success');
  let promise2 = tcp.getRemoteAddress();
  promise2.then(() => {
    console.log('getRemoteAddress success');
  }).catch(err => {
    console.log('getRemoteAddressfail');
  });
C
clevercong 已提交
1149
}).catch(err => {
Y
Yangys 已提交
1150
  console.log('connect fail');
C
clevercong 已提交
1151 1152
});
```
C
clevercong 已提交
1153

X
xujie 已提交
1154
### getState<sup>7+</sup>
C
clevercong 已提交
1155

Y
Yangys 已提交
1156
getState(callback: AsyncCallback\<SocketStateBase\>): void
C
clevercong 已提交
1157 1158 1159

获取TCPSocket状态。使用callback方式作为异步方法。

Y
Yangys 已提交
1160 1161
> **说明:**
> bind或connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
1162 1163

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
1164

C
clevercong 已提交
1165
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1166

C
clevercong 已提交
1167
**参数:**
C
clevercong 已提交
1168

C
clevercong 已提交
1169 1170
| 参数名   | 类型                                                   | 必填 | 说明       |
| -------- | ------------------------------------------------------ | ---- | ---------- |
C
clevercong 已提交
1171
| callback | AsyncCallback<[SocketStateBase](#socketstatebase)> | 是   | 回调函数。 |
C
clevercong 已提交
1172

Y
Yangys 已提交
1173 1174 1175 1176 1177
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |
C
clevercong 已提交
1178

C
clevercong 已提交
1179
**示例:**
C
clevercong 已提交
1180

Z
zengyawen 已提交
1181
```js
C
clevercong 已提交
1182
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1183
let promise = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 }, () => {
Y
Yangys 已提交
1184 1185 1186 1187 1188 1189 1190 1191
  console.log('connect success');
  tcp.getState((err, data) => {
    if (err) {
      console.log('getState fail');
      return;
    }
    console.log('getState success:' + JSON.stringify(data));
  });
C
clevercong 已提交
1192 1193
});
```
C
clevercong 已提交
1194

X
xujie 已提交
1195
### getState<sup>7+</sup>
C
clevercong 已提交
1196

Y
Yangys 已提交
1197
getState(): Promise\<SocketStateBase\>
C
clevercong 已提交
1198 1199 1200

获取TCPSocket状态。使用Promise方式作为异步方法。

Y
Yangys 已提交
1201 1202
> **说明:**
> bind或connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
1203 1204

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
1205

C
clevercong 已提交
1206
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1207

C
clevercong 已提交
1208
**返回值:**
C
clevercong 已提交
1209

C
clevercong 已提交
1210 1211
| 类型                                             | 说明                                       |
| :----------------------------------------------- | :----------------------------------------- |
C
clevercong 已提交
1212
| Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TCPSocket状态的结果。 |
C
clevercong 已提交
1213

Y
Yangys 已提交
1214 1215 1216 1217 1218
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 201     | Permission denied.      |
C
clevercong 已提交
1219

C
clevercong 已提交
1220
**示例:**
C
clevercong 已提交
1221

Z
zengyawen 已提交
1222
```js
C
clevercong 已提交
1223
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1224
let promise = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 });
C
clevercong 已提交
1225
promise.then(() => {
Y
Yangys 已提交
1226 1227 1228 1229 1230 1231 1232
  console.log('connect success');
  let promise1 = tcp.getState();
  promise1.then(() => {
    console.log('getState success');
  }).catch(err => {
    console.log('getState fail');
  });
C
clevercong 已提交
1233
}).catch(err => {
Y
Yangys 已提交
1234
  console.log('connect fail');
C
clevercong 已提交
1235 1236
});
```
C
clevercong 已提交
1237

X
xujie 已提交
1238
### setExtraOptions<sup>7+</sup>
C
clevercong 已提交
1239

Y
Yangys 已提交
1240
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
1241 1242 1243

设置TCPSocket连接的其他属性。使用callback方式作为异步方法。

Y
Yangys 已提交
1244 1245
> **说明:**
> bind或connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
1246 1247

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
1248

C
clevercong 已提交
1249
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1250

C
clevercong 已提交
1251 1252 1253 1254
**参数:**

| 参数名   | 类型                                      | 必填 | 说明                                                         |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
1255
| options  | [TCPExtraOptions](#tcpextraoptions) | 是   | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
C
clevercong 已提交
1256 1257
| callback | AsyncCallback\<void\>                     | 是   | 回调函数。                                                   |

Y
Yangys 已提交
1258 1259 1260 1261 1262 1263 1264
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |

C
clevercong 已提交
1265 1266
**示例:**

Z
zengyawen 已提交
1267
```js
C
clevercong 已提交
1268
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1269
let promise = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 }, () => {
Y
Yangys 已提交
1270 1271 1272 1273 1274
  console.log('connect success');
  tcp.setExtraOptions({
    keepAlive: true,
    OOBInline: true,
    TCPNoDelay: true,
Y
Yangys 已提交
1275
    socketLinger: { on: true, linger: 10 },
Y
Yangys 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: true,
    socketTimeout: 3000,
  }, err => {
    if (err) {
      console.log('setExtraOptions fail');
      return;
    }
    console.log('setExtraOptions success');
  });
C
clevercong 已提交
1287 1288
});
```
C
clevercong 已提交
1289

X
xujie 已提交
1290
### setExtraOptions<sup>7+</sup>
C
clevercong 已提交
1291

Y
Yangys 已提交
1292
setExtraOptions(options: TCPExtraOptions): Promise\<void\>
C
clevercong 已提交
1293 1294 1295

设置TCPSocket连接的其他属性,使用Promise方式作为异步方法。

Y
Yangys 已提交
1296 1297
> **说明:**
> bind或connect方法调用成功后,才可调用此方法。
C
clevercong 已提交
1298 1299

**需要权限**:ohos.permission.INTERNET
C
clevercong 已提交
1300

C
clevercong 已提交
1301
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1302

C
clevercong 已提交
1303 1304 1305 1306
**参数:**

| 参数名  | 类型                                      | 必填 | 说明                                                         |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
1307
| options | [TCPExtraOptions](#tcpextraoptions) | 是   | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
C
clevercong 已提交
1308 1309 1310 1311 1312 1313 1314

**返回值:**

| 类型            | 说明                                                 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 |

Y
Yangys 已提交
1315 1316 1317 1318 1319 1320
**错误码:**

| 错误码ID | 错误信息                 |
| ------- | ----------------------- |
| 401     | Parameter error.        |
| 201     | Permission denied.      |
C
clevercong 已提交
1321 1322 1323

**示例:**

Z
zengyawen 已提交
1324
```js
C
clevercong 已提交
1325
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1326
let promise = tcp.connect({ address: { address: '192.168.xx.xxx', port: xxxx, family: 1 }, timeout: 6000 });
C
clevercong 已提交
1327
promise.then(() => {
Y
Yangys 已提交
1328 1329 1330 1331 1332
  console.log('connect success');
  let promise1 = tcp.setExtraOptions({
    keepAlive: true,
    OOBInline: true,
    TCPNoDelay: true,
Y
Yangys 已提交
1333
    socketLinger: { on: true, linger: 10 },
Y
Yangys 已提交
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
    receiveBufferSize: 1000,
    sendBufferSize: 1000,
    reuseAddress: true,
    socketTimeout: 3000,
  });
  promise1.then(() => {
    console.log('setExtraOptions success');
  }).catch(err => {
    console.log('setExtraOptions fail');
  });
C
clevercong 已提交
1344
}).catch(err => {
Y
Yangys 已提交
1345
  console.log('connect fail');
C
clevercong 已提交
1346 1347
});
```
C
clevercong 已提交
1348

X
xujie 已提交
1349
### on('message')<sup>7+</sup>
C
clevercong 已提交
1350

Y
Yangys 已提交
1351
on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
C
clevercong 已提交
1352 1353 1354

订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。

C
clevercong 已提交
1355
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1356

C
clevercong 已提交
1357
**参数:**
C
clevercong 已提交
1358

C
clevercong 已提交
1359 1360 1361
| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
C
clevercong 已提交
1362
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 是   | 回调函数。                                |
C
clevercong 已提交
1363

C
clevercong 已提交
1364
**示例:**
C
clevercong 已提交
1365

Z
zengyawen 已提交
1366
```js
C
clevercong 已提交
1367
let tcp = socket.constructTCPSocketInstance();
X
xujie 已提交
1368
let messageView = '';
C
clevercong 已提交
1369
tcp.on('message', value => {
Y
Yangys 已提交
1370 1371 1372
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
X
xujie 已提交
1373
    messageView += message;
Y
Yangys 已提交
1374 1375 1376
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
C
clevercong 已提交
1377 1378
});
```
C
clevercong 已提交
1379

X
xujie 已提交
1380
### off('message')<sup>7+</sup>
C
clevercong 已提交
1381

Y
Yangys 已提交
1382
off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
C
clevercong 已提交
1383 1384 1385

取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。

Y
Yangys 已提交
1386 1387
> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
C
clevercong 已提交
1388

C
clevercong 已提交
1389
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1390

C
clevercong 已提交
1391
**参数:**
C
clevercong 已提交
1392

C
clevercong 已提交
1393 1394 1395
| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
C
clevercong 已提交
1396
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否   | 回调函数。                                |
C
clevercong 已提交
1397

C
clevercong 已提交
1398
**示例:**
C
clevercong 已提交
1399

Z
zengyawen 已提交
1400
```js
C
clevercong 已提交
1401
let tcp = socket.constructTCPSocketInstance();
X
xujie 已提交
1402
let messageView = '';
Y
Yangys 已提交
1403
let callback = value => {
Y
Yangys 已提交
1404 1405 1406
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
X
xujie 已提交
1407
    messageView += message;
Y
Yangys 已提交
1408 1409 1410
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
C
clevercong 已提交
1411 1412 1413 1414 1415 1416
}
tcp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('message', callback);
tcp.off('message');
```
C
clevercong 已提交
1417

X
xujie 已提交
1418
### on('connect' | 'close')<sup>7+</sup>
C
clevercong 已提交
1419

Y
Yangys 已提交
1420
on(type: 'connect' | 'close', callback: Callback\<void\>): void
C
clevercong 已提交
1421 1422 1423

订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。

C
clevercong 已提交
1424
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1425

C
clevercong 已提交
1426
**参数:**
C
clevercong 已提交
1427

C
clevercong 已提交
1428 1429 1430 1431
| 参数名   | 类型             | 必填 | 说明                                                         |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type     | string           | 是   | 订阅的事件类型。<br />- 'connect':连接事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 是   | 回调函数。                                                   |
C
clevercong 已提交
1432

C
clevercong 已提交
1433
**示例:**
C
clevercong 已提交
1434

Z
zengyawen 已提交
1435
```js
C
clevercong 已提交
1436 1437
let tcp = socket.constructTCPSocketInstance();
tcp.on('connect', () => {
Y
Yangys 已提交
1438
  console.log("on connect success")
C
clevercong 已提交
1439
});
Y
Yangys 已提交
1440
tcp.on('close', () => {
Y
Yangys 已提交
1441
  console.log("on close success")
C
clevercong 已提交
1442 1443
});
```
C
clevercong 已提交
1444

X
xujie 已提交
1445
### off('connect' | 'close')<sup>7+</sup>
C
clevercong 已提交
1446

Y
Yangys 已提交
1447
off(type: 'connect' | 'close', callback?: Callback\<void\>): void
C
clevercong 已提交
1448 1449 1450

取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。

Y
Yangys 已提交
1451 1452
> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
C
clevercong 已提交
1453

C
clevercong 已提交
1454
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1455

C
clevercong 已提交
1456 1457 1458 1459 1460 1461 1462 1463 1464
**参数:**

| 参数名   | 类型             | 必填 | 说明                                                         |
| -------- | ---------------- | ---- | ------------------------------------------------------------ |
| type     | string           | 是   | 订阅的事件类型。<br />- 'connect':连接事件。<br />- 'close':关闭事件。 |
| callback | Callback\<void\> | 否   | 回调函数。                                                   |

**示例:**

Z
zengyawen 已提交
1465
```js
C
clevercong 已提交
1466
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1467
let callback1 = () => {
Y
Yangys 已提交
1468
  console.log("on connect success");
C
clevercong 已提交
1469 1470 1471 1472 1473
}
tcp.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('connect', callback1);
tcp.off('connect');
Y
Yangys 已提交
1474
let callback2 = () => {
Y
Yangys 已提交
1475
  console.log("on close success");
C
clevercong 已提交
1476 1477 1478 1479 1480 1481
}
tcp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('close', callback2);
tcp.off('close');
```
C
clevercong 已提交
1482

X
xujie 已提交
1483
### on('error')<sup>7+</sup>
C
clevercong 已提交
1484

Y
Yangys 已提交
1485
on(type: 'error', callback: ErrorCallback): void
C
clevercong 已提交
1486 1487 1488

订阅TCPSocket连接的error事件。使用callback方式作为异步方法。

C
clevercong 已提交
1489
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1490

C
clevercong 已提交
1491
**参数:**
C
clevercong 已提交
1492

C
clevercong 已提交
1493 1494 1495 1496
| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |
C
clevercong 已提交
1497

C
clevercong 已提交
1498
**示例:**
C
clevercong 已提交
1499

Z
zengyawen 已提交
1500
```js
C
clevercong 已提交
1501 1502
let tcp = socket.constructTCPSocketInstance();
tcp.on('error', err => {
Y
Yangys 已提交
1503
  console.log("on error, err:" + JSON.stringify(err))
C
clevercong 已提交
1504 1505
});
```
C
clevercong 已提交
1506

X
xujie 已提交
1507
### off('error')<sup>7+</sup>
C
clevercong 已提交
1508

Y
Yangys 已提交
1509
off(type: 'error', callback?: ErrorCallback): void
C
clevercong 已提交
1510 1511 1512

取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。

Y
Yangys 已提交
1513 1514
> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
C
clevercong 已提交
1515

C
clevercong 已提交
1516
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1517

C
clevercong 已提交
1518 1519 1520 1521 1522 1523 1524 1525 1526
**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |

**示例:**

Z
zengyawen 已提交
1527
```js
C
clevercong 已提交
1528
let tcp = socket.constructTCPSocketInstance();
Y
Yangys 已提交
1529
let callback = err => {
Y
Yangys 已提交
1530
  console.log("on error, err:" + JSON.stringify(err));
C
clevercong 已提交
1531 1532 1533 1534 1535 1536
}
tcp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('error', callback);
tcp.off('error');
```
C
clevercong 已提交
1537

X
xujie 已提交
1538
## TCPConnectOptions<sup>7+</sup>
C
clevercong 已提交
1539 1540 1541

TCPSocket连接的参数。

Z
zengyawen 已提交
1542
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1543

L
liyufan 已提交
1544
| 名称  | 类型                               | 必填 | 说明                       |
C
clevercong 已提交
1545
| ------- | ---------------------------------- | ---- | -------------------------- |
C
clevercong 已提交
1546
| address | [NetAddress](#netaddress) | 是   | 绑定的地址以及端口。       |
C
clevercong 已提交
1547 1548
| timeout | number                             | 否   | 超时时间,单位毫秒(ms)。 |

X
xujie 已提交
1549
## TCPSendOptions<sup>7+</sup>
C
clevercong 已提交
1550 1551 1552

TCPSocket发送请求的参数。

Z
zengyawen 已提交
1553
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1554

L
liyufan 已提交
1555
| 名称   | 类型   | 必填 | 说明                                                         |
C
clevercong 已提交
1556
| -------- | ------ | ---- | ------------------------------------------------------------ |
Z
zhuwenchao 已提交
1557
| data     | string\| ArrayBuffer<sup>7+</sup>  | 是   | 发送的数据。                                                 |
C
clevercong 已提交
1558 1559
| encoding | string | 否   | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |

X
xujie 已提交
1560
## TCPExtraOptions<sup>7+</sup>
C
clevercong 已提交
1561 1562 1563

TCPSocket连接的其他属性。

Z
zengyawen 已提交
1564
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1565

L
liyufan 已提交
1566
| 名称            | 类型    | 必填 | 说明                                                         |
C
clevercong 已提交
1567 1568 1569 1570 1571
| ----------------- | ------- | ---- | ------------------------------------------------------------ |
| keepAlive         | boolean | 否   | 是否保持连接。默认为false。                                  |
| OOBInline         | boolean | 否   | 是否为OOB内联。默认为false。                                 |
| TCPNoDelay        | boolean | 否   | TCPSocket连接是否无时延。默认为false。                       |
| socketLinger      | Object  | 是   | socket是否继续逗留。<br />- on:是否逗留(true:逗留;false:不逗留)。<br />- linger:逗留时长,单位毫秒(ms),取值范围为0~65535。<br />当入参on设置为true时,才需要设置。 |
X
xujie 已提交
1572 1573
| receiveBufferSize | number  | 否   | 接收缓冲区大小(单位:Byte),默认为0。                               |
| sendBufferSize    | number  | 否   | 发送缓冲区大小(单位:Byte),默认为0。                               |
C
clevercong 已提交
1574
| reuseAddress      | boolean | 否   | 是否重用地址。默认为false。                                  |
X
xujie 已提交
1575
| socketTimeout     | number  | 否   | 套接字超时时间,单位毫秒(ms),默认为0。                             |
L
liyufan 已提交
1576

X
xujie 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
## socket.constructTCPSocketServerInstance<sup>10+</sup>

constructTCPSocketServerInstance(): TCPSocketServer

创建一个TCPSocketServer对象。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                | 说明                          |
| :---------------------------------- | :---------------------------- |
X
xujie 已提交
1589
| [TCPSocketServer](#tcpsocketserver10) | 返回一个TCPSocketServer对象。 |
X
xujie 已提交
1590 1591 1592 1593 1594 1595 1596 1597 1598

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
```

## TCPSocketServer<sup>10+</sup>

X
xujie 已提交
1599
TCPSocketServer连接。在调用TCPSocketServer的方法前,需要先通过[socket.constructTCPSocketServerInstance](#socketconstructtcpsocketserverinstance10)创建TCPSocketServer对象。
X
xujie 已提交
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617

### listen<sup>10+</sup>

listen(address: NetAddress, callback: AsyncCallback\<void\>): void

绑定IP地址和端口,端口可以指定或由系统随机分配。监听并接受与此套接字建立的TCPSocket连接。该接口使用多线程并发处理客户端的数据。使用callback方法作为异步方法。

> **说明:**
> 服务端使用该方法完成bind,listen,accept操作。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                      | 必填 | 说明                                          |
| -------- | ------------------------- | ---- | --------------------------------------------- |
X
xujie 已提交
1618
| address  | [NetAddress](#netaddress7) | 是   | 目标地址信息。 |
X
xujie 已提交
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
| callback | AsyncCallback\<void\>     | 是   | 回调函数。                                    |

**错误码:**

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| 401      | Parameter error.                            |
| 201      | Permission denied.                          |
| 2300002  | System internal error.                      |
| 2303109  | Bad file number.                            |
| 2303111  | Resource temporarily unavailable try again. |
| 2303198  | Address already in use.                     |
| 2303199  | Cannot assign requested address.            |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.listen({ address: "192.168.xx.xxx", port: xxxx, family: 1 }, err => {
  if (err) {
    console.log("listen fail");
    return;
  }
  console.log("listen success");
})
```

### listen<sup>10+</sup>

listen(address: NetAddress): Promise\<void\>

绑定IP地址和端口,端口可以指定或由系统随机分配。监听并接受与此套接字建立的TCPSocket连接。该接口使用多线程并发处理客户端的数据。使用Promise方法作为异步方法。

> **说明:**
> 服务端使用该方法完成bind,listen,accept操作。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                      | 必填 | 说明                                          |
| ------- | ------------------------- | ---- | --------------------------------------------- |
X
xujie 已提交
1663
| address | [NetAddress](#netaddress7) | 是   | 目标地址信息。 |
X
xujie 已提交
1664 1665 1666 1667 1668

**返回值:**

| 类型            | 说明                                                         |
| :-------------- | :----------------------------------------------------------- |
X
xujie 已提交
1669
| Promise\<void\> | 以Promise形式返回, 成功返回空,失败返回错误码错误信息。|
X
xujie 已提交
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711

**错误码:**

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| 401      | Parameter error.                            |
| 201      | Permission denied.                          |
| 2300002  | System internal error.                      |
| 2303109  | Bad file number.                            |
| 2303111  | Resource temporarily unavailable try again. |
| 2303198  | Address already in use.                     |
| 2303199  | Cannot assign requested address.            |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
let promise = tcpServer.listen({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
promise.then(() => {
  console.log('listen success');
}).catch(err => {
  console.log('listen fail');
});
```

### getState<sup>10+</sup>

getState(callback: AsyncCallback\<SocketStateBase\>): void

获取TCPSocketServer状态。使用callback方式作为异步方法。

> **说明:**
> listen方法调用成功后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                               | 必填 | 说明       |
| -------- | -------------------------------------------------- | ---- | ---------- |
X
xujie 已提交
1712
| callback | AsyncCallback<[SocketStateBase](#socketstatebase7)> | 是   | 回调函数。 |
X
xujie 已提交
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 201      | Permission denied.              |
| 2300002  | System internal error.          |
| 2303188  | Socket operation on non-socket. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.listen({ address: "192.168.xx.xxx", port: xxxx, family: 1 }, err => {
  if (err) {
    console.log("listen fail");
    return;
  }
  console.log("listen success");
})
tcpServer.getState((err, data) => {
  if (err) {
    console.log('getState fail');
    return;
  }
  console.log('getState success:' + JSON.stringify(data));
})
```

### getState<sup>10+</sup>

getState(): Promise\<SocketStateBase\>

获取TCPSocketServer状态。使用Promise方式作为异步方法。

> **说明:**
> listen方法调用成功后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                         | 说明                                       |
| :------------------------------------------- | :----------------------------------------- |
X
xujie 已提交
1760
| Promise<[SocketStateBase](#socketstatebase7)> | 以Promise形式返回获取TCPSocket状态的结果。 |
X
xujie 已提交
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 201      | Permission denied.              |
| 2300002  | System internal error.          |
| 2303188  | Socket operation on non-socket. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
let promiseListen = tcpServer.listen({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
promiseListen.then(() => {
  console.log('listen success');
}).catch(err => {
  console.log('listen fail');
});
let promise = tcpServer.getState();
promise.then(() => {
  console.log('getState success');
}).catch(err => {
  console.log('getState fail');
});
```

### setExtraOptions<sup>10+</sup>

setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void

设置TCPSocketServer连接的其他属性。使用callback方式作为异步方法。

> **说明:**
> listen方法调用成功后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                | 必填 | 说明                                                         |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
X
xujie 已提交
1805
| options  | [TCPExtraOptions](#tcpextraoptions7) | 是   | TCPSocketServer连接的其他属性。 |
X
xujie 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
| callback | AsyncCallback\<void\>               | 是   | 回调函数。                                                   |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 201      | Permission denied.              |
| 2300002  | System internal error.          |
| 2303188  | Socket operation on non-socket. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.listen({ address: "192.168.xx.xxx", port: xxxx, family: 1 }, err => {
  if (err) {
    console.log("listen fail");
    return;
  }
  console.log("listen success");
})
tcpServer.setExtraOptions({
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
}, err => {
  if (err) {
    console.log('setExtraOptions fail');
    return;
  }
  console.log('setExtraOptions success');
});
```

### setExtraOptions<sup>10+</sup>

setExtraOptions(options: TCPExtraOptions): Promise\<void\>

设置TCPSocketServer连接的其他属性,使用Promise方式作为异步方法。

> **说明:**
> listen方法调用成功后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                                | 必填 | 说明                                                         |
| ------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
X
xujie 已提交
1863
| options | [TCPExtraOptions](#tcpextraoptions7) | 是   | TCPSocketServer连接的其他属性。 |
X
xujie 已提交
1864 1865 1866 1867 1868

**返回值:**

| 类型            | 说明                                                       |
| :-------------- | :--------------------------------------------------------- |
X
xujie 已提交
1869
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
X
xujie 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 201      | Permission denied.              |
| 2300002  | System internal error.          |
| 2303188  | Socket operation on non-socket. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
let promiseListen = tcpServer.listen({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
promiseListen.then(() => {
  console.log('listen success');
}).catch(err => {
  console.log('listen fail');
});
let promise = tcpServer.setExtraOptions({
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
});
promise.then(() => {
  console.log('setExtraOptions success');
}).catch(err => {
  console.log('setExtraOptions fail');
});
```

### on('connect')<sup>10+</sup>

on(type: 'connect', callback: Callback\<TCPSocketConnection\>): void

订阅TCPSocketServer的连接事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                            | 必填 | 说明                                  |
| -------- | ------------------------------- | ---- | ------------------------------------- |
| type     | string                          | 是   | 订阅的事件类型。'connect':连接事件。 |
X
xujie 已提交
1920
| callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 是   | 回调函数。                            |
X
xujie 已提交
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(data) {
  console.log(JSON.stringify(data))
});
```

### off('connect')<sup>10+</sup>

off(type: 'connect', callback?: Callback\<TCPSocketConnection\>): void

取消订阅TCPSocketServer的连接事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                            | 必填 | 说明                                  |
| -------- | ------------------------------- | ---- | ------------------------------------- |
| type     | string                          | 是   | 订阅的事件类型。'connect':连接事件。 |
X
xujie 已提交
1953
| callback | Callback<[TCPSocketConnection](#tcpsocketconnection10)> | 否   | 回调函数。                            |
X
xujie 已提交
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
let callback = data => {
  console.log('on connect message: ' + JSON.stringify(data));
}
tcpServer.on('connect', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcpServer.off('connect', callback);
tcpServer.off('connect');
```

### on('error')<sup>10+</sup>

on(type: 'error', callback: ErrorCallback): void

订阅TCPSocketServer连接的error事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('error', err => {
  console.log("on error, err:" + JSON.stringify(err))
});
```

### off('error')<sup>10+</sup>

off(type: 'error', callback?: ErrorCallback): void

取消订阅TCPSocketServer连接的error事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
let callback = err => {
  console.log("on error, err:" + JSON.stringify(err));
}
tcpServer.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcpServer.off('error', callback);
tcpServer.off('error');
```

## TCPSocketConnection<sup>10+</sup>

TCPSocketConnection连接,即TCPSocket客户端与服务端的连接。在调用TCPSocketConnection的方法前,需要先获取TCPSocketConnection对象。

X
xujie 已提交
2045 2046 2047
> **说明:**
> 客户端与服务端成功建立连接后,才能通过返回的TCPSocketConnection对象调用相应的接口。

X
xujie 已提交
2048 2049 2050 2051 2052 2053
**系统能力**:SystemCapability.Communication.NetStack

### 属性

| 名称     | 类型   | 必填 | 说明                                      |
| -------- | ------ | ---- | ----------------------------------------- |
X
xujie 已提交
2054
| clientId | number | 是   | 客户端与TCPSocketServer建立连接的id。 |
X
xujie 已提交
2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072

### send<sup>10+</sup>

send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void

通过TCPSocketConnection连接发送数据。使用callback方式作为异步方法。

> **说明:**
> 与客户端建立连接后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                              | 必填 | 说明                                                         |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
X
xujie 已提交
2073
| options  | [TCPSendOptions](#tcpsendoptions7) | 是   | TCPSocketConnection发送请求的参数。 |
X
xujie 已提交
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
| callback | AsyncCallback\<void\>             | 是   | 回调函数。                                                   |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 401      | Parameter error.       |
| 201      | Permission denied.     |
| 2300002  | System internal error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.send({data: 'Hello, client!'}, err => {
    if (err) {
        console.log('send fail');
        return;
    }
    console.log('send success');
  });
});
```

### send<sup>10+</sup>

send(options: TCPSendOptions): Promise\<void\>

通过TCPSocketConnection连接发送数据。使用Promise方式作为异步方法。

> **说明:**
> 与客户端建立连接后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                              | 必填 | 说明                                                         |
| ------- | --------------------------------- | ---- | ------------------------------------------------------------ |
X
xujie 已提交
2116
| options | [TCPSendOptions](#tcpsendoptions7) | 是   | TCPSocketConnection发送请求的参数。 |
X
xujie 已提交
2117 2118 2119 2120 2121

**返回值:**

| 类型            | 说明                                                         |
| :-------------- | :----------------------------------------------------------- |
X
xujie 已提交
2122
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
X
xujie 已提交
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 401      | Parameter error.       |
| 201      | Permission denied.     |
| 2300002  | System internal error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  let promise = client.send({data: 'Hello, client!'});
  promise.then(() => {
    console.log('send success');
  }).catch(err => {
    console.log('send fail');
  });
});
```

### close<sup>10+</sup>

close(callback: AsyncCallback\<void\>): void

关闭一个与TCPSocket建立的连接。使用callback方式作为异步方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 401      | Parameter error.       |
| 201      | Permission denied.     |
| 2300002  | System internal error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.close(err => {
    if (err) {
      console.log('close fail');
      return;
    }
    console.log('close success');
  });
});
```

### close<sup>10+</sup>

close(): Promise\<void\>

关闭一个与TCPSocket建立的连接。使用Promise方式作为异步方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型            | 说明                                         |
| :-------------- | :------------------------------------------- |
X
xujie 已提交
2199
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码错误信息。 |
X
xujie 已提交
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 201      | Permission denied.     |
| 2300002  | System internal error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  let promise = client.close();
  promise.then(() => {
  	console.log('close success');
  }).catch(err => {
  	console.log('close fail');
  });
});
```

### getRemoteAddress<sup>10+</sup>

getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void

获取对端Socket地址。使用callback方式作为异步方法。

> **说明:**
> 与客户端建立连接后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                     | 必填 | 说明       |
| -------- | ---------------------------------------- | ---- | ---------- |
X
xujie 已提交
2239
| callback | AsyncCallback<[NetAddress](#netaddress7)> | 是   | 回调函数。 |
X
xujie 已提交
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 201      | Permission denied.              |
| 2300002  | System internal error.          |
| 2303188  | Socket operation on non-socket. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.getRemoteAddress((err, data) => {
    if (err) {
      console.log('getRemoteAddress fail');
      return;
    }
    console.log('getRemoteAddress success:' + JSON.stringify(data));
  });
});
```

### getRemoteAddress<sup>10+</sup>

getRemoteAddress(): Promise\<NetAddress\>

获取对端Socket地址。使用Promise方式作为异步方法。

> **说明:**
> 与客户端建立连接后,才可调用此方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                               | 说明                                        |
| :--------------------------------- | :------------------------------------------ |
X
xujie 已提交
2282
| Promise<[NetAddress](#netaddress7)> | 以Promise形式返回获取对端socket地址的结果。 |
X
xujie 已提交
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 201      | Permission denied.              |
| 2300002  | System internal error.          |
| 2303188  | Socket operation on non-socket. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  let promise = client.getRemoteAddress();
  promise.then(() => {
    console.log('getRemoteAddress success');
  }).catch(err => {
    console.log('getRemoteAddress fail');
  });
});
```

### on('message')<sup>10+</sup>

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void

订阅TCPSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
X
xujie 已提交
2319
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 是   | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。                                |
X
xujie 已提交
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.on('message', value => {
    let messageView = '';
    for (var i = 0; i < value.message.length; i++) {
      let messages = value.message[i];
      let message = String.fromCharCode(messages);
X
xujie 已提交
2337
      messageView += message;
X
xujie 已提交
2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
    }
    console.log('on message message: ' + JSON.stringify(messageView));
    console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
  });
});
```

### off('message')<sup>10+</sup>

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void

取消订阅TCPSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
X
xujie 已提交
2361
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 否   | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。                                |
X
xujie 已提交
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let callback = value => {
  let messageView = '';
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i];
    let message = String.fromCharCode(messages);
X
xujie 已提交
2377
    messageView += message;
X
xujie 已提交
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.on('message', callback);
  // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
  client.off('message', callback);
  client.off('message');
});
```

### on('close')<sup>10+</sup>

on(type: 'close', callback: Callback\<void\>): void

订阅TCPSocketConnection的关闭事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型             | 必填 | 说明                                |
| -------- | ---------------- | ---- | ----------------------------------- |
| type     | string           | 是   | 订阅的事件类型。'close':关闭事件。 |
X
xujie 已提交
2404
| callback | Callback\<void\> | 是   | 回调函数。                          |
X
xujie 已提交
2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.on('close', () => {
    console.log("on close success")
  });
});
```

### off('close')<sup>10+</sup>

on(type: 'close', callback: Callback\<void\>): void

取消订阅TCPSocketConnection的关闭事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型             | 必填 | 说明                                |
| -------- | ---------------- | ---- | ----------------------------------- |
| type     | string           | 是   | 订阅的事件类型。'close':关闭事件。 |
| callback | Callback\<void\> | 否   | 回调函数。                          |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let callback = () => {
  console.log("on close success");
}
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.on('close', callback);
  // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
  client.off('close', callback);
  client.off('close');
});
```

### on('error')<sup>10+</sup>

on(type: 'error', callback: ErrorCallback): void

订阅TCPSocketConnection连接的error事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.on('error', err => {
    console.log("on error, err:" + JSON.stringify(err))
  });
});
```

### off('error')<sup>10+</sup>

off(type: 'error', callback?: ErrorCallback): void

取消订阅TCPSocketConnection连接的error事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let callback = err => {
  console.log("on error, err:" + JSON.stringify(err));
}
let tcpServer = socket.constructTCPSocketServerInstance();
tcpServer.on('connect', function(client) {
  client.on('error', callback);
  // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
  client.off('error', callback);
  client.off('error');
});
```

Y
Yangys 已提交
2533
## TCP 错误码说明
Y
Yangys 已提交
2534

Y
Yangys 已提交
2535
TCP 其余错误码映射形式为:2301000 + Linux内核错误码。
Y
Yangys 已提交
2536

Y
Yangys 已提交
2537
错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-net-socket.md)
Y
Yangys 已提交
2538

L
liyufan 已提交
2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
## socket.constructTLSSocketInstance<sup>9+</sup>

constructTLSSocketInstance(): TLSSocket

创建并返回一个TLSSocket对象。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                               | 说明                    |
| :--------------------------------- | :---------------------- |
| [TLSSocket](#tlssocket9) | 返回一个TLSSocket对象。 |

**示例:**

```js
let tls = socket.constructTLSSocketInstance();
```

## TLSSocket<sup>9+</sup>

TLSSocket连接。在调用TLSSocket的方法前,需要先通过[socket.constructTLSSocketInstance](#socketconstructtlssocketinstance9)创建TLSSocket对象。

### bind<sup>9+</sup>

Y
Yangys 已提交
2565
bind(address: NetAddress, callback: AsyncCallback\<void\>): void
L
liyufan 已提交
2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582

绑定IP地址和端口。使用callback方法作为异步方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                               | 必填 | 说明                                                   |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address  | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
| callback | AsyncCallback\<void\>              | 是   | 回调函数。成功返回TLSSocket绑定本机的IP地址和端口的结果。 失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                 |
L
liyufan 已提交
2583
| ------- | ----------------------- |
L
liyufan 已提交
2584 2585 2586 2587 2588 2589 2590 2591
| 401     | Parameter error.        |
| 201     | Permission denied.      |
| 2303198 | Address already in use. |
| 2300002 | System internal error.  |

**示例:**

```js
Y
Yangys 已提交
2592
tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
Y
Yangys 已提交
2593 2594 2595 2596 2597
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
2598 2599 2600 2601 2602
});
```

### bind<sup>9+</sup>

Y
Yangys 已提交
2603
bind(address: NetAddress): Promise\<void\>
L
liyufan 已提交
2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614

绑定IP地址和端口。使用Promise方法作为异步方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                               | 必填 | 说明                                                   |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
L
liyufan 已提交
2615
| address | [NetAddress](#netaddress)          | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
L
liyufan 已提交
2616 2617 2618 2619 2620 2621 2622 2623 2624 2625

**返回值:**

| 类型            | 说明                                                     |
| :-------------- | :------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回TLSSocket绑定本机的IP地址和端口的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                 |
L
liyufan 已提交
2626
| ------- | ----------------------- |
L
liyufan 已提交
2627 2628 2629 2630 2631 2632 2633 2634
| 401     | Parameter error.        |
| 201     | Permission denied.      |
| 2303198 | Address already in use. |
| 2300002 | System internal error.  |

**示例:**

```js
Y
Yangys 已提交
2635
let promise = tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
L
liyufan 已提交
2636
promise.then(() => {
Y
Yangys 已提交
2637
  console.log('bind success');
L
liyufan 已提交
2638
}).catch(err => {
Y
Yangys 已提交
2639
  console.log('bind fail');
L
liyufan 已提交
2640 2641 2642 2643 2644
});
```

### getState<sup>9+</sup>

Y
Yangys 已提交
2645
getState(callback: AsyncCallback\<SocketStateBase\>): void
L
liyufan 已提交
2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659

在TLSSocket的bind成功之后,获取TLSSocket状态。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                   | 必填 | 说明       |
| -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback\<[SocketStateBase](#socketstatebase)> | 是   | 回调函数。成功返回TLSSocket状态,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2660
| ------- | ------------------------------ |
L
liyufan 已提交
2661 2662 2663 2664 2665 2666
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
Y
Yangys 已提交
2667
let promise = tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
Y
Yangys 已提交
2668 2669 2670 2671 2672
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
2673 2674
});
tls.getState((err, data) => {
Y
Yangys 已提交
2675 2676 2677 2678 2679
  if (err) {
    console.log('getState fail');
    return;
  }
  console.log('getState success:' + JSON.stringify(data));
L
liyufan 已提交
2680 2681 2682 2683 2684
});
```

### getState<sup>9+</sup>

Y
Yangys 已提交
2685
getState(): Promise\<SocketStateBase\>
L
liyufan 已提交
2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699

在TLSSocket的bind成功之后,获取TLSSocket状态。使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                             | 说明                                       |
| :----------------------------------------------- | :----------------------------------------- |
| Promise\<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取TLSSocket状态的结果。失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2700
| ------- | ------------------------------ |
L
liyufan 已提交
2701 2702 2703 2704 2705 2706
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
Y
Yangys 已提交
2707
let promiseBind = tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 });
Y
Yangys 已提交
2708
promiseBind.then(() => {
Y
Yangys 已提交
2709
  console.log('bind success');
Y
Yangys 已提交
2710
}).catch((err) => {
Y
Yangys 已提交
2711
  console.log('bind fail');
L
liyufan 已提交
2712 2713 2714
});
let promise = tls.getState();
promise.then(() => {
Y
Yangys 已提交
2715
  console.log('getState success');
L
liyufan 已提交
2716
}).catch(err => {
Y
Yangys 已提交
2717
  console.log('getState fail');
L
liyufan 已提交
2718 2719 2720 2721 2722
});
```

### setExtraOptions<sup>9+</sup>

Y
Yangys 已提交
2723
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
L
liyufan 已提交
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738

在TLSSocket的bind成功之后,设置TCPSocket连接的其他属性。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                      | 必填 | 说明                                                         |
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options  | [TCPExtraOptions](#tcpextraoptions) | 是   | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
| callback | AsyncCallback\<void\>                     | 是   | 回调函数。成功返回设置TCPSocket连接的其他属性的结果,失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2739
| ------- | -----------------------------  |
L
liyufan 已提交
2740 2741 2742 2743 2744 2745 2746
| 401     | Parameter error.               |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
Y
Yangys 已提交
2747
tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
Y
Yangys 已提交
2748 2749 2750 2751 2752
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
2753 2754 2755
});

tls.setExtraOptions({
Y
Yangys 已提交
2756 2757 2758
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
Y
Yangys 已提交
2759
  socketLinger: { on: true, linger: 10 },
Y
Yangys 已提交
2760 2761 2762 2763
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
Y
Yangys 已提交
2764
}, err => {
Y
Yangys 已提交
2765 2766 2767 2768 2769
  if (err) {
    console.log('setExtraOptions fail');
    return;
  }
  console.log('setExtraOptions success');
L
liyufan 已提交
2770 2771 2772 2773 2774
});
```

### setExtraOptions<sup>9+</sup>

Y
Yangys 已提交
2775
setExtraOptions(options: TCPExtraOptions): Promise\<void\>
L
liyufan 已提交
2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795

在TLSSocket的bind成功之后,设置TCPSocket连接的其他属性,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                                      | 必填 | 说明                                                         |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [TCPExtraOptions](#tcpextraoptions) | 是   | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |

**返回值:**

| 类型            | 说明                                                 |
| :-------------- | :--------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回设置TCPSocket连接的其他属性的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2796
| ------- | ------------------------------ |
L
liyufan 已提交
2797 2798 2799 2800 2801 2802 2803
| 401     | Parameter error.               |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
Y
Yangys 已提交
2804
tls.bind({ address: '192.168.xx.xxx', port: xxxx, family: 1 }, err => {
Y
Yangys 已提交
2805 2806 2807 2808 2809
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
2810 2811
});
let promise = tls.setExtraOptions({
Y
Yangys 已提交
2812 2813 2814
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
Y
Yangys 已提交
2815
  socketLinger: { on: true, linger: 10 },
Y
Yangys 已提交
2816 2817 2818 2819
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
L
liyufan 已提交
2820 2821
});
promise.then(() => {
Y
Yangys 已提交
2822
  console.log('setExtraOptions success');
L
liyufan 已提交
2823
}).catch(err => {
Y
Yangys 已提交
2824
  console.log('setExtraOptions fail');
L
liyufan 已提交
2825 2826 2827
});
```

X
xujie 已提交
2828
### on('message')<sup>9+</sup>
Y
Yangys 已提交
2829

Y
Yangys 已提交
2830
on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void;
Y
Yangys 已提交
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840

订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
Y
Yangys 已提交
2841
| callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是   | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 |
Y
Yangys 已提交
2842 2843 2844 2845 2846

**示例:**

```js
let tls = socket.constructTLSSocketInstance();
X
xujie 已提交
2847
let messageView = '';
Y
Yangys 已提交
2848 2849 2850 2851
tls.on('message', value => {
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
X
xujie 已提交
2852
    messageView += message;
Y
Yangys 已提交
2853 2854 2855 2856 2857 2858
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
});
```

X
xujie 已提交
2859
### off('message')<sup>9+</sup>
Y
Yangys 已提交
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874

off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void

取消订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
Y
Yangys 已提交
2875
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否   | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 |
Y
Yangys 已提交
2876 2877 2878 2879 2880

**示例:**

```js
let tls = socket.constructTLSSocketInstance();
X
xujie 已提交
2881
let messageView = '';
Y
Yangys 已提交
2882 2883 2884 2885
let callback = value => {
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
X
xujie 已提交
2886
    messageView += message;
Y
Yangys 已提交
2887 2888 2889 2890 2891 2892 2893 2894
  }
  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);
```
X
xujie 已提交
2895
### on('connect' | 'close')<sup>9+</sup>
Y
Yangys 已提交
2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921

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")
});
```

X
xujie 已提交
2922
### off('connect' | 'close')<sup>9+</sup>
Y
Yangys 已提交
2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958

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);
```

X
xujie 已提交
2959
### on('error')<sup>9+</sup>
Y
Yangys 已提交
2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982

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))
});
```

X
xujie 已提交
2983
### off('error')<sup>9+</sup>
Y
Yangys 已提交
2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012

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);
```

L
liyufan 已提交
3013 3014
### connect<sup>9+</sup>

Y
Yangys 已提交
3015
connect(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void
L
liyufan 已提交
3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030

在TLSSocket上bind成功之后,进行通信连接,并创建和初始化TLS会话,实现建立连接过程,启动与服务器的TLS/SSL握手,实现数据传输功能,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                   | 必填 | 说明 |
| -------- | ---------------------------------------| ----| --------------- |
| options  | [TLSConnectOptions](#tlsconnectoptions9) | 是   | TLSSocket连接所需要的参数。|
| callback | AsyncCallback\<void>                  | 是   | 回调函数,成功无返回,失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
3031
| ------- | -------------------------------------------- |
L
liyufan 已提交
3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050
| 401     | Parameter error.                             |
| 2303104 | Interrupted system call.                     |
| 2303109 | Bad file number.                             |
| 2303111 | Resource temporarily unavailable try again.  |
| 2303188 | Socket operation on non-socket.              |
| 2303191 | Protocol wrong type for socket.              |
| 2303198 | Address already in use.                      |
| 2303199 | Cannot assign requested address.             |
| 2303210 | Connection timed out.                        |
| 2303501 | SSL is null.                                 |
| 2303502 | Error in tls reading.                        |
| 2303503 | Error in tls writing                         |
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**示例:**

```js
Y
YOUR_NAME 已提交
3051
let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
Y
Yangys 已提交
3052
tlsTwoWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
Y
Yangys 已提交
3053 3054 3055 3056 3057
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
3058 3059
});
let options = {
Y
Yangys 已提交
3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "192.168.xx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
L
liyufan 已提交
3076
};
Y
YOUR_NAME 已提交
3077
tlsTwoWay.connect(options, (err, data) => {
Y
Yangys 已提交
3078 3079
  console.error("connect callback error" + err);
  console.log(JSON.stringify(data));
L
liyufan 已提交
3080 3081 3082
});

let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
Y
Yangys 已提交
3083
tlsOneWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
Y
Yangys 已提交
3084 3085 3086 3087 3088
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
3089 3090
});
let oneWayOptions = {
Y
Yangys 已提交
3091 3092 3093 3094 3095 3096 3097 3098 3099
  address: {
    address: "192.168.xxx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    ca: ["xxxx", "xxxx"],
    cipherSuite: "AES256-SHA256",
  },
L
liyufan 已提交
3100
};
Y
YOUR_NAME 已提交
3101
tlsOneWay.connect(oneWayOptions, (err, data) => {
Y
Yangys 已提交
3102 3103
  console.error("connect callback error" + err);
  console.log(JSON.stringify(data));
L
liyufan 已提交
3104 3105 3106 3107 3108
});
```

### connect<sup>9+</sup>

Y
Yangys 已提交
3109
connect(options: TLSConnectOptions): Promise\<void\>
L
liyufan 已提交
3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124

在TLSSocket上bind成功之后,进行通信连接,并创建和初始化TLS会话,实现建立连接过程,启动与服务器的TLS/SSL握手,实现数据传输功能,该连接包括两种认证方式,单向认证与双向认证,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                   | 必填 | 说明 |
| -------- | --------------------------------------| ----| --------------- |
| options  | [TLSConnectOptions](#tlsconnectoptions9) | 是   | 连接所需要的参数。|

**返回值:**

| 类型                                        | 说明                          |
| ------------------------------------------- | ----------------------------- |
Y
Yangys 已提交
3125
| Promise\<void\>                              | 以Promise形式返回,成功无返回,失败返回错误码,错误信息。|
L
liyufan 已提交
3126 3127 3128 3129

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
3130
| ------- | -------------------------------------------- |
L
liyufan 已提交
3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149
| 401     | Parameter error.                             |
| 2303104 | Interrupted system call.                     |
| 2303109 | Bad file number.                             |
| 2303111 | Resource temporarily unavailable try again.  |
| 2303188 | Socket operation on non-socket.              |
| 2303191 | Protocol wrong type for socket.              |
| 2303198 | Address already in use.                      |
| 2303199 | Cannot assign requested address.             |
| 2303210 | Connection timed out.                        |
| 2303501 | SSL is null.                                 |
| 2303502 | Error in tls reading.                        |
| 2303503 | Error in tls writing                         |
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**示例:**

```js
Y
YOUR_NAME 已提交
3150
let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
Y
Yangys 已提交
3151
tlsTwoWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
Y
Yangys 已提交
3152 3153 3154 3155 3156
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
3157 3158
});
let options = {
Y
Yangys 已提交
3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "xxxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
L
liyufan 已提交
3175
};
Y
YOUR_NAME 已提交
3176
tlsTwoWay.connect(options).then(data => {
Y
Yangys 已提交
3177
  console.log(JSON.stringify(data));
L
liyufan 已提交
3178
}).catch(err => {
Y
Yangys 已提交
3179
  console.error(err);
L
liyufan 已提交
3180 3181 3182
});

let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
Y
Yangys 已提交
3183
tlsOneWay.bind({ address: '192.168.xxx.xxx', port: 8080, family: 1 }, err => {
Y
Yangys 已提交
3184 3185 3186 3187 3188
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
L
liyufan 已提交
3189 3190
});
let oneWayOptions = {
Y
Yangys 已提交
3191 3192 3193 3194 3195 3196 3197 3198 3199
  address: {
    address: "192.168.xxx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    ca: ["xxxx", "xxxx"],
    cipherSuite: "AES256-SHA256",
  },
L
liyufan 已提交
3200 3201
};
tlsOneWay.connect(oneWayOptions).then(data => {
Y
Yangys 已提交
3202
  console.log(JSON.stringify(data));
L
liyufan 已提交
3203
}).catch(err => {
Y
Yangys 已提交
3204
  console.error(err);
L
liyufan 已提交
3205 3206 3207 3208 3209
});
```

### getRemoteAddress<sup>9+</sup>

Y
Yangys 已提交
3210
getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
L
liyufan 已提交
3211 3212 3213 3214 3215 3216 3217 3218 3219

在TLSSocket通信连接成功之后,获取对端Socket地址。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                              | 必填 | 说明       |
| -------- | ------------------------------------------------- | ---- | ---------- |
Y
Yangys 已提交
3220
| callback | AsyncCallback\<[NetAddress](#netaddress)\> | 是   | 回调函数。成功返回对端的socket地址,失败返回错误码,错误信息。 |
L
liyufan 已提交
3221 3222 3223 3224

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
3225
| ------- | -----------------------------  |
L
liyufan 已提交
3226 3227 3228 3229 3230 3231 3232
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
tls.getRemoteAddress((err, data) => {
Y
Yangys 已提交
3233 3234 3235 3236 3237
  if (err) {
    console.log('getRemoteAddress fail');
    return;
  }
  console.log('getRemoteAddress success:' + JSON.stringify(data));
L
liyufan 已提交
3238 3239 3240 3241 3242
});
```

### getRemoteAddress<sup>9+</sup>

Y
Yangys 已提交
3243
getRemoteAddress(): Promise\<NetAddress\>
L
liyufan 已提交
3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257

在TLSSocket通信连接成功之后,获取对端Socket地址。使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                        | 说明                                        |
| :------------------------------------------ | :------------------------------------------ |
| Promise\<[NetAddress](#netaddress)> | 以Promise形式返回获取对端socket地址的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
3258
| ------- | ------------------------------ |
L
liyufan 已提交
3259 3260 3261 3262 3263 3264 3265 3266
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
let promise = tls.getRemoteAddress();
promise.then(() => {
Y
Yangys 已提交
3267
  console.log('getRemoteAddress success');
L
liyufan 已提交
3268
}).catch(err => {
Y
Yangys 已提交
3269
  console.log('getRemoteAddress fail');
L
liyufan 已提交
3270 3271 3272 3273 3274
});
```

### getCertificate<sup>9+</sup>

Y
Yangys 已提交
3275
getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): void
L
liyufan 已提交
3276 3277 3278 3279 3280 3281 3282 3283 3284

在TLSSocket通信连接成功之后,获取本地的数字证书,该接口只适用于双向认证时,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                   | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------|
Y
Yangys 已提交
3285
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>    | 是   | 回调函数,成功返回本地的证书,失败返回错误码,错误信息。|
L
liyufan 已提交
3286 3287 3288 3289

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
3290
| ------- | ------------------------------ |
L
liyufan 已提交
3291 3292 3293 3294 3295 3296 3297 3298
| 2303501 | SSL is null.                   |
| 2303504 | Error looking up x509.         |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getCertificate((err, data) => {
Y
Yangys 已提交
3299 3300 3301 3302 3303
  if (err) {
    console.log("getCertificate callback error = " + err);
  } else {
    console.log("getCertificate callback = " + data);
  }
L
liyufan 已提交
3304 3305 3306 3307 3308
});
```

### getCertificate<sup>9+</sup>

Y
Yangys 已提交
3309
getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>
L
liyufan 已提交
3310 3311 3312 3313 3314 3315 3316 3317 3318

在TLSSocket通信连接之后,获取本地的数字证书,该接口只适用于双向认证时,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型            | 说明                  |
| -------------- | -------------------- |
Y
Yangys 已提交
3319
| Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回本地的数字证书的结果。失败返回错误码,错误信息。 |
L
liyufan 已提交
3320 3321 3322 3323

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
3324
| ------- | ------------------------------ |
L
liyufan 已提交
3325 3326 3327 3328 3329 3330 3331 3332
| 2303501 | SSL is null.                   |
| 2303504 | Error looking up x509.         |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getCertificate().then(data => {
Y
Yangys 已提交
3333
  console.log(data);
L
liyufan 已提交
3334
}).catch(err => {
Y
Yangys 已提交
3335
  console.error(err);
L
liyufan 已提交
3336 3337 3338 3339 3340
});
```

### getRemoteCertificate<sup>9+</sup>

Y
Yangys 已提交
3341
getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): void
L
liyufan 已提交
3342 3343 3344 3345 3346 3347 3348 3349 3350

在TLSSocket通信连接成功之后,获取服务端的数字证书,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名    | 类型                                    | 必填  | 说明           |
| -------- | ----------------------------------------| ---- | ---------------|
Y
Yangys 已提交
3351
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>  | 是   | 回调函数,返回服务端的证书。失败返回错误码,错误信息。 |
L
liyufan 已提交
3352 3353 3354 3355

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3356
| ------- | ------------------------------ |
L
liyufan 已提交
3357 3358 3359 3360 3361 3362 3363
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getRemoteCertificate((err, data) => {
Y
Yangys 已提交
3364 3365 3366 3367 3368
  if (err) {
    console.log("getRemoteCertificate callback error = " + err);
  } else {
    console.log("getRemoteCertificate callback = " + data);
  }
L
liyufan 已提交
3369 3370 3371 3372 3373
});
```

### getRemoteCertificate<sup>9+</sup>

Y
Yangys 已提交
3374
getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>
L
liyufan 已提交
3375 3376 3377 3378 3379 3380 3381 3382 3383

在TLSSocket通信连接成功之后,获取服务端的数字证书,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型            | 说明                  |
| -------------- | -------------------- |
Y
Yangys 已提交
3384
| Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码,错误信息。 |
L
liyufan 已提交
3385 3386 3387 3388

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3389
| ------- | ------------------------------ |
L
liyufan 已提交
3390 3391 3392 3393 3394 3395 3396
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getRemoteCertificate().then(data => {
Y
Yangys 已提交
3397
  console.log(data);
L
liyufan 已提交
3398
}).catch(err => {
Y
Yangys 已提交
3399
  console.error(err);
L
liyufan 已提交
3400 3401 3402 3403 3404
});
```

### getProtocol<sup>9+</sup>

Y
Yangys 已提交
3405
getProtocol(callback: AsyncCallback\<string\>): void
L
liyufan 已提交
3406 3407 3408 3409 3410 3411 3412 3413 3414

在TLSSocket通信连接成功之后,获取通信的协议版本,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                       | 必填 | 说明           |
| -------- | ----------------------------------------| ---- | ---------------|
Y
Yangys 已提交
3415
| callback | AsyncCallback\<string\>                  | 是   | 回调函数,返回通信的协议。失败返回错误码,错误信息。|
L
liyufan 已提交
3416 3417 3418 3419

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3420
| ------- | -----------------------------  |
L
liyufan 已提交
3421 3422 3423 3424 3425 3426 3427 3428
| 2303501 | SSL is null.                   |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getProtocol((err, data) => {
Y
Yangys 已提交
3429 3430 3431 3432 3433
  if (err) {
    console.log("getProtocol callback error = " + err);
  } else {
    console.log("getProtocol callback = " + data);
  }
L
liyufan 已提交
3434 3435 3436 3437 3438
});
```

### getProtocol<sup>9+</sup>

Y
Yangys 已提交
3439
getProtocol():Promise\<string\>
L
liyufan 已提交
3440 3441 3442 3443 3444 3445 3446 3447 3448

在TLSSocket通信连接成功之后,获取通信的协议版本,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型            | 说明                  |
| -------------- | -------------------- |
Y
Yangys 已提交
3449
| Promise\<string\> | 以Promise形式返回通信的协议。失败返回错误码,错误信息。 |
L
liyufan 已提交
3450 3451 3452 3453

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3454
| ------- | ------------------------------ |
L
liyufan 已提交
3455 3456 3457 3458 3459 3460 3461 3462
| 2303501 | SSL is null.                   |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getProtocol().then(data => {
Y
Yangys 已提交
3463
  console.log(data);
L
liyufan 已提交
3464
}).catch(err => {
Y
Yangys 已提交
3465
  console.error(err);
L
liyufan 已提交
3466 3467 3468 3469 3470
});
```

### getCipherSuite<sup>9+</sup>

Y
Yangys 已提交
3471
getCipherSuite(callback: AsyncCallback\<Array\<string\>\>): void
L
liyufan 已提交
3472 3473 3474 3475 3476 3477 3478 3479 3480

在TLSSocket通信连接成功之后,获取通信双方协商后的加密套件,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                     | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------|
Y
Yangys 已提交
3481
| callback | AsyncCallback\<Array\<string\>\>          | 是   | 回调函数,返回通信双方支持的加密套件。 失败返回错误码,错误信息。 |
L
liyufan 已提交
3482 3483 3484 3485

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3486
| ------- | ------------------------------ |
L
liyufan 已提交
3487 3488 3489 3490 3491 3492 3493 3494 3495
| 2303501 | SSL is null.                   |
| 2303502 | Error in tls reading.          |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getCipherSuite((err, data) => {
Y
Yangys 已提交
3496 3497 3498 3499 3500
  if (err) {
    console.log("getCipherSuite callback error = " + err);
  } else {
    console.log("getCipherSuite callback = " + data);
  }
L
liyufan 已提交
3501 3502 3503 3504 3505
});
```

### getCipherSuite<sup>9+</sup>

Y
Yangys 已提交
3506
getCipherSuite(): Promise\<Array\<string\>\>
L
liyufan 已提交
3507 3508 3509 3510 3511 3512 3513 3514 3515

在TLSSocket通信连接成功之后,获取通信双方协商后的加密套件,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                    | 说明                  |
| ---------------------- | --------------------- |
Y
Yangys 已提交
3516
| Promise\<Array\<string\>\> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码,错误信息。 |
L
liyufan 已提交
3517 3518 3519 3520

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3521
| ------- | ------------------------------ |
L
liyufan 已提交
3522 3523 3524 3525 3526 3527 3528 3529 3530
| 2303501 | SSL is null.                   |
| 2303502 | Error in tls reading.          |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getCipherSuite().then(data => {
Y
Yangys 已提交
3531
  console.log('getCipherSuite success:' + JSON.stringify(data));
L
liyufan 已提交
3532
}).catch(err => {
Y
Yangys 已提交
3533
  console.error(err);
L
liyufan 已提交
3534 3535 3536 3537 3538
});
```

### getSignatureAlgorithms<sup>9+</sup>

Y
Yangys 已提交
3539
getSignatureAlgorithms(callback: AsyncCallback\<Array\<string\>\>): void
L
liyufan 已提交
3540 3541 3542 3543 3544 3545 3546 3547 3548

在TLSSocket通信连接成功之后,获取通信双方协商后签名算法,该接口只适配双向认证模式下,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                   | 必填 | 说明            |
| -------- | -------------------------------------| ---- | ---------------|
Y
Yangys 已提交
3549
| callback | AsyncCallback\<Array\<string\>\>         | 是   | 回调函数,返回双方支持的签名算法。  |
L
liyufan 已提交
3550 3551 3552 3553

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3554
| ------- | ------------------------------ |
L
liyufan 已提交
3555 3556 3557 3558 3559 3560 3561
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getSignatureAlgorithms((err, data) => {
Y
Yangys 已提交
3562 3563 3564 3565 3566
  if (err) {
    console.log("getSignatureAlgorithms callback error = " + err);
  } else {
    console.log("getSignatureAlgorithms callback = " + data);
  }
L
liyufan 已提交
3567 3568 3569 3570 3571
});
```

### getSignatureAlgorithms<sup>9+</sup>

Y
Yangys 已提交
3572
getSignatureAlgorithms(): Promise\<Array\<string\>\>
L
liyufan 已提交
3573 3574 3575 3576 3577 3578 3579 3580 3581

在TLSSocket通信连接成功之后,获取通信双方协商后的签名算法,该接口只适配双向认证模式下,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                    | 说明                  |
| ---------------------- | -------------------- |
Y
Yangys 已提交
3582
| Promise\<Array\<string\>\> | 以Promise形式返回获取到的双方支持的签名算法。 |
L
liyufan 已提交
3583 3584 3585 3586

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
3587
| ------- | ------------------------------ |
L
liyufan 已提交
3588 3589 3590 3591 3592 3593 3594
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getSignatureAlgorithms().then(data => {
Y
Yangys 已提交
3595
  console.log("getSignatureAlgorithms success" + data);
L
liyufan 已提交
3596
}).catch(err => {
Y
Yangys 已提交
3597
  console.error(err);
L
liyufan 已提交
3598 3599 3600 3601 3602
});
```

### send<sup>9+</sup>

Y
Yangys 已提交
3603
send(data: string, callback: AsyncCallback\<void\>): void
L
liyufan 已提交
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613

在TLSSocket通信连接成功之后,向服务端发送消息,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名    | 类型                          | 必填 | 说明            |
| -------- | -----------------------------| ---- | ---------------|
|   data   | string                       | 是   | 发送的数据内容。   |
Y
Yangys 已提交
3614
| callback | AsyncCallback\<void\>         | 是   | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 |
L
liyufan 已提交
3615 3616 3617 3618

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
3619
| ------- | -------------------------------------------- |
L
liyufan 已提交
3620 3621
| 401     | Parameter error.                             |
| 2303501 | SSL is null.                                 |
X
xujie 已提交
3622
| 2303503 | Error in tls writing.                         |
L
liyufan 已提交
3623 3624 3625 3626 3627 3628 3629 3630
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**示例:**

```js
tls.send("xxxx", (err) => {
Y
Yangys 已提交
3631 3632 3633 3634 3635
  if (err) {
    console.log("send callback error = " + err);
  } else {
    console.log("send success");
  }
L
liyufan 已提交
3636 3637 3638 3639 3640
});
```

### send<sup>9+</sup>

Y
Yangys 已提交
3641
send(data: string): Promise\<void\>
L
liyufan 已提交
3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655

在TLSSocket通信连接成功之后,向服务端发送消息,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名    | 类型                          | 必填 | 说明            |
| -------- | -----------------------------| ---- | ---------------|
|   data   | string                       | 是   | 发送的数据内容。   |

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
3656
| ------- | -------------------------------------------- |
L
liyufan 已提交
3657 3658
| 401     | Parameter error.                             |
| 2303501 | SSL is null.                                 |
X
xujie 已提交
3659
| 2303503 | Error in tls writing.                         |
L
liyufan 已提交
3660 3661 3662 3663 3664 3665 3666 3667
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**返回值:**

| 类型           | 说明                  |
| -------------- | -------------------- |
Y
Yangys 已提交
3668
| Promise\<void\> | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 |
L
liyufan 已提交
3669 3670 3671 3672

**示例:**

```js
Y
Yangys 已提交
3673
tls.send("xxxx").then(() => {
Y
Yangys 已提交
3674
  console.log("send success");
L
liyufan 已提交
3675
}).catch(err => {
Y
Yangys 已提交
3676
  console.error(err);
L
liyufan 已提交
3677 3678 3679 3680 3681
});
```

### close<sup>9+</sup>

Y
Yangys 已提交
3682
close(callback: AsyncCallback\<void\>): void
L
liyufan 已提交
3683 3684 3685 3686 3687 3688 3689 3690 3691

在TLSSocket通信连接成功之后,断开连接,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名    | 类型                          | 必填 | 说明            |
| -------- | -----------------------------| ---- | ---------------|
Y
Yangys 已提交
3692
| callback | AsyncCallback\<void\>         | 是   | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码,错误信息。 |
L
liyufan 已提交
3693 3694 3695 3696

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
3697
| ------- | -------------------------------------------- |
X
xujie 已提交
3698
| 401 | Parameter error.                                 |
L
liyufan 已提交
3699 3700 3701 3702 3703 3704 3705 3706 3707
| 2303501 | SSL is null.                                 |
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**示例:**

```js
tls.close((err) => {
Y
Yangys 已提交
3708 3709 3710 3711 3712
  if (err) {
    console.log("close callback error = " + err);
  } else {
    console.log("close success");
  }
L
liyufan 已提交
3713 3714 3715 3716 3717
});
```

### close<sup>9+</sup>

Y
Yangys 已提交
3718
close(): Promise\<void\>
L
liyufan 已提交
3719 3720 3721 3722 3723 3724 3725 3726 3727

在TLSSocket通信连接成功之后,断开连接,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型           | 说明                  |
| -------------- | -------------------- |
Y
Yangys 已提交
3728
| Promise\<void\> | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码,错误信息。 |
L
liyufan 已提交
3729 3730 3731 3732

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
3733
| ------- | -------------------------------------------- |
X
xujie 已提交
3734
| 401 | Parameter error.                                 |
L
liyufan 已提交
3735 3736 3737 3738 3739 3740 3741 3742
| 2303501 | SSL is null.                                 |
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**示例:**

```js
Y
Yangys 已提交
3743
tls.close().then(() => {
Y
Yangys 已提交
3744
  console.log("close success");
Y
Yangys 已提交
3745
}).catch((err) => {
Y
Yangys 已提交
3746
  console.error(err);
L
liyufan 已提交
3747 3748 3749 3750 3751 3752 3753 3754 3755
});
```

## TLSConnectOptions<sup>9+</sup>

TLS连接的操作。

**系统能力**:SystemCapability.Communication.NetStack

L
liyufan 已提交
3756 3757 3758 3759
| 名称          | 类型                                     | 必填 | 说明            |
| -------------- | ------------------------------------- | ---  |-------------- |
| address        | [NetAddress](#netaddress)             | 是  |  网关地址。       |
| secureOptions  | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。|
X
xujie 已提交
3760
| ALPNProtocols  | Array\<string\>                         | 否 | ALPN协议,支持["spdy/1", "http/1.1"],默认为[]。      |
L
liyufan 已提交
3761 3762 3763 3764 3765 3766 3767

## TLSSecureOptions<sup>9+</sup>

TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参数。当本地证书cert和私钥key不为空时,开启双向验证模式。cert和key其中一项为空时,开启单向验证模式。

**系统能力**:SystemCapability.Communication.NetStack

L
liyufan 已提交
3768 3769
| 名称                 | 类型                                                    | 必填 | 说明                                |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- |
Y
Yangys 已提交
3770
| ca                    | string \| Array\<string\>                               | 是 | 服务端的ca证书,用于认证校验服务端的数字证书。|
L
liyufan 已提交
3771 3772
| cert                  | string                                                  | 否 | 本地客户端的数字证书。                 |
| key                   | string                                                  | 否 | 本地数字证书的私钥。                   |
Z
zhanghaifeng 已提交
3773
| password                | string                                                  | 否 | 读取私钥的密码。                      |
X
xujie 已提交
3774 3775 3776 3777
| protocols             | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)\> | 否 | TLS的协议版本,默认为"TLSv1.2"。                  |
| useRemoteCipherPrefer | boolean                                                 | 否 | 优先使用对等方的密码套件。        |
| signatureAlgorithms   | string                                                 | 否 | 通信过程中的签名算法,默认为"" 。              |
| cipherSuite           | string                                                 | 否 | 通信过程中的加密套件,默认为"" 。              |
L
liyufan 已提交
3778 3779 3780 3781 3782 3783 3784

## Protocol<sup>9+</sup>

TLS通信的协议版本。

**系统能力**:SystemCapability.Communication.NetStack

L
liyufan 已提交
3785 3786 3787 3788
| 名称      |    值    | 说明                |
| --------- | --------- |------------------ |
| TLSv12    | "TLSv1.2" | 使用TLSv1.2协议通信。 |
| TLSv13    | "TLSv1.3" | 使用TLSv1.3协议通信。 |
L
liyufan 已提交
3789 3790 3791 3792 3793 3794 3795

## X509CertRawData<sup>9+</sup>

存储证书的数据。

**系统能力**:SystemCapability.Communication.NetStack

X
xujie 已提交
3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166
## socket.constructTLSSocketServerInstance<sup>10+</sup>

constructTLSSocketServerInstance(): TLSSocketServer

创建并返回一个TLSSocketServer对象。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                  | 说明                          |
| :------------------------------------ | :---------------------------- |
| [TLSSocketServer](#tlssocketserver10) | 返回一个TLSSocketServer对象。 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
```

## TLSSocketServer<sup>10+</sup>

TLSSocketServer连接。在调用TLSSocketServer的方法前,需要先通过[socket.constructTLSSocketServerInstance](#socketconstructtlssocketserverinstance10)创建TLSSocketServer对象。

### listen<sup>10+</sup>

listen(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void

绑定IP地址和端口,在TLSSocketServer上bind成功之后,监听客户端的连接,创建和初始化TLS会话,实现建立连接过程,加载证书秘钥并验证,使用callback方式作为异步方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                             |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------ |
| options  | [TLSConnectOptions](#tlsconnectoptions9) | 是   | TLSSocketServer连接所需要的参数。                |
| callback | AsyncCallback\<void>                     | 是   | 回调函数,成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| 401      | Parameter error.                            |
| 201      | Permission denied.                          |
| 2300002  | System internal error.                      |
| 2303109  | Bad file number.                            |
| 2303111  | Resource temporarily unavailable try again. |
| 2303198  | Address already in use.                     |
| 2303199  | Cannot assign requested address.            |
| 2303501  | SSL is null.                                |
| 2303502  | Error in tls reading.                       |
| 2303503  | Error in tls writing                        |
| 2303505  | Error occurred in the tls system call.      |
| 2303506  | Error clearing tls connection.              |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "192.168.xx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
};
tlsServer.listen(options, (err, data) => {
  console.error("listen callback error" + err);
  console.log(JSON.stringify(data));
});
```

### listen<sup>10+</sup>

listen(options: TLSConnectOptions): Promise\<void\>

绑定IP地址和端口,在TLSSocketServer上bind成功之后,监听客户端的连接,并创建和初始化TLS会话,实现建立连接过程,加载证书秘钥并验证,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.INTERNET

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                                     | 必填 | 说明               |
| ------- | ---------------------------------------- | ---- | ------------------ |
| options | [TLSConnectOptions](#tlsconnectoptions9) | 是   | 连接所需要的参数。 |

**返回值:**

| 类型            | 说明                                                      |
| --------------- | --------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                    |
| -------- | ------------------------------------------- |
| 401      | Parameter error.                            |
| 201      | Permission denied.                          |
| 2300002  | System internal error.                      |
| 2303109  | Bad file number.                            |
| 2303111  | Resource temporarily unavailable try again. |
| 2303198  | Address already in use.                     |
| 2303199  | Cannot assign requested address.            |
| 2303501  | SSL is null.                                |
| 2303502  | Error in tls reading.                       |
| 2303503  | Error in tls writing                        |
| 2303505  | Error occurred in the tls system call.      |
| 2303506  | Error clearing tls connection.              |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "xxxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
};
tlsServer.listen(options).then(data => {
  console.log(JSON.stringify(data));
}).catch(err => {
  console.error(err);
});
```

### getState<sup>10+</sup>

getState(callback: AsyncCallback\<SocketStateBase\>): void

在TLSSocketServer的listen成功之后,获取TLSSocketServer状态。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                 | 必填 | 说明                                                         |
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<[SocketStateBase](#socketstatebase7)> | 是   | 回调函数。成功返回TLSSocketServer状态,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 2303188  | Socket operation on non-socket. |
| 2300002  | System internal error.          |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "192.168.xx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
};
tlsServer.listen(options, (err, data) => {
  console.error("listen callback error" + err);
  console.log(JSON.stringify(data));
});

tlsServer.getState((err, data) => {
  if (err) {
    console.log('getState fail');
    return;
  }
  console.log('getState success:' + JSON.stringify(data));
});
```

### getState<sup>10+</sup>

getState(): Promise\<SocketStateBase\>

在TLSSocketServer的listen成功之后,获取TLSSocketServer状态。使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                           | 说明                                                         |
| :--------------------------------------------- | :----------------------------------------------------------- |
| Promise\<[SocketStateBase](#socketstatebase7)> | 以Promise形式返回获取TLSSocketServer状态的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 2303188  | Socket operation on non-socket. |
| 2300002  | System internal error.          |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "xxxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
};
tlsServer.listen(options).then(data => {
  console.log(JSON.stringify(data));
}).catch(err => {
  console.error(err);
});
let promise = tlsServer.getState();
promise.then(() => {
  console.log('getState success');
}).catch(err => {
  console.log('getState fail');
});
```

### setExtraOptions<sup>10+</sup>

setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void

在TLSSocketServer的listen成功之后,设置TLSSocketServer连接的其他属性。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                 | 必填 | 说明                                             |
| -------- | ------------------------------------ | ---- | ------------------------------------------------ |
| options  | [TCPExtraOptions](#tcpextraoptions7) | 是   | TLSSocketServer连接的其他属性。                  |
| callback | AsyncCallback\<void\>                | 是   | 回调函数。成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 2303188  | Socket operation on non-socket. |
| 2300002  | System internal error.          |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "192.168.xx.xxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
};
tlsServer.listen(options, (err, data) => {
  console.error("listen callback error" + err);
  console.log(JSON.stringify(data));
});
tlsServer.setExtraOptions({
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
}, err => {
  if (err) {
    console.log('setExtraOptions fail');
    return;
  }
  console.log('setExtraOptions success');
});
```

### setExtraOptions<sup>10+</sup>

setExtraOptions(options: TCPExtraOptions): Promise\<void\>

在TLSSocketServer的listen成功之后,设置TLSSocketServer连接的其他属性,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名  | 类型                                 | 必填 | 说明                            |
| ------- | ------------------------------------ | ---- | ------------------------------- |
| options | [TCPExtraOptions](#tcpextraoptions7) | 是   | TLSSocketServer连接的其他属性。 |

**返回值:**

| 类型            | 说明                                                      |
| :-------------- | :-------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 2303188  | Socket operation on non-socket. |
| 2300002  | System internal error.          |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "xxxx",
    port: 8080,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    password: "xxxx",
    protocols: [socket.Protocol.TLSv12],
    useRemoteCipherPrefer: true,
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
  },
};
tlsServer.listen(options).then(data => {
  console.log(JSON.stringify(data));
}).catch(err => {
  console.error(err);
});
let promise = tlsServer.setExtraOptions({
  keepAlive: true,
  OOBInline: true,
  TCPNoDelay: true,
  socketLinger: { on: true, linger: 10 },
  receiveBufferSize: 1000,
  sendBufferSize: 1000,
  reuseAddress: true,
  socketTimeout: 3000,
});
promise.then(() => {
  console.log('setExtraOptions success');
}).catch(err => {
  console.log('setExtraOptions fail');
});
```

### getCertificate<sup>10+</sup>

getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): void

在TLSSocketServer通信连接成功之后,获取本地的数字证书,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                     |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------------------------- |
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是   | 回调函数,成功返回本地的证书,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 401      | Parameter error.       |
| 2303501  | SSL is null.           |
| 2303504  | Error looking up x509. |
| 2300002  | System internal error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.getCertificate((err, data) => {
  if (err) {
    console.log("getCertificate callback error = " + err);
  } else {
    console.log("getCertificate callback = " + data);
  }
});
```

### getCertificate<sup>10+</sup>

getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>

在TLSSocketServer通信连接之后,获取本地的数字证书,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                            | 说明                                                         |
| ----------------------------------------------- | ------------------------------------------------------------ |
| Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回本地的数字证书的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 2303501  | SSL is null.           |
| 2303504  | Error looking up x509. |
| 2300002  | System internal error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.getCertificate().then(data => {
  console.log(data);
}).catch(err => {
  console.error(err);
});
```

### getProtocol<sup>10+</sup>

getProtocol(callback: AsyncCallback\<string\>): void

在TLSSocketServer通信连接成功之后,获取通信的协议版本,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                    | 必填 | 说明                                                 |
| -------- | ----------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback\<string\> | 是   | 回调函数,返回通信的协议。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 401      | Parameter error.                       |
| 2303501  | SSL is null.                           |
| 2303505  | Error occurred in the tls system call. |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.getProtocol((err, data) => {
  if (err) {
    console.log("getProtocol callback error = " + err);
  } else {
    console.log("getProtocol callback = " + data);
  }
});
```

### getProtocol<sup>10+</sup>

getProtocol():Promise\<string\>

在TLSSocketServer通信连接成功之后,获取通信的协议版本,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型              | 说明                                                    |
| ----------------- | ------------------------------------------------------- |
| Promise\<string\> | 以Promise形式返回通信的协议。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 2303501  | SSL is null.                           |
| 2303505  | Error occurred in the tls system call. |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.getProtocol().then(data => {
  console.log(data);
}).catch(err => {
  console.error(err);
});
```

### on('connect')

on(type: 'connect', callback: Callback\<TLSSocketConnection\>): void

订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                  |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------- |
| type     | string                                                  | 是   | 订阅的事件类型。'connect':连接事件。 |
| callback | Callback<[TLSSocketConnection](#tlssocketconnection10)> | 是   | 回调函数。                            |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(data) {
  console.log(JSON.stringify(data))
});
```

### off('connect')

off(type: 'connect', callback?: Callback\<TLSSocketConnection\>): void

取消订阅TLSSocketServer的连接事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                  |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------- |
| type     | string                                                  | 是   | 订阅的事件类型。'connect':连接事件。 |
| callback | Callback<[TLSSocketConnection](#tlssocketconnection10)> | 否   | 回调函数。                            |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let callback = data => {
  console.log('on connect message: ' + JSON.stringify(data));
}
tlsServer.on('connect', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tlsServer.off('connect', callback);
tlsServer.off('connect');
```

### on('error')

on(type: 'error', callback: ErrorCallback): void

订阅TLSSocketServer连接的error事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('error', err => {
  console.log("on error, err:" + JSON.stringify(err))
});
```

### off('error')

off(type: 'error', callback?: ErrorCallback): void

取消订阅TLSSocketServer连接的error事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
let callback = err => {
  console.log("on error, err:" + JSON.stringify(err));
}
tlsServer.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tlsServer.off('error', callback);
tlsServer.off('error');
```

## TLSSocketConnection<sup>10+</sup>

TLSSocketConnection连接,即TLSSocket客户端与服务端的连接。在调用TLSSocketConnection的方法前,需要先获取TLSSocketConnection对象。

> **说明:**
> 客户端与服务端成功建立连接后,才能通过返回的TLSSocketConnection对象调用相应的接口。

**系统能力**:SystemCapability.Communication.NetStack

### 属性

| 名称     | 类型   | 必填 | 说明                                  |
| -------- | ------ | ---- | ------------------------------------- |
| clientId | number | 是   | 客户端与TLSSocketServer建立连接的id。 |

### send<sup>10+</sup>

send(data: string, callback: AsyncCallback\<void\>): void

在TLSSocketServer通信连接成功之后,向客户端发送消息,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                  | 必填 | 说明                                             |
| -------- | --------------------- | ---- | ------------------------------------------------ |
| data     | string                | 是   | TLSSocketServer发送数据所需要的参数。            |
| callback | AsyncCallback\<void\> | 是   | 回调函数,成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 401      | Parameter error.                       |
| 2303501  | SSL is null.                           |
| 2303503  | Error in tls writing.                  |
| 2303505  | Error occurred in the tls system call. |
| 2303506  | Error clearing tls connection.         |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.send({data: 'Hello, client!'}, err => {
    if (err) {
        console.log('send fail');
        return;
    }
    console.log('send success');
  });
});
```

### send<sup>10+</sup>

send(data: string): Promise\<void\>

在TLSSocketServer通信连接成功之后,向服务端发送消息,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名 | 类型   | 必填 | 说明                                  |
| ------ | ------ | ---- | ------------------------------------- |
| data   | string | 是   | TLSSocketServer发送数据所需要的参数。 |

**返回值:**

| 类型            | 说明                                                      |
| --------------- | --------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回,成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 401      | Parameter error.                       |
| 2303501  | SSL is null.                           |
| 2303503  | Error in tls writing.                  |
| 2303505  | Error occurred in the tls system call. |
| 2303506  | Error clearing tls connection.         |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  let promise = client.send({data: 'Hello, client!'});
  promise.then(() => {
    console.log('send success');
  }).catch(err => {
    console.log('send fail');
  });
});
```

### close<sup>10+</sup>

close(callback: AsyncCallback\<void\>): void

在与TLSSocketServer通信连接成功之后,断开连接,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                  | 必填 | 说明                                             |
| -------- | --------------------- | ---- | ------------------------------------------------ |
| callback | AsyncCallback\<void\> | 是   | 回调函数,成功返回空,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 401      | Parameter error.                       |
| 2303501  | SSL is null.                           |
| 2303505  | Error occurred in the tls system call. |
| 2303506  | Error clearing tls connection.         |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.close(err => {
    if (err) {
      console.log('close fail');
      return;
    }
    console.log('close success');
  });
});
```

### close<sup>10+</sup>

close(): Promise\<void\>

在与TLSSocketServer通信连接成功之后,断开连接,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型            | 说明                                                      |
| --------------- | --------------------------------------------------------- |
| Promise\<void\> | 以Promise形式返回,成功返回空。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 2303501  | SSL is null.                           |
| 2303505  | Error occurred in the tls system call. |
| 2303506  | Error clearing tls connection.         |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  let promise = client.close();
  promise.then(() => {
    console.log('close success');
  }).catch(err => {
    console.log('close fail');
  });
});
```

### getRemoteAddress<sup>10+</sup>

getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void

在TLSSocketServer通信连接成功之后,获取对端Socket地址。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                        | 必填 | 说明                                                         |
| -------- | ------------------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<[NetAddress](#netaddress7)\> | 是   | 回调函数。成功返回对端的socket地址,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 401      | Parameter error.                |
| 2303188  | Socket operation on non-socket. |
| 2300002  | System internal error.          |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getRemoteAddress((err, data) => {
    if (err) {
      console.log('getRemoteAddress fail');
      return;
    }
    console.log('getRemoteAddress success:' + JSON.stringify(data));
  });
});
```

### getRemoteAddress<sup>10+</sup>

getRemoteAddress(): Promise\<NetAddress\>

在TLSSocketServer通信连接成功之后,获取对端Socket地址。使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                 | 说明                                                         |
| :----------------------------------- | :----------------------------------------------------------- |
| Promise\<[NetAddress](#netaddress7)> | 以Promise形式返回获取对端socket地址的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
| -------- | ------------------------------- |
| 2303188  | Socket operation on non-socket. |
| 2300002  | System internal error.          |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getRemoteAddress().then(data => {
    console.log('getRemoteAddress success:' + JSON.stringify(data));
  }).catch(err => {
    console.error(err);
  });
});
```

### getRemoteCertificate<sup>10+</sup>

getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): void

在TLSSocketServer通信连接成功之后,获取对端的数字证书,该接口只适用于客户端向服务端发送证书时,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                 |
| -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------- |
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是   | 回调函数,返回对端的证书。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 401      | Parameter error.       |
| 2303501  | SSL is null.           |
| 2300002  | System internal error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getRemoteCertificate((err, data) => {
    if (err) {
      console.log("getRemoteCertificate callback error = " + err);
    } else {
      console.log("getRemoteCertificate callback = " + data);
    }
  });
});
```

### getRemoteCertificate<sup>10+</sup>

getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>

在TLSSocketServer通信连接成功之后,获取对端的数字证书,该接口只适用于客户端向服务端发送证书时,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                                            | 说明                                                         |
| ----------------------------------------------- | ------------------------------------------------------------ |
| Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回对端的数字证书的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 2303501  | SSL is null.           |
| 2300002  | System internal error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getRemoteCertificate().then(data => {
    console.log('getRemoteCertificate success:' + JSON.stringify(data));
  }).catch(err => {
    console.error(err);
  });
});
```

### getCipherSuite<sup>10+</sup>

getCipherSuite(callback: AsyncCallback\<Array\<string\>\>): void

在TLSSocketServer通信连接成功之后,获取通信双方协商后的加密套件,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                             | 必填 | 说明                                                         |
| -------- | -------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<Array\<string\>\> | 是   | 回调函数,返回通信双方支持的加密套件。 失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 401      | Parameter error.                       |
| 2303501  | SSL is null.                           |
| 2303502  | Error in tls reading.                  |
| 2303505  | Error occurred in the tls system call. |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getCipherSuite((err, data) => {
    if (err) {
      console.log("getCipherSuite callback error = " + err);
    } else {
      console.log("getCipherSuite callback = " + data);
    }
  });
});
```

### getCipherSuite<sup>10+</sup>

getCipherSuite(): Promise\<Array\<string\>\>

在TLSSocketServer通信连接成功之后,获取通信双方协商后的加密套件,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                       | 说明                                                         |
| -------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<string\>\> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                               |
| -------- | -------------------------------------- |
| 2303501  | SSL is null.                           |
| 2303502  | Error in tls reading.                  |
| 2303505  | Error occurred in the tls system call. |
| 2300002  | System internal error.                 |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getCipherSuite().then(data => {
    console.log('getCipherSuite success:' + JSON.stringify(data));
  }).catch(err => {
    console.error(err);
  });
});
```

### getSignatureAlgorithms<sup>10+</sup>

getSignatureAlgorithms(callback: AsyncCallback\<Array\<string\>\>): void

在TLSSocketServer通信连接成功之后,获取通信双方协商后签名算法,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                             | 必填 | 说明                               |
| -------- | -------------------------------- | ---- | ---------------------------------- |
| callback | AsyncCallback\<Array\<string\>\> | 是   | 回调函数,返回双方支持的签名算法。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 401      | Parameter error.       |
| 2303501  | SSL is null.           |
| 2300002  | System internal error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getSignatureAlgorithms((err, data) => {
    if (err) {
      console.log("getSignatureAlgorithms callback error = " + err);
    } else {
      console.log("getSignatureAlgorithms callback = " + data);
    }
  });
});
```

### getSignatureAlgorithms<sup>10+</sup>

getSignatureAlgorithms(): Promise\<Array\<string\>\>

在TLSSocketServer通信连接成功之后,获取通信双方协商后的签名算法,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**返回值:**

| 类型                       | 说明                                          |
| -------------------------- | --------------------------------------------- |
| Promise\<Array\<string\>\> | 以Promise形式返回获取到的双方支持的签名算法。 |

**错误码:**

| 错误码ID | 错误信息               |
| -------- | ---------------------- |
| 2303501  | SSL is null.           |
| 2300002  | System internal error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.getSignatureAlgorithms().then(data => {
    console.log("getSignatureAlgorithms success" + data);
  }).catch(err => {
    console.error(err);
  });
});
```

### on('message')<sup>10+</sup>

on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void

订阅TLSSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 是   | 回调函数。                                |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.on('message', value => {
    let messageView = '';
    for (var i = 0; i < value.message.length; i++) {
      let messages = value.message[i]
      let message = String.fromCharCode(messages);
      messageView += message;
    }
    console.log('on message message: ' + JSON.stringify(messageView));
    console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
  });
});
```

### off('message')<sup>10+</sup>

off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void

取消订阅TLSSocketConnection连接的接收消息事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                      |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type     | string                                                       | 是   | 订阅的事件类型。'message':接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo7)}> | 否   | 回调函数。                                |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let callback = value => {
  let messageView = '';
  for (var i = 0; i < value.message.length; i++) {
    let messages = value.message[i]
    let message = String.fromCharCode(messages);
    messageView += message;
  }
  console.log('on message message: ' + JSON.stringify(messageView));
  console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo));
}
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.on('message', callback);
  // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
  client.off('message', callback);
  client.off('message');
});
```

### on('close')<sup>10+</sup>

on(type: 'close', callback: Callback\<void\>): void

订阅TLSSocketConnection的关闭事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型             | 必填 | 说明                                |
| -------- | ---------------- | ---- | ----------------------------------- |
| type     | string           | 是   | 订阅的事件类型。'close':关闭事件。 |
| callback | Callback\<void\> | 是   | 回调函数。                          |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.on('close', () => {
    console.log("on close success")
  });
});
```

### off('close')<sup>10+</sup>

on(type: 'close', callback: Callback\<void\>): void

取消订阅TLSSocketConnection的关闭事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型             | 必填 | 说明                                |
| -------- | ---------------- | ---- | ----------------------------------- |
| type     | string           | 是   | 订阅的事件类型。'close':关闭事件。 |
| callback | Callback\<void\> | 否   | 回调函数。                          |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let callback = () => {
  console.log("on close success");
}
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.on('close', callback);
  // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
  client.off('close', callback);
  client.off('close');
});
```

### on('error')<sup>10+</sup>

on(type: 'error', callback: ErrorCallback): void

订阅TLSSocketConnection连接的error事件。使用callback方式作为异步方法。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.on('error', err => {
    console.log("on error, err:" + JSON.stringify(err))
  });
});
```

### off('error')<sup>10+</sup>

off(type: 'error', callback?: ErrorCallback): void

取消订阅TLSSocketConnection连接的error事件。使用callback方式作为异步方法。

> **说明:**
> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

**系统能力**:SystemCapability.Communication.NetStack

**参数:**

| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |

**错误码:**

| 错误码ID | 错误信息         |
| -------- | ---------------- |
| 401      | Parameter error. |

**示例:**

```js
let callback = err => {
  console.log("on error, err:" + JSON.stringify(err));
}
let tlsServer = socket.constructTLSSocketServerInstance();
tlsServer.on('connect', function(client) {
  client.on('error', callback);
  // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
  client.off('error', callback);
  client.off('error');
});
```