提交 01b7770a 编写于 作者: X xujie

修复网络管理docs问题

Signed-off-by: Nxujie <xujie223@huawei.com>
上级 58e5baca
......@@ -467,7 +467,7 @@ httpRequest.once('headersReceive', (header) => {
| 名称 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| method | [RequestMethod](#requestmethod) | 否 | 请求方式,默认为GET。 |
| extraData | string<sup>6+</sup> \| Object<sup>6+</sup> \| ArrayBuffer<sup>8+</sup> | 否 | 发送请求的额外数据,默认无此字段。<br />- 当HTTP请求为POST、PUT等方法时,此字段为HTTP请求的content,以UTF-8编码形式作为请求体。当'Content-Type'为'application/x-www-form-urlencoded'时,请求提交的信息主体数据应在key和value进行URL转码后按照键值对"key1=value1&key2=value2&key3=value3"的方式进行编码。<sup>6+</sup><br />- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时,此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数,Object类型的参数无需预编码,参数内容会拼接到URL中进行发送;ArrayBuffer类型的参数不会做拼接处理。<sup>6+</sup> |
| extraData | string<sup>6+</sup> \| Object<sup>6+</sup> \| ArrayBuffer<sup>8+</sup> | 否 | 发送请求的额外数据,默认无此字段。<br />- 当HTTP请求为POST、PUT等方法时,此字段为HTTP请求的content,以UTF-8编码形式作为请求体。当'Content-Type'为'application/x-www-form-urlencoded'时,请求提交的信息主体数据应在key和value进行URL转码后按照键值对"key1=value1&key2=value2&key3=value3"的方式进行编码。- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时,此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数,Object类型的参数无需预编码,参数内容会拼接到URL中进行发送;ArrayBuffer类型的参数不会做拼接处理。|
| expectDataType<sup>9+</sup> | [HttpDataType](#httpdatatype9) | 否 | 指定返回数据的类型,默认无此字段。如果设置了此参数,系统将优先返回指定的类型。 |
| usingCache<sup>9+</sup> | boolean | 否 | 是否使用缓存,默认为true。 |
| priority<sup>9+</sup> | number | 否 | 优先级,范围[1,1000],默认是1。 |
......
......@@ -32,11 +32,11 @@ constructUDPSocketInstance(): UDPSocket
let udp = socket.constructUDPSocketInstance();
```
## UDPSocket
## UDPSocket<sup>7+</sup>
UDPSocket连接。在调用UDPSocket的方法前,需要先通过[socket.constructUDPSocketInstance](#socketconstructudpsocketinstance)创建UDPSocket对象。
### bind
### bind<sup>7+</sup>
bind(address: NetAddress, callback: AsyncCallback\<void\>): void
......@@ -76,7 +76,7 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
})
```
### bind
### bind<sup>7+</sup>
bind(address: NetAddress): Promise\<void\>
......@@ -120,7 +120,7 @@ promise.then(() => {
});
```
### send
### send<sup>7+</sup>
send(options: UDPSendOptions, callback: AsyncCallback\<void\>): void
......@@ -166,7 +166,7 @@ udp.send({
})
```
### send
### send<sup>7+</sup>
send(options: UDPSendOptions): Promise\<void\>
......@@ -216,7 +216,7 @@ promise.then(() => {
});
```
### close
### close<sup>7+</sup>
close(callback: AsyncCallback\<void\>): void
......@@ -245,7 +245,7 @@ udp.close(err => {
})
```
### close
### close<sup>7+</sup>
close(): Promise\<void\>
......@@ -273,7 +273,7 @@ promise.then(() => {
});
```
### getState
### getState<sup>7+</sup>
getState(callback: AsyncCallback\<SocketStateBase\>): void
......@@ -318,7 +318,7 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
})
```
### getState
### getState<sup>7+</sup>
getState(): Promise\<SocketStateBase\>
......@@ -357,7 +357,7 @@ promise.then(err => {
});
```
### setExtraOptions
### setExtraOptions<sup>7+</sup>
setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\<void\>): void
......@@ -410,7 +410,7 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
})
```
### setExtraOptions
### setExtraOptions<sup>7+</sup>
setExtraOptions(options: UDPExtraOptions): Promise\<void\>
......@@ -466,7 +466,7 @@ promise.then(() => {
});
```
### on('message')
### on('message')<sup>7+</sup>
on(type: 'message', callback: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
......@@ -490,7 +490,7 @@ udp.on('message', value => {
});
```
### off('message')
### off('message')<sup>7+</sup>
off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
......@@ -521,7 +521,7 @@ udp.off('message', callback);
udp.off('message');
```
### on('listening' | 'close')
### on('listening' | 'close')<sup>7+</sup>
on(type: 'listening' | 'close', callback: Callback\<void\>): void
......@@ -548,7 +548,7 @@ udp.on('close', () => {
});
```
### off('listening' | 'close')
### off('listening' | 'close')<sup>7+</sup>
off(type: 'listening' | 'close', callback?: Callback\<void\>): void
......@@ -586,7 +586,7 @@ udp.off('close', callback2);
udp.off('close');
```
### on('error')
### on('error')<sup>7+</sup>
on(type: 'error', callback: ErrorCallback): void
......@@ -610,7 +610,7 @@ udp.on('error', err => {
});
```
### off('error')
### off('error')<sup>7+</sup>
off(type: 'error', callback?: ErrorCallback): void
......@@ -641,7 +641,7 @@ udp.off('error', callback);
udp.off('error');
```
## NetAddress
## NetAddress<sup>7+</sup>
目标地址信息。
......@@ -653,7 +653,7 @@ udp.off('error');
| port | number | 否 | 端口号 ,范围0~65535。如果不指定系统随机分配端口。 |
| family | number | 否 | 网络协议类型,可选类型:<br />- 1:IPv4<br />- 2:IPv6<br />默认为1。 |
## UDPSendOptions
## UDPSendOptions<sup>7+</sup>
UDPSocket发送参数。
......@@ -664,7 +664,7 @@ UDPSocket发送参数。
| data | string \| ArrayBuffer<sup>7+</sup> | 是 | 发送的数据。 |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息。 |
## UDPExtraOptions
## UDPExtraOptions<sup>7+</sup>
UDPSocket连接的其他属性。
......@@ -678,7 +678,7 @@ UDPSocket连接的其他属性。
| reuseAddress | boolean | 否 | 是否重用地址。默认为false。 |
| socketTimeout | number | 否 | 套接字超时时间,单位毫秒(ms),默认为0。 |
## SocketStateBase
## SocketStateBase<sup>7+</sup>
Socket的状态信息。
......@@ -690,7 +690,7 @@ Socket的状态信息。
| isClose | boolean | 是 | 是否关闭。 |
| isConnected | boolean | 是 | 是否连接。 |
## SocketRemoteInfo
## SocketRemoteInfo<sup>7+</sup>
Socket的连接信息。
......@@ -709,7 +709,7 @@ UDP 其余错误码映射形式为:2301000 + Linux内核错误码。
错误码的详细介绍参见[Socket错误码](../errorcodes/errorcode-net-socket.md)
## socket.constructTCPSocketInstance
## socket.constructTCPSocketInstance<sup>7+</sup>
constructTCPSocketInstance(): TCPSocket
......@@ -729,11 +729,11 @@ constructTCPSocketInstance(): TCPSocket
let tcp = socket.constructTCPSocketInstance();
```
## TCPSocket
## TCPSocket<sup>7+</sup>
TCPSocket连接。在调用TCPSocket的方法前,需要先通过[socket.constructTCPSocketInstance](#socketconstructtcpsocketinstance)创建TCPSocket对象。
### bind
### bind<sup>7+</sup>
bind(address: NetAddress, callback: AsyncCallback\<void\>): void
......@@ -773,7 +773,7 @@ tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
})
```
### bind
### bind<sup>7+</sup>
bind(address: NetAddress): Promise\<void\>
......@@ -817,7 +817,7 @@ promise.then(() => {
});
```
### connect
### connect<sup>7+</sup>
connect(options: TCPConnectOptions, callback: AsyncCallback\<void\>): void
......@@ -857,7 +857,7 @@ tcp.connect({address: {address: '192.168.xx.xxx', port: xxxx, family: 1}, timeou
})
```
### connect
### connect<sup>7+</sup>
connect(options: TCPConnectOptions): Promise\<void\>
......@@ -898,7 +898,7 @@ promise.then(() => {
});
```
### send
### send<sup>7+</sup>
send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void
......@@ -944,7 +944,7 @@ tcp.connect({address: {address: '192.168.xx.xxx', port: xxxx, family: 1}, timeou
})
```
### send
### send<sup>7+</sup>
send(options: TCPSendOptions): Promise\<void\>
......@@ -996,7 +996,7 @@ promise1.then(() => {
});
```
### close
### close<sup>7+</sup>
close(callback: AsyncCallback\<void\>): void
......@@ -1031,7 +1031,7 @@ tcp.close(err => {
})
```
### close
### close<sup>7+</sup>
close(): Promise\<void\>
......@@ -1065,7 +1065,7 @@ promise.then(() => {
});
```
### getRemoteAddress
### getRemoteAddress<sup>7+</sup>
getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
......@@ -1106,7 +1106,7 @@ tcp.connect({address: {address: '192.168.xx.xxx', port: xxxx, family: 1}, timeou
});
```
### getRemoteAddress
### getRemoteAddress<sup>7+</sup>
getRemoteAddress(): Promise\<NetAddress\>
......@@ -1149,7 +1149,7 @@ promise1.then(() => {
});
```
### getState
### getState<sup>7+</sup>
getState(callback: AsyncCallback\<SocketStateBase\>): void
......@@ -1190,7 +1190,7 @@ let promise = tcp.connect({address: {address: '192.168.xx.xxx', port: xxxx, fami
});
```
### getState
### getState<sup>7+</sup>
getState(): Promise\<SocketStateBase\>
......@@ -1233,7 +1233,7 @@ promise.then(() => {
});
```
### setExtraOptions
### setExtraOptions<sup>7+</sup>
setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
......@@ -1285,7 +1285,7 @@ let promise = tcp.connect({address: {address: '192.168.xx.xxx', port: xxxx, fami
});
```
### setExtraOptions
### setExtraOptions<sup>7+</sup>
setExtraOptions(options: TCPExtraOptions): Promise\<void\>
......@@ -1344,7 +1344,7 @@ promise.then(() => {
});
```
### on('message')
### on('message')<sup>7+</sup>
on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
......@@ -1368,7 +1368,7 @@ tcp.on('message', value => {
});
```
### off('message')
### off('message')<sup>7+</sup>
off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
......@@ -1399,7 +1399,7 @@ tcp.off('message', callback);
tcp.off('message');
```
### on('connect' | 'close')
### on('connect' | 'close')<sup>7+</sup>
on(type: 'connect' | 'close', callback: Callback\<void\>): void
......@@ -1426,7 +1426,7 @@ tcp.on('close', data => {
});
```
### off('connect' | 'close')
### off('connect' | 'close')<sup>7+</sup>
off(type: 'connect' | 'close', callback?: Callback\<void\>): void
......@@ -1464,7 +1464,7 @@ tcp.off('close', callback2);
tcp.off('close');
```
### on('error')
### on('error')<sup>7+</sup>
on(type: 'error', callback: ErrorCallback): void
......@@ -1488,7 +1488,7 @@ tcp.on('error', err => {
});
```
### off('error')
### off('error')<sup>7+</sup>
off(type: 'error', callback?: ErrorCallback): void
......@@ -1519,7 +1519,7 @@ tcp.off('error', callback);
tcp.off('error');
```
## TCPConnectOptions
## TCPConnectOptions<sup>7+</sup>
TCPSocket连接的参数。
......@@ -1530,7 +1530,7 @@ TCPSocket连接的参数。
| address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 |
| timeout | number | 否 | 超时时间,单位毫秒(ms)。 |
## TCPSendOptions
## TCPSendOptions<sup>7+</sup>
TCPSocket发送请求的参数。
......@@ -1541,7 +1541,7 @@ TCPSocket发送请求的参数。
| data | string\| ArrayBuffer<sup>7+</sup> | 是 | 发送的数据。 |
| encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |
## TCPExtraOptions
## TCPExtraOptions<sup>7+</sup>
TCPSocket连接的其他属性。
......@@ -1853,7 +1853,7 @@ promise.then(() => {
});
```
### on('message')
### on('message')<sup>9+</sup>
on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void;
......@@ -1884,7 +1884,7 @@ tls.on('message', value => {
});
```
### off('message')
### off('message')<sup>9+</sup>
off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
......@@ -1920,7 +1920,7 @@ tls.on('message', callback);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
tls.off('message', callback);
```
### on('connect' | 'close')
### on('connect' | 'close')<sup>9+</sup>
on(type: 'connect' | 'close', callback: Callback\<void\>): void
......@@ -1947,7 +1947,7 @@ tls.on('close', () => {
});
```
### off('connect' | 'close')
### off('connect' | 'close')<sup>9+</sup>
off(type: 'connect' | 'close', callback?: Callback\<void\>): void
......@@ -1984,7 +1984,7 @@ tls.on('close', callback2);
tls.off('close', callback2);
```
### on('error')
### on('error')<sup>9+</sup>
on(type: 'error', callback: ErrorCallback): void
......@@ -2008,7 +2008,7 @@ tls.on('error', err => {
});
```
### off('error')
### off('error')<sup>9+</sup>
off(type: 'error', callback?: ErrorCallback): void
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册