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

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

C
clevercong 已提交
7
## 导入模块
C
clevercong 已提交
8

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

C
clevercong 已提交
13
## socket.constructUDPSocketInstance
C
clevercong 已提交
14 15 16 17 18

constructUDPSocketInstance\(\): UDPSocket

创建一个UDPSocket对象。

C
clevercong 已提交
19
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
20

C
clevercong 已提交
21
**返回值:**
C
clevercong 已提交
22

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


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

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


C
clevercong 已提交
35
## UDPSocket
C
clevercong 已提交
36

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

C
clevercong 已提交
39
### bind
C
clevercong 已提交
40 41 42 43 44

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

绑定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

C
clevercong 已提交
56
**示例:**
C
clevercong 已提交
57

Z
zengyawen 已提交
58
```js
C
clevercong 已提交
59 60 61 62 63 64 65 66 67
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
	console.log('bind fail');
	return;
  }
  console.log('bind success');
})
```
C
clevercong 已提交
68 69


C
clevercong 已提交
70
### bind
C
clevercong 已提交
71 72 73 74 75

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

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

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

C
clevercong 已提交
78
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
79

C
clevercong 已提交
80
**参数:**
C
clevercong 已提交
81

C
clevercong 已提交
82 83
| 参数名  | 类型                               | 必填 | 说明                                                   |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
C
clevercong 已提交
84
| address | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
C
clevercong 已提交
85 86


C
clevercong 已提交
87
**返回值:**
C
clevercong 已提交
88

C
clevercong 已提交
89 90 91
| 类型            | 说明                                       |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式异步返回UDPSocket绑定的结果。 |
C
clevercong 已提交
92

C
clevercong 已提交
93
**示例:**
C
clevercong 已提交
94

Z
zengyawen 已提交
95
```js
C
clevercong 已提交
96 97 98 99 100 101 102 103
let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address: '192.168.xx.xxx', port: 8080, family: 1});
promise .then(() => {
  console.log('bind success');
}).catch(err => {
  console.log('bind fail');
});
```
C
clevercong 已提交
104 105


C
clevercong 已提交
106
### send
C
clevercong 已提交
107 108 109 110 111

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

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

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

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

C
clevercong 已提交
116
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
117

C
clevercong 已提交
118 119 120 121
**参数:**

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

**示例:**

Z
zengyawen 已提交
127
```js
C
clevercong 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
let udp = socket.constructUDPSocketInstance();
udp.send({
  data:'Hello, server!',
  address: {
	address:'192.168.xx.xxx',
	port:xxxx,
	family:1
  }
}, err=> {
	if (err) {
	  console.log('send fail');
	  return;
	}
	console.log('send success');
})
```
C
clevercong 已提交
144 145


C
clevercong 已提交
146
### send
C
clevercong 已提交
147 148 149 150 151

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

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

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

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

C
clevercong 已提交
156
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
157

C
clevercong 已提交
158
**参数:**
C
clevercong 已提交
159

C
clevercong 已提交
160 161
| 参数名  | 类型                                     | 必填 | 说明                                                         |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
162
| options | [UDPSendOptions](#udpsendoptions) | 是   | UDPSocket发送参数,参考[UDPSendOptions](#udpsendoptions)。 |
C
clevercong 已提交
163

C
clevercong 已提交
164
**返回值:**
C
clevercong 已提交
165

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

C
clevercong 已提交
170
**示例:**
C
clevercong 已提交
171

Z
zengyawen 已提交
172
```js
C
clevercong 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
let udp = socket.constructUDPSocketInstance();
let promise = udp.send({
  data:'Hello, server!',
  address: {
	address:'192.168.xx.xxx',
	port:xxxx,
	family:1
  }
});
promise.then(() => {
  console.log('send success');
}).catch(err => {
  console.log('send fail');
});
```
C
clevercong 已提交
188 189


C
clevercong 已提交
190
### close
C
clevercong 已提交
191 192 193 194 195

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

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

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

C
clevercong 已提交
198
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
199

C
clevercong 已提交
200
**参数:**
C
clevercong 已提交
201

C
clevercong 已提交
202 203 204
| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |
C
clevercong 已提交
205

C
clevercong 已提交
206
**示例:**
C
clevercong 已提交
207

Z
zengyawen 已提交
208
```js
C
clevercong 已提交
209 210 211 212 213 214 215 216 217
let udp = socket.constructUDPSocketInstance();
udp.close(err => {
  if (err) {
	console.log('close fail');
	return;
  }
  console.log('close success');
})
```
C
clevercong 已提交
218 219


C
clevercong 已提交
220
### close
C
clevercong 已提交
221 222 223 224 225

close\(\): Promise<void\>

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

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

C
clevercong 已提交
228
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
229

C
clevercong 已提交
230
**返回值:**
C
clevercong 已提交
231

C
clevercong 已提交
232 233 234
| 类型            | 说明                                       |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭UDPSocket连接的结果。 |
C
clevercong 已提交
235

C
clevercong 已提交
236
**示例:**
C
clevercong 已提交
237

Z
zengyawen 已提交
238
```js
C
clevercong 已提交
239 240 241 242 243 244 245 246
let udp = socket.constructUDPSocketInstance();
let promise = udp.close();
promise.then(() => {
  console.log('close success');
}).catch(err => {
  console.log('close fail');
});
```
C
clevercong 已提交
247 248


C
clevercong 已提交
249
### getState
C
clevercong 已提交
250 251 252 253 254 255

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
256 257 258
>[bind](#bind)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
260
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
261

C
clevercong 已提交
262 263 264 265
**参数:**

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

**示例:**

Z
zengyawen 已提交
270
```js
C
clevercong 已提交
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
	console.log('bind fail');
	return;
  }
  console.log('bind success');
  udp.getState((err, data) => {
	if (err) {
	  console.log('getState fail');
	  return;
	}
	console.log('getState success:' + JSON.stringify(data));
  })
})
```
C
clevercong 已提交
287 288


C
clevercong 已提交
289
### getState
C
clevercong 已提交
290 291 292 293 294 295

getState\(\): Promise<SocketStateBase\>

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
296 297 298
>[bind](#bind)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
300
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
301

C
clevercong 已提交
302
**返回值:**
C
clevercong 已提交
303

C
clevercong 已提交
304 305
| 类型                                             | 说明                                       |
| :----------------------------------------------- | :----------------------------------------- |
C
clevercong 已提交
306
| Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取UDPSocket状态的结果。 |
C
clevercong 已提交
307

C
clevercong 已提交
308
**示例:**
C
clevercong 已提交
309

Z
zengyawen 已提交
310
```js
C
clevercong 已提交
311 312 313 314 315 316 317
let udp = socket.constructUDPSocketInstance();
udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
	console.log('bind fail');
	return;
  }
  console.log('bind success');
Z
zhuwenchao 已提交
318
  let promise = udp.getState();
C
clevercong 已提交
319 320 321 322 323 324 325
  promise.then(data => {
	console.log('getState success:' + JSON.stringify(data));
  }).catch(err => {
	console.log('getState fail');
  });
})
```
C
clevercong 已提交
326 327


C
clevercong 已提交
328
### setExtraOptions
C
clevercong 已提交
329 330 331 332 333 334

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
335 336 337
>[bind](#bind)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
339
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
340

C
clevercong 已提交
341 342 343 344
**参数:**

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


**示例:**

Z
zengyawen 已提交
351
```js
C
clevercong 已提交
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
let udp = socket.constructUDPSocketInstance();
udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1}, err=> {
  if (err) {
	console.log('bind fail');
	return;
  }
  console.log('bind success');
  udp.setExtraOptions({
	receiveBufferSize:1000,
	sendBufferSize:1000,
	reuseAddress:false,
	socketTimeout:6000,
	broadcast:true
  }, err=> {
	if (err) {
	  console.log('setExtraOptions fail');
	  return;
	}
	console.log('setExtraOptions success');
  })
})
```
C
clevercong 已提交
374 375


C
clevercong 已提交
376
### setExtraOptions
C
clevercong 已提交
377 378 379 380 381 382

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
383 384 385
>[bind](#bind)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
387
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
388

C
clevercong 已提交
389 390 391 392
**参数:**

| 参数名  | 类型                                     | 必填 | 说明                                                         |
| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
393
| options | [UDPExtraOptions](#udpextraoptions) | 是   | UDPSocket连接的其他属性,参考[UDPExtraOptions](#udpextraoptions)。 |
C
clevercong 已提交
394 395 396 397 398 399 400 401 402

**返回值:**

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

**示例:**

Z
zengyawen 已提交
403
```js
C
clevercong 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
let udp = socket.constructUDPSocketInstance();
let promise = udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1});
promise.then(() => {
  console.log('bind success');
  let promise1 = udp.setExtraOptions({
	receiveBufferSize:1000,
	sendBufferSize:1000,
	reuseAddress:false,
	socketTimeout:6000,
	broadcast:true
  });
  promise1.then(() => {
	console.log('setExtraOptions success');
  }).catch(err => {
	console.log('setExtraOptions fail');
  });
}).catch(err => {
  console.log('bind fail');
});
```
C
clevercong 已提交
424 425


C
clevercong 已提交
426
### on\('message'\)
C
clevercong 已提交
427 428 429 430 431

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

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

C
clevercong 已提交
432
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
433

C
clevercong 已提交
434
**参数:**
C
clevercong 已提交
435

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

C
clevercong 已提交
441
**示例:**
C
clevercong 已提交
442

Z
zengyawen 已提交
443
```js
C
clevercong 已提交
444 445
let udp = socket.constructUDPSocketInstance();
udp.on('message', value => {
C
clevercong 已提交
446
	console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
C
clevercong 已提交
447 448
});
```
C
clevercong 已提交
449 450


C
clevercong 已提交
451
### off\('message'\)
C
clevercong 已提交
452 453 454 455 456 457 458 459

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

C
clevercong 已提交
460
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
461

C
clevercong 已提交
462
**参数:**
C
clevercong 已提交
463

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

C
clevercong 已提交
469
**示例:**
C
clevercong 已提交
470

Z
zengyawen 已提交
471
```js
C
clevercong 已提交
472 473
let udp = socket.constructUDPSocketInstance();
let callback = value =>{
C
clevercong 已提交
474
	console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
C
clevercong 已提交
475 476 477 478 479 480
}
udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('message', callback);
udp.off('message');
```
C
clevercong 已提交
481 482


C
clevercong 已提交
483
### on\('listening' | 'close'\)
C
clevercong 已提交
484 485 486 487 488

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

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

C
clevercong 已提交
489
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
490

C
clevercong 已提交
491
**参数:**
C
clevercong 已提交
492

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

C
clevercong 已提交
498
**示例:**
C
clevercong 已提交
499

Z
zengyawen 已提交
500
```js
C
clevercong 已提交
501 502
let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => {
C
clevercong 已提交
503
	console.log("on listening success");
C
clevercong 已提交
504 505 506 507 508
});
udp.on('close', () => {
	console.log("on close success" );
});
```
C
clevercong 已提交
509 510


C
clevercong 已提交
511
### off\('listening' | 'close'\)
C
clevercong 已提交
512 513 514 515 516 517 518 519

off\(type: 'listening' | 'close', callback?: Callback<void\>\): void

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

>![](public_sys-resources/icon-note.gif) **说明:** 
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

C
clevercong 已提交
520
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
521

C
clevercong 已提交
522 523 524 525 526 527 528 529 530
**参数:**

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

**示例:**

Z
zengyawen 已提交
531
```js
C
clevercong 已提交
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
let udp = socket.constructUDPSocketInstance();
let callback1 = () =>{
	console.log("on listening, success");
}
udp.on('listening', callback1);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('listening', callback1);
udp.off('listening');
let callback2 = () =>{
	console.log("on close, success");
}
udp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('close', callback2);
udp.off('close');
```
C
clevercong 已提交
548 549


C
clevercong 已提交
550
### on\('error'\)
C
clevercong 已提交
551 552 553 554 555

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

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

C
clevercong 已提交
556
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
557

C
clevercong 已提交
558
**参数:**
C
clevercong 已提交
559

C
clevercong 已提交
560 561 562 563
| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |
C
clevercong 已提交
564 565


C
clevercong 已提交
566
**示例:**
C
clevercong 已提交
567

Z
zengyawen 已提交
568
```js
Z
zengyawen 已提交
569
let udp = socket.constructUDPSocketInstance();
C
clevercong 已提交
570 571 572 573
udp.on('error', err => {
	console.log("on error, err:" + JSON.stringify(err))
});
```
C
clevercong 已提交
574 575


C
clevercong 已提交
576
### off\('error'\)
C
clevercong 已提交
577 578 579 580 581 582 583 584

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

C
clevercong 已提交
585
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
586

C
clevercong 已提交
587
**参数:**
C
clevercong 已提交
588

C
clevercong 已提交
589 590 591 592
| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 否   | 回调函数。                           |
C
clevercong 已提交
593

C
clevercong 已提交
594
**示例:**
C
clevercong 已提交
595

Z
zengyawen 已提交
596
```js
Z
zengyawen 已提交
597
let udp = socket.constructUDPSocketInstance();
C
clevercong 已提交
598 599 600 601 602 603 604 605
let callback = err =>{
	console.log("on error, err:" + JSON.stringify(err));
}
udp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
udp.off('error', callback);
udp.off('error');
```
C
clevercong 已提交
606 607


C
clevercong 已提交
608
## NetAddress
C
clevercong 已提交
609 610 611

目标地址信息。

C
clevercong 已提交
612 613
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

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

C
clevercong 已提交
620
## UDPSendOptions
C
clevercong 已提交
621 622 623

UDPSocket发送参数。

C
clevercong 已提交
624 625
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

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

C
clevercong 已提交
631
## UDPExtraOptions
C
clevercong 已提交
632 633 634

UDPSocket连接的其他属性。

C
clevercong 已提交
635 636
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

L
liyufan 已提交
637
| 名称            | 类型    | 必填 | 说明                             |
C
clevercong 已提交
638 639 640 641 642 643 644
| ----------------- | ------- | ---- | -------------------------------- |
| broadcast         | boolean | 否   | 是否可以发送广播。默认为false。  |
| receiveBufferSize | number  | 否   | 接收缓冲区大小(单位:Byte)。   |
| sendBufferSize    | number  | 否   | 发送缓冲区大小(单位:Byte)。   |
| reuseAddress      | boolean | 否   | 是否重用地址。默认为false。      |
| socketTimeout     | number  | 否   | 套接字超时时间,单位毫秒(ms)。 |

C
clevercong 已提交
645
## SocketStateBase
C
clevercong 已提交
646 647 648

Socket的状态信息。

C
clevercong 已提交
649 650
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

L
liyufan 已提交
651
| 名称      | 类型    | 必填 | 说明       |
C
clevercong 已提交
652 653 654 655 656
| ----------- | ------- | ---- | ---------- |
| isBound     | boolean | 是   | 是否绑定。 |
| isClose     | boolean | 是   | 是否关闭。 |
| isConnected | boolean | 是   | 是否连接。 |

C
clevercong 已提交
657
## SocketRemoteInfo
C
clevercong 已提交
658 659 660

Socket的连接信息。

C
clevercong 已提交
661 662
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

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

Y
Yangys 已提交
670 671 672
## UDP 错误码说明
UDP 错误码映射形式为:2301000 + 内核错误码。

C
clevercong 已提交
673
## socket.constructTCPSocketInstance
C
clevercong 已提交
674 675 676 677 678

constructTCPSocketInstance\(\): TCPSocket

创建一个TCPSocket对象。

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

C
clevercong 已提交
681
**返回值:**
C
clevercong 已提交
682 683 684

  | 类型                               | 说明                    |
  | :--------------------------------- | :---------------------- |
C
clevercong 已提交
685
  | [TCPSocket](#tcpsocket) | 返回一个TCPSocket对象。 |
C
clevercong 已提交
686

C
clevercong 已提交
687
**示例:**
C
clevercong 已提交
688

Z
zengyawen 已提交
689
```js
C
clevercong 已提交
690 691
let tcp = socket.constructTCPSocketInstance();
```
C
clevercong 已提交
692 693


C
clevercong 已提交
694
## TCPSocket
C
clevercong 已提交
695

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

C
clevercong 已提交
698
### bind
C
clevercong 已提交
699 700 701 702 703

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

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

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

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

C
clevercong 已提交
708
**参数:**
C
clevercong 已提交
709

C
clevercong 已提交
710 711
| 参数名   | 类型                               | 必填 | 说明                                                   |
| -------- | ---------------------------------- | ---- | ------------------------------------------------------ |
C
clevercong 已提交
712
| address  | [NetAddress](#netaddress) | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
C
clevercong 已提交
713
| callback | AsyncCallback\<void\>              | 是   | 回调函数。                                             |
C
clevercong 已提交
714 715


C
clevercong 已提交
716
**示例:**
C
clevercong 已提交
717

Z
zengyawen 已提交
718
```js
C
clevercong 已提交
719 720 721 722 723 724 725 726 727
let tcp = socket.constructTCPSocketInstance();
tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
	console.log('bind fail');
	return;
  }
  console.log('bind success');
})
```
C
clevercong 已提交
728 729


C
clevercong 已提交
730
### bind
C
clevercong 已提交
731

C
clevercong 已提交
732
bind\(address: NetAddress\): Promise<void\>
C
clevercong 已提交
733 734 735

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

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

C
clevercong 已提交
738
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
739

C
clevercong 已提交
740
**参数:**
C
clevercong 已提交
741

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

C
clevercong 已提交
746
**返回值:**
C
clevercong 已提交
747

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

C
clevercong 已提交
752
**示例:**
C
clevercong 已提交
753

Z
zengyawen 已提交
754
```js
C
clevercong 已提交
755 756 757 758 759 760 761 762
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1});
promise.then(() => {
  console.log('bind success');
}).catch(err => {
  console.log('bind fail');
});
```
C
clevercong 已提交
763 764


C
clevercong 已提交
765
### connect
C
clevercong 已提交
766 767 768 769 770

connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void

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

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

C
clevercong 已提交
773
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
774

C
clevercong 已提交
775
**参数:**
C
clevercong 已提交
776

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

C
clevercong 已提交
782
**示例:**
C
clevercong 已提交
783

Z
zengyawen 已提交
784
```js
C
clevercong 已提交
785 786 787 788 789 790 791 792 793
let tcp = socket.constructTCPSocketInstance();
tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}, err => {
  if (err) {
	console.log('connect fail');
	return;
  }
  console.log('connect success');
})
```
C
clevercong 已提交
794 795


C
clevercong 已提交
796
### connect
C
clevercong 已提交
797 798 799 800 801

connect\(options: TCPConnectOptions\): Promise<void\>

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

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

C
clevercong 已提交
804
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
805

C
clevercong 已提交
806
**参数:**
C
clevercong 已提交
807

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

C
clevercong 已提交
812
**返回值:**
C
clevercong 已提交
813

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

C
clevercong 已提交
818
**示例:**
C
clevercong 已提交
819

Z
zengyawen 已提交
820
```js
C
clevercong 已提交
821 822 823 824 825 826 827 828
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success')
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
829 830


C
clevercong 已提交
831
### send
C
clevercong 已提交
832 833 834 835 836 837

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
838 839 840
>[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
842
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
843

C
clevercong 已提交
844 845 846 847
**参数:**

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

**示例:**

Z
zengyawen 已提交
853
```js
C
clevercong 已提交
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.send({
	data:'Hello, server!'
  },err => {
	if (err) {
	  console.log('send fail');
	  return;
	}
	console.log('send success');
  })
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
871 872


C
clevercong 已提交
873
### send
C
clevercong 已提交
874 875 876 877 878 879

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
880 881 882
>[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
884
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
885

C
clevercong 已提交
886 887 888 889
**参数:**

| 参数名  | 类型                                    | 必填 | 说明                                                         |
| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
890
| options | [TCPSendOptions](#tcpsendoptions) | 是   | TCPSocket发送请求的参数,参考[TCPSendOptions](#tcpsendoptions)。 |
C
clevercong 已提交
891 892 893 894 895 896 897 898 899

**返回值:**

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

**示例:**

Z
zengyawen 已提交
900
```js
C
clevercong 已提交
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
  console.log('connect success');
  let promise2 = tcp.send({
	data:'Hello, server!'
  });
  promise2.then(() => {
	console.log('send success');
  }).catch(err => {
	console.log('send fail');
  });
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
917 918


C
clevercong 已提交
919
### close
C
clevercong 已提交
920 921 922 923 924

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

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

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

C
clevercong 已提交
927
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
928

C
clevercong 已提交
929
**参数:**
C
clevercong 已提交
930

C
clevercong 已提交
931 932 933
| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |
C
clevercong 已提交
934 935


C
clevercong 已提交
936
**示例:**
C
clevercong 已提交
937

Z
zengyawen 已提交
938
```js
C
clevercong 已提交
939 940 941 942 943 944 945 946 947
let tcp = socket.constructTCPSocketInstance();
tcp.close(err => {
  if (err) {
	console.log('close fail');
	return;
  }
  console.log('close success');
})
```
C
clevercong 已提交
948 949


C
clevercong 已提交
950
### close
C
clevercong 已提交
951 952 953 954 955

close\(\): Promise<void\>

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

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

C
clevercong 已提交
958
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
959

C
clevercong 已提交
960
**返回值:**
C
clevercong 已提交
961

C
clevercong 已提交
962 963 964
| 类型            | 说明                                       |
| :-------------- | :----------------------------------------- |
| Promise\<void\> | 以Promise形式返回关闭TCPSocket连接的结果。 |
C
clevercong 已提交
965

C
clevercong 已提交
966
**示例:**
C
clevercong 已提交
967

Z
zengyawen 已提交
968
```js
C
clevercong 已提交
969 970 971 972 973 974 975 976
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.close();
promise.then(() => {
  console.log('close success');
}).catch(err => {
  console.log('close fail');
});
```
C
clevercong 已提交
977 978


C
clevercong 已提交
979
### getRemoteAddress
C
clevercong 已提交
980 981 982 983 984 985

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
986 987 988
>[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
990
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
991

C
clevercong 已提交
992
**参数:**
C
clevercong 已提交
993

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

C
clevercong 已提交
998
**示例:**
C
clevercong 已提交
999

Z
zengyawen 已提交
1000
```js
C
clevercong 已提交
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.getRemoteAddress((err, data) => {
	if (err) {
	  console.log('getRemoteAddressfail');
	  return;
	}
	console.log('getRemoteAddresssuccess:' + JSON.stringify(data));
  })
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
1016 1017


C
clevercong 已提交
1018
### getRemoteAddress
C
clevercong 已提交
1019 1020 1021 1022 1023 1024

getRemoteAddress\(\): Promise<NetAddress\>

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
1025 1026 1027
>[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
1029
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1030

C
clevercong 已提交
1031
**返回值:**
C
clevercong 已提交
1032

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

C
clevercong 已提交
1037
**示例:**
C
clevercong 已提交
1038

Z
zengyawen 已提交
1039
```js
C
clevercong 已提交
1040 1041 1042 1043 1044 1045
let tcp = socket.constructTCPSocketInstance();
let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise1.then(() => {
  console.log('connect success');
  let promise2 = tcp.getRemoteAddress();
  promise2.then(() => {
F
fuchao 已提交
1046
	console.log('getRemoteAddress success');
C
clevercong 已提交
1047 1048 1049 1050 1051 1052 1053
  }).catch(err => {
	console.log('getRemoteAddressfail');
  });
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
1054 1055


C
clevercong 已提交
1056
### getState
C
clevercong 已提交
1057 1058 1059 1060 1061 1062

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
1063 1064 1065
>[bind](#bind)或[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
1067
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1068

C
clevercong 已提交
1069
**参数:**
C
clevercong 已提交
1070

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


C
clevercong 已提交
1076
**示例:**
C
clevercong 已提交
1077

Z
zengyawen 已提交
1078
```js
C
clevercong 已提交
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.getState((err, data) => {
	if (err) {
	  console.log('getState fail');
	  return;
	}
	console.log('getState success:' + JSON.stringify(data));
  });
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
1094 1095


C
clevercong 已提交
1096
### getState
C
clevercong 已提交
1097 1098 1099 1100 1101 1102

getState\(\): Promise<SocketStateBase\>

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
1103 1104 1105
>[bind](#bind)或[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
1107
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1108

C
clevercong 已提交
1109
**返回值:**
C
clevercong 已提交
1110

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


C
clevercong 已提交
1116
**示例:**
C
clevercong 已提交
1117

Z
zengyawen 已提交
1118
```js
C
clevercong 已提交
1119 1120 1121 1122 1123 1124
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  let promise1 = tcp.getState();
  promise1.then(() => {
F
fuchao 已提交
1125
	console.log('getState success');
C
clevercong 已提交
1126 1127 1128 1129 1130 1131 1132
  }).catch(err => {
	console.log('getState fail');
  });
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
1133 1134


C
clevercong 已提交
1135
### setExtraOptions
C
clevercong 已提交
1136 1137 1138 1139 1140 1141

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
1142 1143 1144
>[bind](#bind)或[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
1146
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1147

C
clevercong 已提交
1148 1149 1150 1151
**参数:**

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

**示例:**

Z
zengyawen 已提交
1157
```js
C
clevercong 已提交
1158 1159 1160 1161 1162 1163 1164 1165
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  tcp.setExtraOptions({
	keepAlive: true,
	OOBInline: true,
	TCPNoDelay: true,
C
clevercong 已提交
1166
	socketLinger: { on:true, linger:10 },
C
clevercong 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
	receiveBufferSize: 1000,
	sendBufferSize: 1000,
	reuseAddress: true,
	socketTimeout: 3000,
  },err => {
	if (err) {
	  console.log('setExtraOptions fail');
	  return;
	}
	console.log('setExtraOptions success');
  });
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
1182 1183


C
clevercong 已提交
1184
### setExtraOptions
C
clevercong 已提交
1185 1186 1187 1188 1189 1190

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
C
clevercong 已提交
1191 1192 1193
>[bind](#bind)或[connect](#connect)方法调用成功后,才可调用此方法。

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

C
clevercong 已提交
1195
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1196

C
clevercong 已提交
1197 1198 1199 1200
**参数:**

| 参数名  | 类型                                      | 必填 | 说明                                                         |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
C
clevercong 已提交
1201
| options | [TCPExtraOptions](#tcpextraoptions) | 是   | TCPSocket连接的其他属性,参考[TCPExtraOptions](#tcpextraoptions)。 |
C
clevercong 已提交
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211

**返回值:**

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


**示例:**

Z
zengyawen 已提交
1212
```js
C
clevercong 已提交
1213 1214 1215 1216 1217 1218 1219 1220
let tcp = socket.constructTCPSocketInstance();
let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000});
promise.then(() => {
  console.log('connect success');
  let promise1 = tcp.setExtraOptions({
	keepAlive: true,
	OOBInline: true,
	TCPNoDelay: true,
C
clevercong 已提交
1221
	socketLinger: { on:true, linger:10 },
C
clevercong 已提交
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
	receiveBufferSize: 1000,
	sendBufferSize: 1000,
	reuseAddress: true,
	socketTimeout: 3000,
  });
  promise1.then(() => {
	console.log('setExtraOptions success');
  }).catch(err => {
	console.log('setExtraOptions fail');
  });
}).catch(err => {
  console.log('connect fail');
});
```
C
clevercong 已提交
1236 1237


C
clevercong 已提交
1238
### on\('message'\)
C
clevercong 已提交
1239 1240 1241 1242 1243

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

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

C
clevercong 已提交
1244
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1245

C
clevercong 已提交
1246
**参数:**
C
clevercong 已提交
1247

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

C
clevercong 已提交
1253
**示例:**
C
clevercong 已提交
1254

Z
zengyawen 已提交
1255
```js
C
clevercong 已提交
1256 1257 1258 1259 1260
let tcp = socket.constructTCPSocketInstance();
tcp.on('message', value => {
	console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo)
});
```
C
clevercong 已提交
1261 1262


C
clevercong 已提交
1263
### off\('message'\)
C
clevercong 已提交
1264 1265 1266 1267 1268 1269 1270 1271

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

C
clevercong 已提交
1272
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1273

C
clevercong 已提交
1274
**参数:**
C
clevercong 已提交
1275

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

C
clevercong 已提交
1281
**示例:**
C
clevercong 已提交
1282

Z
zengyawen 已提交
1283
```js
C
clevercong 已提交
1284 1285 1286 1287 1288 1289 1290 1291 1292
let tcp = socket.constructTCPSocketInstance();
let callback = value =>{
	console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
}
tcp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('message', callback);
tcp.off('message');
```
C
clevercong 已提交
1293 1294


C
clevercong 已提交
1295
### on\('connect' | 'close'\)
C
clevercong 已提交
1296 1297 1298 1299 1300

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

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

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

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

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


C
clevercong 已提交
1311
**示例:**
C
clevercong 已提交
1312

Z
zengyawen 已提交
1313
```js
C
clevercong 已提交
1314 1315 1316 1317 1318 1319 1320 1321
let tcp = socket.constructTCPSocketInstance();
tcp.on('connect', () => {
	console.log("on connect success")
});
tcp.on('close', data => {
	console.log("on close success")
});
```
C
clevercong 已提交
1322 1323


C
clevercong 已提交
1324
### off\('connect' | 'close'\)
C
clevercong 已提交
1325

C
clevercong 已提交
1326
off\(type: 'connect' | 'close', callback?: Callback<void\>\): void
C
clevercong 已提交
1327 1328 1329 1330 1331 1332

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

>![](public_sys-resources/icon-note.gif) **说明:** 
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

C
clevercong 已提交
1333
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1334

C
clevercong 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343
**参数:**

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

**示例:**

Z
zengyawen 已提交
1344
```js
C
clevercong 已提交
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
let tcp = socket.constructTCPSocketInstance();
let callback1 = () =>{
	console.log("on connect success");
}
tcp.on('connect', callback1);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('connect', callback1);
tcp.off('connect');
let callback2 = () =>{
	console.log("on close success");
}
tcp.on('close', callback2);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('close', callback2);
tcp.off('close');
```
C
clevercong 已提交
1361 1362


C
clevercong 已提交
1363
### on\('error'\)
C
clevercong 已提交
1364 1365 1366 1367 1368

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

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

C
clevercong 已提交
1369
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1370

C
clevercong 已提交
1371
**参数:**
C
clevercong 已提交
1372

C
clevercong 已提交
1373 1374 1375 1376
| 参数名   | 类型          | 必填 | 说明                                 |
| -------- | ------------- | ---- | ------------------------------------ |
| type     | string        | 是   | 订阅的事件类型。'error':error事件。 |
| callback | ErrorCallback | 是   | 回调函数。                           |
C
clevercong 已提交
1377

C
clevercong 已提交
1378
**示例:**
C
clevercong 已提交
1379

Z
zengyawen 已提交
1380
```js
C
clevercong 已提交
1381 1382 1383 1384 1385
let tcp = socket.constructTCPSocketInstance();
tcp.on('error', err => {
	console.log("on error, err:" + JSON.stringify(err))
});
```
C
clevercong 已提交
1386 1387


C
clevercong 已提交
1388
### off\('error'\)
C
clevercong 已提交
1389 1390 1391 1392 1393 1394 1395 1396

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

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

>![](public_sys-resources/icon-note.gif) **说明:** 
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。

C
clevercong 已提交
1397
**系统能力**:SystemCapability.Communication.NetStack
C
clevercong 已提交
1398

C
clevercong 已提交
1399 1400 1401 1402 1403 1404 1405 1406 1407
**参数:**

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

**示例:**

Z
zengyawen 已提交
1408
```js
C
clevercong 已提交
1409 1410 1411 1412 1413 1414 1415 1416 1417
let tcp = socket.constructTCPSocketInstance();
let callback = err =>{
	console.log("on error, err:" + JSON.stringify(err));
}
tcp.on('error', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tcp.off('error', callback);
tcp.off('error');
```
C
clevercong 已提交
1418 1419


C
clevercong 已提交
1420
## TCPConnectOptions
C
clevercong 已提交
1421 1422 1423

TCPSocket连接的参数。

C
clevercong 已提交
1424 1425
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

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

C
clevercong 已提交
1431
## TCPSendOptions
C
clevercong 已提交
1432 1433 1434

TCPSocket发送请求的参数。

C
clevercong 已提交
1435 1436
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

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

C
clevercong 已提交
1442
## TCPExtraOptions
C
clevercong 已提交
1443 1444 1445

TCPSocket连接的其他属性。

C
clevercong 已提交
1446 1447
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

L
liyufan 已提交
1448
| 名称            | 类型    | 必填 | 说明                                                         |
C
clevercong 已提交
1449 1450 1451 1452 1453 1454 1455 1456 1457
| ----------------- | ------- | ---- | ------------------------------------------------------------ |
| 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时,才需要设置。 |
| receiveBufferSize | number  | 否   | 接收缓冲区大小(单位:Byte)。                               |
| sendBufferSize    | number  | 否   | 发送缓冲区大小(单位:Byte)。                               |
| reuseAddress      | boolean | 否   | 是否重用地址。默认为false。                                  |
| socketTimeout     | number  | 否   | 套接字超时时间,单位毫秒(ms)。                             |
L
liyufan 已提交
1458

Y
Yangys 已提交
1459 1460 1461
## TCP 错误码说明
TCP 错误码映射形式为:2301000 + 内核错误码。

L
liyufan 已提交
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
## 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>

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

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

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息                 |
L
liyufan 已提交
1506
| ------- | ----------------------- |
L
liyufan 已提交
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
| 401     | Parameter error.        |
| 201     | Permission denied.      |
| 2303198 | Address already in use. |
| 2300002 | System internal error.  |

**示例:**

```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
```

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

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

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

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

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

**参数:**

| 参数名  | 类型                               | 必填 | 说明                                                   |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
L
liyufan 已提交
1538
| address | [NetAddress](#netaddress)          | 是   | 目标地址信息,参考[NetAddress](#netaddress)。 |
L
liyufan 已提交
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息                 |
L
liyufan 已提交
1549
| ------- | ----------------------- |
L
liyufan 已提交
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
| 401     | Parameter error.        |
| 201     | Permission denied.      |
| 2303198 | Address already in use. |
| 2300002 | System internal error.  |

**示例:**

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

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

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

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
1583
| ------- | ------------------------------ |
L
liyufan 已提交
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

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

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

getState\(\): Promise<SocketStateBase\>

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

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

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
1623
| ------- | ------------------------------ |
L
liyufan 已提交
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
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let promise = tls.getState();
promise.then(() => {
  console.log('getState success');
}).catch(err => {
  console.log('getState fail');
});
```

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

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

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
1663
| ------- | -----------------------------  |
L
liyufan 已提交
1664 1665 1666 1667 1668 1669 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 1712 1713 1714 1715 1716 1717 1718 1719
| 401     | Parameter error.               |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});

tls.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>9+</sup>

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

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

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

**参数:**

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

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
1720
| ------- | ------------------------------ |
L
liyufan 已提交
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 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
| 401     | Parameter error.               |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let promise = tls.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');
});
```

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

connect(options: TLSConnectOptions, callback: AsyncCallback\<void>): void

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
1770
| ------- | -------------------------------------------- |
L
liyufan 已提交
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
| 401     | Parameter error.                             |
| 2303104 | Interrupted system call.                     |
| 2303109 | Bad file number.                             |
| 2303111 | Resource temporarily unavailable try again.  |
| 2303113 | System permission denied.                    |
| 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 已提交
1791 1792
let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: xxxx, family: 1}, err => {
L
liyufan 已提交
1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "192.168.xx.xxx",
    port: xxxx,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    passwd: "xxxx",
Y
YOUR_NAME 已提交
1811
    protocols: [socket.Protocol.TLSv12],
L
liyufan 已提交
1812
    useRemoteCipherPrefer: true,
Y
YOUR_NAME 已提交
1813 1814
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
L
liyufan 已提交
1815 1816
  },
};
Y
YOUR_NAME 已提交
1817 1818 1819
tlsTwoWay.connect(options, (err, data) => {
  console.error(err);
  console.log(data);
L
liyufan 已提交
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
});

let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind({address: '192.168.xxx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let oneWayOptions = {
  address: {
    address: "192.168.xxx.xxx",
    port: xxxx,
    family: 1,
  },
  secureOptions: {
    ca: ["xxxx","xxxx"],
Y
YOUR_NAME 已提交
1838
    cipherSuite: "AES256-SHA256",
L
liyufan 已提交
1839 1840
  },
};
Y
YOUR_NAME 已提交
1841 1842 1843
tlsOneWay.connect(oneWayOptions, (err, data) => {
  console.error(err);
  console.log(data);
L
liyufan 已提交
1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869
});
```

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

connect(options: TLSConnectOptions): Promise\<void>

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

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

**参数:**

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

**返回值:**

| 类型                                        | 说明                          |
| ------------------------------------------- | ----------------------------- |
| Promise\<void>                              | 以Promise形式返回,成功无返回,失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
1870
| ------- | -------------------------------------------- |
L
liyufan 已提交
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
| 401     | Parameter error.                             |
| 2303104 | Interrupted system call.                     |
| 2303109 | Bad file number.                             |
| 2303111 | Resource temporarily unavailable try again.  |
| 2303113 | System permission denied.                    |
| 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 已提交
1891 1892
let tlsTwoWay = socket.constructTLSSocketInstance(); // Two way authentication
tlsTwoWay.bind({address: '192.168.xxx.xxx', port: xxxx, family: 1}, err => {
L
liyufan 已提交
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let options = {
  ALPNProtocols: ["spdy/1", "http/1.1"],
  address: {
    address: "xxxx",
    port: xxxx,
    family: 1,
  },
  secureOptions: {
    key: "xxxx",
    cert: "xxxx",
    ca: ["xxxx"],
    passwd: "xxxx",
Y
YOUR_NAME 已提交
1911
    protocols: [socket.Protocol.TLSv12],
L
liyufan 已提交
1912
    useRemoteCipherPrefer: true,
Y
YOUR_NAME 已提交
1913 1914
    signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",
    cipherSuite: "AES256-SHA256",
L
liyufan 已提交
1915 1916
  },
};
Y
YOUR_NAME 已提交
1917 1918
tlsTwoWay.connect(options).then(data => {
  console.log(data);
L
liyufan 已提交
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938
}).catch(err => {
  console.error(err);
});

let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
tlsOneWay.bind({address: '192.168.xxx.xxx', port: xxxx, family: 1}, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
});
let oneWayOptions = {
  address: {
    address: "192.168.xxx.xxx",
    port: xxxx,
    family: 1,
  },
  secureOptions: {
    ca: ["xxxx","xxxx"],
Y
YOUR_NAME 已提交
1939
    cipherSuite: "AES256-SHA256",
L
liyufan 已提交
1940 1941 1942
  },
};
tlsOneWay.connect(oneWayOptions).then(data => {
Y
YOUR_NAME 已提交
1943
  console.log(data);
L
liyufan 已提交
1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
}).catch(err => {
  console.error(err);
});
```

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

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

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

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

**参数:**

| 参数名   | 类型                                              | 必填 | 说明       |
| -------- | ------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<[NetAddress](#netaddress)> | 是   | 回调函数。成功返回对端的socket地址,失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
1966
| ------- | -----------------------------  |
L
liyufan 已提交
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
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
tls.getRemoteAddress((err, data) => {
  if (err) {
    console.log('getRemoteAddress fail');
    return;
  }
  console.log('getRemoteAddress success:' + JSON.stringify(data));
});
```

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

getRemoteAddress\(\): Promise\<NetAddress>

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

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

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
1999
| ------- | ------------------------------ |
L
liyufan 已提交
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
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error.         |

**示例:**

```js
let promise = tls.getRemoteAddress();
promise.then(() => {
  console.log('getRemoteAddress success');
}).catch(err => {
  console.log('getRemoteAddress fail');
});
```

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

getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>): void

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

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

**参数:**

| 参数名   | 类型                                   | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)>    | 是   | 回调函数,成功返回本地的证书,失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
2031
| ------- | ------------------------------ |
L
liyufan 已提交
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
| 2303501 | SSL is null.                   |
| 2303504 | Error looking up x509.         |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getCertificate((err, data) => {
  if (err) {
    console.log("getCertificate callback error = " + err);
  } else {
    console.log("getCertificate callback = " + data);
  }
});
```

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

getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)>

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

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

**返回值:**

| 类型            | 说明                  |
| -------------- | -------------------- |
| Promise\<[X509CertRawData](#x509certrawdata9)> | 以Promise形式返回本地的数字证书的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
Y
YOUR_NAME 已提交
2065
| ------- | ------------------------------ |
L
liyufan 已提交
2066 2067 2068 2069 2070 2071 2072 2073
| 2303501 | SSL is null.                   |
| 2303504 | Error looking up x509.         |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getCertificate().then(data => {
Y
YOUR_NAME 已提交
2074
  console.log(data);
L
liyufan 已提交
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
}).catch(err => {
  console.error(err);
});
```

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

getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>): void

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

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

**参数:**

| 参数名    | 类型                                    | 必填  | 说明           |
| -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)>  | 是   | 回调函数,返回服务端的证书。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2097
| ------- | ------------------------------ |
L
liyufan 已提交
2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getRemoteCertificate((err, data) => {
  if (err) {
    console.log("getRemoteCertificate callback error = " + err);
  } else {
    console.log("getRemoteCertificate callback = " + data);
  }
});
```

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

getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)>

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

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

**返回值:**

| 类型            | 说明                  |
| -------------- | -------------------- |
| Promise\<[X509CertRawData](#x509certrawdata9)> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2130
| ------- | ------------------------------ |
L
liyufan 已提交
2131 2132 2133 2134 2135 2136 2137
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getRemoteCertificate().then(data => {
Y
YOUR_NAME 已提交
2138
  console.log(data);
L
liyufan 已提交
2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
}).catch(err => {
  console.error(err);
});
```

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

getProtocol(callback: AsyncCallback\<string>): void

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

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

**参数:**

| 参数名   | 类型                                       | 必填 | 说明           |
| -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<string>                  | 是   | 回调函数,返回通信的协议。失败返回错误码,错误信息。|

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2161
| ------- | -----------------------------  |
L
liyufan 已提交
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
| 2303501 | SSL is null.                   |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getProtocol((err, data) => {
  if (err) {
    console.log("getProtocol callback error = " + err);
  } else {
    console.log("getProtocol callback = " + data);
  }
});
```

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

getProtocol():Promise\<string>

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

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

**返回值:**

| 类型            | 说明                  |
| -------------- | -------------------- |
| Promise\<string> | 以Promise形式返回通信的协议。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2195
| ------- | ------------------------------ |
L
liyufan 已提交
2196 2197 2198 2199 2200 2201 2202 2203
| 2303501 | SSL is null.                   |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getProtocol().then(data => {
Y
YOUR_NAME 已提交
2204
  console.log(data);
L
liyufan 已提交
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
}).catch(err => {
  console.error(err);
});
```

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

getCipherSuite(callback: AsyncCallback\<Array\<string>>): void

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

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

**参数:**

| 参数名   | 类型                                     | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<Array\<string>>          | 是   | 回调函数,返回通信双方支持的加密套件。 失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2227
| ------- | ------------------------------ |
L
liyufan 已提交
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
| 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) => {
  if (err) {
    console.log("getCipherSuite callback error = " + err);
  } else {
    console.log("getCipherSuite callback = " + data);
  }
});
```

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

getCipherSuite(): Promise\<Array\<string>>

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

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

**返回值:**

| 类型                    | 说明                  |
| ---------------------- | --------------------- |
| Promise\<Array\<string>> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2262
| ------- | ------------------------------ |
L
liyufan 已提交
2263 2264 2265 2266 2267 2268 2269 2270 2271
| 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
YOUR_NAME 已提交
2272
  console.log(data);
L
liyufan 已提交
2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294
}).catch(err => {
  console.error(err);
});
```

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

getSignatureAlgorithms(callback: AsyncCallback\<Array\<string>>): void

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

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

**参数:**

| 参数名   | 类型                                   | 必填 | 说明            |
| -------- | -------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<Array\<string>>         | 是   | 回调函数,返回双方支持的签名算法。  |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2295
| ------- | ------------------------------ |
L
liyufan 已提交
2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getSignatureAlgorithms((err, data) => {
  if (err) {
    console.log("getSignatureAlgorithms callback error = " + err);
  } else {
    console.log("getSignatureAlgorithms callback = " + data);
  }
});
```

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

getSignatureAlgorithms(): Promise\<Array\<string>>

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

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

**返回值:**

| 类型                    | 说明                  |
| ---------------------- | -------------------- |
| Promise\<Array\<string>> | 以Promise形式返回获取到的双方支持的签名算法。 |

**错误码:**

| 错误码ID | 错误信息                        |
L
liyufan 已提交
2328
| ------- | ------------------------------ |
L
liyufan 已提交
2329 2330 2331 2332 2333 2334 2335
| 2303501 | SSL is null.                   |
| 2300002 | System internal error.         |

**示例:**

```js
tls.getSignatureAlgorithms().then(data => {
Y
YOUR_NAME 已提交
2336
  console.log(data);
L
liyufan 已提交
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
}).catch(err => {
  console.error(err);
});
```

### send<sup>9+</sup>

send(data: string, callback: AsyncCallback\<void>): void

在TLSSocket通信连接成功之后,向服务端发送消息,使用callback方式作为异步方法。

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

**参数:**

| 参数名    | 类型                          | 必填 | 说明            |
| -------- | -----------------------------| ---- | ---------------|
|   data   | string                       | 是   | 发送的数据内容。   |
| callback | AsyncCallback\<void>         | 是   | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
2360
| ------- | -------------------------------------------- |
L
liyufan 已提交
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
| 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
tls.send("xxxx", (err) => {
  if (err) {
    console.log("send callback error = " + err);
  } else {
    console.log("send success");
  }
});
```

### send<sup>9+</sup>

send(data: string): Promise\<void>

在TLSSocket通信连接成功之后,向服务端发送消息,使用Promise方式作为异步方法。

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

**参数:**

| 参数名    | 类型                          | 必填 | 说明            |
| -------- | -----------------------------| ---- | ---------------|
|   data   | string                       | 是   | 发送的数据内容。   |

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
2397
| ------- | -------------------------------------------- |
L
liyufan 已提交
2398 2399 2400 2401 2402 2403 2404 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
| 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.                       |

**返回值:**

| 类型           | 说明                  |
| -------------- | -------------------- |
| Promise\<void> | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码,错误信息。 |

**示例:**

```js
tls.send("xxxx").then(() =>{
  console.log("send success");
}).catch(err => {
  console.error(err);
});
```

### close<sup>9+</sup>

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

在TLSSocket通信连接成功之后,断开连接,使用callback方式作为异步方法。

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

**参数:**

| 参数名    | 类型                          | 必填 | 说明            |
| -------- | -----------------------------| ---- | ---------------|
| callback | AsyncCallback\<void>         | 是   | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
2438
| ------- | -------------------------------------------- |
L
liyufan 已提交
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
| 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) => {
  if (err) {
    console.log("close callback error = " + err);
  } else {
    console.log("close success");
  }
});
```

### close<sup>9+</sup>

close(): Promise\<void>

在TLSSocket通信连接成功之后,断开连接,使用Promise方式作为异步方法。

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

**返回值:**

| 类型           | 说明                  |
| -------------- | -------------------- |
| Promise\<void> | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码,错误信息。 |

**错误码:**

| 错误码ID | 错误信息                                      |
L
liyufan 已提交
2473
| ------- | -------------------------------------------- |
L
liyufan 已提交
2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
| 2303501 | SSL is null.                                 |
| 2303505 | Error occurred in the tls system call.       |
| 2303506 | Error clearing tls connection.               |
| 2300002 | System internal error.                       |

**示例:**

```js
tls.close().then(() =>{
  console.log("close success");
}).catch(err => {
  console.error(err);
});
```

## TLSConnectOptions<sup>9+</sup>

TLS连接的操作。

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

L
liyufan 已提交
2495 2496 2497 2498
| 名称          | 类型                                     | 必填 | 说明            |
| -------------- | ------------------------------------- | ---  |-------------- |
| address        | [NetAddress](#netaddress)             | 是  |  网关地址。       |
| secureOptions  | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。|
Y
YOUR_NAME 已提交
2499
| ALPNProtocols  | Array\<string>                         | 否 | ALPN协议。      |
L
liyufan 已提交
2500 2501 2502 2503 2504 2505 2506

## TLSSecureOptions<sup>9+</sup>

TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参数。当本地证书cert和私钥key不为空时,开启双向验证模式。cert和key其中一项为空时,开启单向验证模式。

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

L
liyufan 已提交
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516
| 名称                 | 类型                                                    | 必填 | 说明                                |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- |
| ca                    | string \| Array\<string>                               | 是 | 服务端的ca证书,用于认证校验服务端的数字证书。|
| cert                  | string                                                  | 否 | 本地客户端的数字证书。                 |
| key                   | string                                                  | 否 | 本地数字证书的私钥。                   |
| passwd                | string                                                  | 否 | 读取私钥的密码。                      |
| protocols             | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)> | 否 | TLS的协议版本。                  |
| useRemoteCipherPrefer | boolean                                                 | 否 | 优先使用对等方的密码套件。          |
| signatureAlgorithms   | string                                                 | 否 | 通信过程中的签名算法。               |
| cipherSuite           | string                                                 | 否 | 通信过程中的加密套件。               |
L
liyufan 已提交
2517 2518 2519 2520 2521 2522 2523

## Protocol<sup>9+</sup>

TLS通信的协议版本。

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

L
liyufan 已提交
2524 2525 2526 2527
| 名称      |    值    | 说明                |
| --------- | --------- |------------------ |
| TLSv12    | "TLSv1.2" | 使用TLSv1.2协议通信。 |
| TLSv13    | "TLSv1.3" | 使用TLSv1.3协议通信。 |
L
liyufan 已提交
2528 2529 2530 2531 2532 2533 2534

## X509CertRawData<sup>9+</sup>

存储证书的数据。

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

L
liyufan 已提交
2535 2536
| 类型                                                                   | 说明                   |
| --------------------------------------------------------------------- | --------------------- |
Z
zhanghaifeng 已提交
2537
|[cryptoFramework.EncodingBlob](js-apis-cryptoFramework.md#datablob) | 存储证书的数据和编码格式 |