From 701f216eb7c1185788b2f5713bf8d665f91403ba Mon Sep 17 00:00:00 2001 From: clevercong Date: Fri, 4 Mar 2022 17:49:45 +0800 Subject: [PATCH] format files. Signed-off-by: clevercong --- .../reference/apis/js-apis-http.md | 345 ++-- .../reference/apis/js-apis-socket.md | 1496 ++++++++--------- .../reference/apis/js-apis-webSocket.md | 520 +++--- 3 files changed, 1180 insertions(+), 1181 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-http.md b/zh-cn/application-dev/reference/apis/js-apis-http.md index ff82b65406..d330766001 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-http.md +++ b/zh-cn/application-dev/reference/apis/js-apis-http.md @@ -86,18 +86,18 @@ createHttp\(\): HttpRequest 创建一个http,里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header 事件。每一个HttpRequest对象对应一个Http请求。如需发起多个Http请求,须为每个Http请求创建对应HttpRequest对象。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :---------- | :----------------------------------------------------------- | - | HttpRequest | 返回一个HttpRequest对象,里面包括request、destroy、on和off方法。 | - -- 示例 +| 类型 | 说明 | +| :---------- | :----------------------------------------------------------- | +| HttpRequest | 返回一个HttpRequest对象,里面包括request、destroy、on和off方法。 | - ``` - import http from '@ohos.net.http'; - let httpRequest = http.createHttp(); - ``` +**示例:** + +``` +import http from '@ohos.net.http'; +let httpRequest = http.createHttp(); +``` ## HttpRequest @@ -110,29 +110,28 @@ request\(url: string, callback: AsyncCallback\\):void 根据URL地址,发起HTTP网络请求,使用callback方式作为异步方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------- | ---- | ----------------------- | - | url | string | 是 | 发起网络请求的URL地址。 | - | callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 | +**参数:** -- 示例 +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | ----------------------- | +| url | string | 是 | 发起网络请求的URL地址。 | +| callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 | - ``` - let httpRequest = http.createHttp(); - httpRequest.request("EXAMPLE_URL", (err, data) => { - if (!err) { - console.info('Result:' + data.result); - console.info('code:' + data.responseCode); - console.info('header:' + data.header); - console.info('cookies:' + data.cookies); // 8+ - } else { - console.info('error:' + err.data); - } - }); - ``` +**示例:** +``` +let httpRequest = http.createHttp(); +httpRequest.request("EXAMPLE_URL", (err, data) => { + if (!err) { + console.info('Result:' + data.result); + console.info('code:' + data.responseCode); + console.info('header:' + data.header); + console.info('cookies:' + data.cookies); // 8+ + } else { + console.info('error:' + err.data); + } +}); +``` ### request @@ -140,41 +139,41 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | -------------------------------------------------- | +| url | string | 是 | 发起网络请求的URL地址。 | +| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 | +| callback | AsyncCallback\<[HttpResponse](#section12262183471518)\> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let httpRequest= http.createHttp(); - httpRequest.request("EXAMPLE_URL", - { - method: 'GET', - header: { - 'Content-Type': 'application/json' - }, - readTimeout: 60000, - connectTimeout: 60000 - },(err, data) => { - if (!err) { - console.info('Result:' + data.result); - console.info('code:' + data.responseCode); - console.info('header:' + data.header); - console.info('cookies:' + data.cookies); // 8+ - console.info('header['Content-Type']:' + data.header['Content-Type']); - console.info('header['Status-Line']:' + data.header['Status-Line']); - console.info('header.Date:' + data.header.Date); - console.info('header.Server:' + data.header.Server); - } else { - console.info('error:' + err.data); - } - }); - ``` +``` +let httpRequest= http.createHttp(); +httpRequest.request("EXAMPLE_URL", +{ + method: 'GET', + header: { + 'Content-Type': 'application/json' + }, + readTimeout: 60000, + connectTimeout: 60000 +},(err, data) => { + if (!err) { + console.info('Result:' + data.result); + console.info('code:' + data.responseCode); + console.info('header:' + data.header); + console.info('cookies:' + data.cookies); // 8+ + console.info('header['Content-Type']:' + data.header['Content-Type']); + console.info('header['Status-Line']:' + data.header['Status-Line']); + console.info('header.Date:' + data.header.Date); + console.info('header.Server:' + data.header.Server); + } else { + console.info('error:' + err.data); + } +}); +``` ### request @@ -183,46 +182,45 @@ request\(url: string, options? : HttpRequestOptions\): Promise 根据URL地址,发起HTTP网络请求,使用Promise方式作为异步方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------------------ | ---- | -------------------------------------------------- | - | url | string | 是 | 发起网络请求的URL地址。 | - | options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 | - -- 返回值 - - | 类型 | 说明 | - | :-------------------- | :-------------------------------- | - | Promise<[HttpResponse](#section12262183471518)> | 以Promise形式返回发起请求的结果。 | - - -- 示例 - - ``` - let httpRequest= http.createHttp(); - let promise = httpRequest.request("EXAMPLE_URL", { - method: "GET", - connectTimeout: 60000, - readTimeout: 60000, - header: { - 'Content-Type': 'application/json' - } - }); - promise.then((value) => { - console.info('Result:' + value.result); - console.info('code:' + value.responseCode); - console.info('header:' + value.header); - console.info('cookies:' + value.cookies); // 8+ - console.info('header['Content-Type']:' + value.header['Content-Type']); - console.info('header['Status-Line']:' + value.header['Status-Line']); - console.info('header.Date:' + value.header.Date); - console.info('header.Server:' + value.header.Server); - }).catch((err) => { - console.error(`errCode:${err.code}, errMessage:${err.data}`); - }); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------------------ | ---- | -------------------------------------------------- | +| url | string | 是 | 发起网络请求的URL地址。 | +| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#section12262183471518)。 | +**返回值:** + +| 类型 | 说明 | +| :-------------------- | :-------------------------------- | +| Promise<[HttpResponse](#section12262183471518)> | 以Promise形式返回发起请求的结果。 | + + +**示例:** + +``` +let httpRequest= http.createHttp(); +let promise = httpRequest.request("EXAMPLE_URL", { + method: "GET", + connectTimeout: 60000, + readTimeout: 60000, + header: { + 'Content-Type': 'application/json' + } +}); +promise.then((value) => { + console.info('Result:' + value.result); + console.info('code:' + value.responseCode); + console.info('header:' + value.header); + console.info('cookies:' + value.cookies); // 8+ + console.info('header['Content-Type']:' + value.header['Content-Type']); + console.info('header['Status-Line']:' + value.header['Status-Line']); + console.info('header.Date:' + value.header.Date); + console.info('header.Server:' + value.header.Server); +}).catch((err) => { + console.error(`errCode:${err.code}, errMessage:${err.data}`); +}); +``` ### destroy @@ -230,13 +228,12 @@ destroy\(\): void 中断请求任务。 -- 示例 - - ``` - let httpRequest= http.createHttp(); - httpRequest.destroy(); - ``` +**示例:** +``` +let httpRequest= http.createHttp(); +httpRequest.destroy(); +``` ### on\('headerReceive'\) @@ -247,25 +244,25 @@ on\(type: 'headerReceive', callback: AsyncCallback\):void >![](public_sys-resources/icon-note.gif) **说明:** > 此接口已废弃,建议使用on\('headersReceive'\)替代。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------- | ---- | ------------------------------------- | - | type | string | 是 | 订阅的事件类型,如:'headerReceive'。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------- | +| type | string | 是 | 订阅的事件类型,如:'headerReceive'。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let httpRequest= http.createHttp(); - httpRequest.on('headerReceive', (err, data) => { - if (!err) { - console.info('header: ' + data.header); - } else { - console.info('error:' + err.data); - } - }); - ``` +``` +let httpRequest= http.createHttp(); +httpRequest.on('headerReceive', (err, data) => { + if (!err) { + console.info('header: ' + data.header); + } else { + console.info('error:' + err.data); + } +}); +``` ### off\('headerReceive'\) @@ -280,26 +277,26 @@ off\(type: 'headerReceive', callback?: AsyncCallback\):void > >2. 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------- | ---- | ------------------------------------- | - | type | string | 是 | 取消订阅的事件类型,'headerReceive'。 | - | callback | AsyncCallback\ | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ------------------------------------- | +| type | string | 是 | 取消订阅的事件类型,'headerReceive'。 | +| callback | AsyncCallback\ | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let httpRequest= http.createHttp(); - httpRequest.on('headerReceive', (err, data) => { - if (!err) { - console.info('header: ' + data.header); - } else { - console.info('error:' + err.data); - } - }); - httpRequest.off('headerReceive'); - ``` +``` +let httpRequest= http.createHttp(); +httpRequest.on('headerReceive', (err, data) => { + if (!err) { + console.info('header: ' + data.header); + } else { + console.info('error:' + err.data); + } +}); +httpRequest.off('headerReceive'); +``` ### on\('headersReceive'\)8+ @@ -307,21 +304,21 @@ on\(type: 'headersReceive', callback: Callback\):void 订阅HTTP Response Header 事件。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------ | ---- | ---------------------------------- | - | type | string | 是 | 订阅的事件类型:'headersReceive'。 | - | callback | Callback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------ | ---- | ---------------------------------- | +| type | string | 是 | 订阅的事件类型:'headersReceive'。 | +| callback | Callback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let httpRequest= http.createHttp(); - httpRequest.on('headersReceive', (data) => { - console.info('header: ' + data.header); - }); - ``` +``` +let httpRequest= http.createHttp(); +httpRequest.on('headersReceive', (data) => { + console.info('header: ' + data.header); +}); +``` ### off\('headersReceive'\)8+ @@ -333,19 +330,19 @@ off\(type: 'headersReceive', callback?: Callback\):void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------ | ---- | -------------------------------------- | - | type | string | 是 | 取消订阅的事件类型:'headersReceive'。 | - | callback | Callback\ | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------ | ---- | -------------------------------------- | +| type | string | 是 | 取消订阅的事件类型:'headersReceive'。 | +| callback | Callback\ | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let httpRequest= http.createHttp(); - httpRequest.off('headersReceive'); - ``` +``` +let httpRequest= http.createHttp(); +httpRequest.off('headersReceive'); +``` ### once\('headersReceive'\)8+ @@ -353,21 +350,21 @@ once\(type: "headersReceive", callback: Callback\): void 订阅HTTP Response Header 事件,但是只触发一次。一旦触发之后,订阅器就会被移除。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------ | ---- | ---------------------------------- | - | type | string | 是 | 订阅的事件类型:'headersReceive'。 | - | callback | Callback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------ | ---- | ---------------------------------- | +| type | string | 是 | 订阅的事件类型:'headersReceive'。 | +| callback | Callback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let httpRequest= http.createHttp(); - httpRequest.once('headersReceive', (data) => { - console.info('header: ' + data.header); - }); - ``` +``` +let httpRequest= http.createHttp(); +httpRequest.once('headersReceive', (data) => { + console.info('header: ' + data.header); +}); +``` ## HttpRequestOptions diff --git a/zh-cn/application-dev/reference/apis/js-apis-socket.md b/zh-cn/application-dev/reference/apis/js-apis-socket.md index b9e682ac88..81a20ed2dd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-socket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-socket.md @@ -75,18 +75,18 @@ constructUDPSocketInstance\(\): UDPSocket 创建一个UDPSocket对象。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :--------------------------------- | :---------------------- | - | [UDPSocket](#section1957294511568) | 返回一个UDPSocket对象。 | +| 类型 | 说明 | +| :--------------------------------- | :---------------------- | +| [UDPSocket](#section1957294511568) | 返回一个UDPSocket对象。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - ``` +``` +let udp = socket.constructUDPSocketInstance(); +``` ## UDPSocket @@ -99,25 +99,25 @@ bind\(address: NetAddress, callback: AsyncCallback\): void 绑定IP地址和端口,端口可以指定或由系统随机分配。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | ------------------------------------------------------ | - | address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | +| address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - 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'); - }) - ``` +``` +let udp = socket.constructUDPSocketInstance(); +udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { + if (err) { + console.log('bind fail'); + return; + } + console.log('bind success'); +}) +``` ### bind @@ -126,30 +126,30 @@ bind\(address: NetAddress\): Promise 绑定IP地址和端口,端口可以指定或由系统随机分配。使用Promise方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ---------------------------------- | ---- | ------------------------------------------------------ | - | address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | +| address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :-------------- | :----------------------------------------- | - | Promise\ | 以Promise形式异步返回UDPSocket绑定的结果。 | +| 类型 | 说明 | +| :-------------- | :----------------------------------------- | +| Promise\ | 以Promise形式异步返回UDPSocket绑定的结果。 | -- 示例 +**示例:** - ``` - 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'); - }); - ``` +``` +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'); +}); +``` ### send @@ -158,32 +158,32 @@ send\(options: UDPSendOptions, callback: AsyncCallback\): void 通过UDPSocket连接发送数据。使用callback方式作为异步方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#section13297558184010)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | - -- 示例 - - ``` - 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'); - }) - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#section13297558184010)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例:** + +``` +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'); +}) +``` ### send @@ -192,36 +192,36 @@ send\(options: UDPSendOptions\): Promise 通过UDPSocket连接发送数据。使用Promise方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#section13297558184010)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [UDPSendOptions](#section13297558184010) | 是 | UDPSocket发送参数,参考[UDPSendOptions](#section13297558184010)。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :-------------- | :--------------------------------------------- | - | Promise\ | 以Promise形式返回UDPSocket连接发送数据的结果。 | +| 类型 | 说明 | +| :-------------- | :--------------------------------------------- | +| Promise\ | 以Promise形式返回UDPSocket连接发送数据的结果。 | -- 示例 +**示例:** - ``` - 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'); - }); - ``` +``` +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'); +}); +``` ### close @@ -230,24 +230,24 @@ close\(callback: AsyncCallback\): void 关闭UDPSocket连接。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------- | ---- | ---------- | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | ---------- | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - udp.close(err => { - if (err) { - console.log('close fail'); - return; - } - console.log('close success'); - }) - ``` +``` +let udp = socket.constructUDPSocketInstance(); +udp.close(err => { + if (err) { + console.log('close fail'); + return; + } + console.log('close success'); +}) +``` ### close @@ -256,23 +256,23 @@ close\(\): Promise 关闭UDPSocket连接。使用Promise方式作为异步方法。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :-------------- | :----------------------------------------- | - | Promise\ | 以Promise形式返回关闭UDPSocket连接的结果。 | +| 类型 | 说明 | +| :-------------- | :----------------------------------------- | +| Promise\ | 以Promise形式返回关闭UDPSocket连接的结果。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - let promise = udp.close(); - promise.then(() => { - console.log('close success'); - }).catch(err => { - console.log('close fail'); - }); - ``` +``` +let udp = socket.constructUDPSocketInstance(); +let promise = udp.close(); +promise.then(() => { + console.log('close success'); +}).catch(err => { + console.log('close fail'); +}); +``` ### getState @@ -284,31 +284,31 @@ getState\(callback: AsyncCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section7382103811272)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------ | ---- | ---------- | - | callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 | - -- 示例 - - ``` - 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)); - }) - }) - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------ | ---- | ---------- | +| callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 | + +**示例:** + +``` +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)); + }) +}) +``` ### getState @@ -320,30 +320,30 @@ getState\(\): Promise >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section7382103811272)方法调用成功后,才可调用此方法。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :----------------------------------------------- | :----------------------------------------- | - | Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取UDPSocket状态的结果。 | +| 类型 | 说明 | +| :----------------------------------------------- | :----------------------------------------- | +| Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取UDPSocket状态的结果。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { - if (err) { - console.log('bind fail'); - return; - } - console.log('bind success'); - let promise = udp.getState({}); - promise.then(data => { - console.log('getState success:' + JSON.stringify(data)); - }).catch(err => { - console.log('getState fail'); - }); - }) - ``` +``` +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'); + let promise = udp.getState({}); + promise.then(data => { + console.log('getState success:' + JSON.stringify(data)); + }).catch(err => { + console.log('getState fail'); + }); +}) +``` ### setExtraOptions @@ -355,39 +355,39 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback\): voi >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section7382103811272)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#section1650575184117)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | - - -- 示例 - - ``` - 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'); - }) - }) - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#section1650575184117)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + + +**示例:** + +``` +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'); + }) +}) +``` ### setExtraOptions @@ -399,41 +399,41 @@ setExtraOptions\(options: UDPExtraOptions\): Promise >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section7382103811272)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#section1650575184117)。 | - -- 返回值 - - | 类型 | 说明 | - | :-------------- | :--------------------------------------------------- | - | Promise\ | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 | - -- 示例 - - ``` - 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'); - }); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [UDPExtraOptions](#section1650575184117) | 是 | UDPSocket连接的其他属性,参考[UDPExtraOptions](#section1650575184117)。 | + +**返回值:** + +| 类型 | 说明 | +| :-------------- | :--------------------------------------------------- | +| Promise\ | 以Promise形式返回设置UDPSocket连接的其他属性的结果。 | + +**示例:** + +``` +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'); +}); +``` ### on\('message'\) @@ -442,21 +442,21 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock 订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | - | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | - | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - udp.on('message', value => { - console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo); - }); - ``` +``` +let udp = socket.constructUDPSocketInstance(); +udp.on('message', value => { + console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo); +}); +``` ### off\('message'\) @@ -468,25 +468,25 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | - | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | - | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - let callback = value =>{ - console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo); - } - udp.on('message', callback); - // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 - udp.off('message', callback); - udp.off('message'); - ``` +``` +let udp = socket.constructUDPSocketInstance(); +let callback = value =>{ + console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo); +} +udp.on('message', callback); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 +udp.off('message', callback); +udp.off('message'); +``` ### on\('listening' | 'close'\) @@ -495,24 +495,24 @@ on\(type: 'listening' | 'close', callback: Callback\): void 订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 订阅的事件类型。
- 'listening':数据包消息事件。
- 'close':关闭事件。 | - | callback | Callback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅的事件类型。
- 'listening':数据包消息事件。
- 'close':关闭事件。 | +| callback | Callback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance(); - udp.on('listening', () => { - console.log("on listening success")); - }); - udp.on('close', () => { - console.log("on close success" ); - }); - ``` +``` +let udp = socket.constructUDPSocketInstance(); +udp.on('listening', () => { + console.log("on listening success")); +}); +udp.on('close', () => { + console.log("on close success" ); +}); +``` ### off\('listening' | 'close'\) @@ -524,32 +524,32 @@ off\(type: 'listening' | 'close', callback?: Callback\): void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 订阅事件类型。
- 'listening':数据包消息事件。
- 'close':关闭事件。 | - | callback | Callback\ | 否 | 回调函数。 | - -- 示例 - - ``` - 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'); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅事件类型。
- 'listening':数据包消息事件。
- 'close':关闭事件。 | +| callback | Callback\ | 否 | 回调函数。 | + +**示例:** + +``` +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'); +``` ### on\('error'\) @@ -558,22 +558,22 @@ on\(type: 'error', callback: ErrorCallback\): void 订阅UDPSocket连接的error事件。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------- | ---- | ------------------------------------ | - | type | string | 是 | 订阅的事件类型。'error':error事件。 | - | callback | ErrorCallback | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------ | +| type | string | 是 | 订阅的事件类型。'error':error事件。 | +| callback | ErrorCallback | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance() - udp.on('error', err => { - console.log("on error, err:" + JSON.stringify(err)) - }); - ``` +``` +let udp = socket.constructUDPSocketInstance() +udp.on('error', err => { + console.log("on error, err:" + JSON.stringify(err)) +}); +``` ### off\('error'\) @@ -585,25 +585,25 @@ off\(type: 'error', callback?: ErrorCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------- | ---- | ------------------------------------ | - | type | string | 是 | 订阅的事件类型。'error':error事件。 | - | callback | ErrorCallback | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------ | +| type | string | 是 | 订阅的事件类型。'error':error事件。 | +| callback | ErrorCallback | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let udp = socket.constructUDPSocketInstance() - let callback = err =>{ - console.log("on error, err:" + JSON.stringify(err)); - } - udp.on('error', callback); - // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 - udp.off('error', callback); - udp.off('error'); - ``` +``` +let udp = socket.constructUDPSocketInstance() +let callback = err =>{ + console.log("on error, err:" + JSON.stringify(err)); +} +udp.on('error', callback); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 +udp.off('error', callback); +udp.off('error'); +``` ## NetAddress @@ -664,17 +664,17 @@ constructTCPSocketInstance\(\): TCPSocket 创建一个TCPSocket对象。 -- 返回值 +**返回值:** | 类型 | 说明 | | :--------------------------------- | :---------------------- | | [TCPSocket](#section1180211014548) | 返回一个TCPSocket对象。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +``` ## TCPSocket @@ -687,26 +687,26 @@ bind\(address: NetAddress, callback: AsyncCallback\): void 绑定IP地址和端口,端口可以指定或由系统随机分配。使用callback方法作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | ------------------------------------------------------ | - | address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------------------------------ | +| address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - 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'); - }) - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { + if (err) { + console.log('bind fail'); + return; + } + console.log('bind success'); +}) +``` ### bind @@ -715,29 +715,29 @@ bind\(address NetAddress\): Promise 绑定IP地址和端口,端口可以指定或由系统随机分配。使用Promise方法作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ---------------------------------- | ---- | ------------------------------------------------------ | - | address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------- | ---- | ------------------------------------------------------ | +| address | [NetAddress](#section159132241295) | 是 | 目标地址信息,参考[NetAddress](#section159132241295)。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :-------------- | :------------------------------------------------------- | - | Promise\ | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 | +| 类型 | 说明 | +| :-------------- | :------------------------------------------------------- | +| Promise\ | 以Promise形式返回TCPSocket绑定本机的IP地址和端口的结果。 | -- 示例 +**示例:** - ``` - 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'); - }); - ``` +``` +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'); +}); +``` ### connect @@ -746,25 +746,25 @@ connect\(options: TCPConnectOptions, callback: AsyncCallback\): void 连接到指定的IP地址和端口。使用callback方法作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#section13821005712)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#section13821005712)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - 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'); - }) - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}, err => { + if (err) { + console.log('connect fail'); + return; + } + console.log('connect success'); +}) +``` ### connect @@ -773,29 +773,29 @@ connect\(options: TCPConnectOptions\): Promise 连接到指定的IP地址和端口。使用promise方法作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#section13821005712)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [TCPConnectOptions](#section13821005712) | 是 | TCPSocket连接的参数,参考[TCPConnectOptions](#section13821005712)。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :-------------- | :--------------------------------------------------------- | - | Promise\ | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 | +| 类型 | 说明 | +| :-------------- | :--------------------------------------------------------- | +| Promise\ | 以Promise形式返回TCPSocket连接到指定的IP地址和端口的结果。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}); - promise.then(() => { - console.log('connect success') - }).catch(err => { - console.log('connect fail'); - }); - ``` +``` +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'); +}); +``` ### send @@ -807,33 +807,33 @@ send\(options: TCPSendOptions, callback: AsyncCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#section1689232415715)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | - -- 示例 - - ``` - 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'); - }); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#section1689232415715)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例:** + +``` +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'); +}); +``` ### send @@ -845,37 +845,37 @@ send\(options: TCPSendOptions\): Promise >![](public_sys-resources/icon-note.gif) **说明:** >[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#section1689232415715)。 | - -- 返回值 - - | 类型 | 说明 | - | :-------------- | :------------------------------------------------- | - | Promise\ | 以Promise形式返回通过TCPSocket连接发送数据的结果。 | - -- 示例 - - ``` - 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'); - }); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [TCPSendOptions](#section1689232415715) | 是 | TCPSocket发送请求的参数,参考[TCPSendOptions](#section1689232415715)。 | + +**返回值:** + +| 类型 | 说明 | +| :-------------- | :------------------------------------------------- | +| Promise\ | 以Promise形式返回通过TCPSocket连接发送数据的结果。 | + +**示例:** + +``` +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'); +}); +``` ### close @@ -884,25 +884,25 @@ close\(callback: AsyncCallback\): void 关闭TCPSocket连接。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------- | ---- | ---------- | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------- | ---- | ---------- | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - tcp.close(err => { - if (err) { - console.log('close fail'); - return; - } - console.log('close success'); - }) - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +tcp.close(err => { + if (err) { + console.log('close fail'); + return; + } + console.log('close success'); +}) +``` ### close @@ -911,23 +911,23 @@ close\(\): Promise 关闭TCPSocket连接。使用Promise方式作为异步方法。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :-------------- | :----------------------------------------- | - | Promise\ | 以Promise形式返回关闭TCPSocket连接的结果。 | +| 类型 | 说明 | +| :-------------- | :----------------------------------------- | +| Promise\ | 以Promise形式返回关闭TCPSocket连接的结果。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let promise = tcp.close(); - promise.then(() => { - console.log('close success'); - }).catch(err => { - console.log('close fail'); - }); - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +let promise = tcp.close(); +promise.then(() => { + console.log('close success'); +}).catch(err => { + console.log('close fail'); +}); +``` ### getRemoteAddress @@ -939,30 +939,30 @@ getRemoteAddress\(callback: AsyncCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------- | ---- | ---------- | - | callback | AsyncCallback<[NetAddress](#section159132241295)> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------- | ---- | ---------- | +| callback | AsyncCallback<[NetAddress](#section159132241295)> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}); - promise.then(() => { - 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'); - }); - ``` +``` +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'); +}); +``` ### getRemoteAddress @@ -974,29 +974,29 @@ getRemoteAddress\(\): Promise >![](public_sys-resources/icon-note.gif) **说明:** >[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :------------------------------------------ | :------------------------------------------ | - | Promise<[NetAddress](#section159132241295)> | 以Promise形式返回获取对端socket地址的结果。 | +| 类型 | 说明 | +| :------------------------------------------ | :------------------------------------------ | +| Promise<[NetAddress](#section159132241295)> | 以Promise形式返回获取对端socket地址的结果。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let promise1 = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}); - promise1.then(() => { - console.log('connect success'); - let promise2 = tcp.getRemoteAddress(); - promise2.then(() => { - console.log('getRemoteAddress success:' + JSON.stringify(data)); - }).catch(err => { - console.log('getRemoteAddressfail'); - }); - }).catch(err => { - console.log('connect fail'); - }); - ``` +``` +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(() => { + console.log('getRemoteAddress success:' + JSON.stringify(data)); + }).catch(err => { + console.log('getRemoteAddressfail'); + }); +}).catch(err => { + console.log('connect fail'); +}); +``` ### getState @@ -1008,31 +1008,31 @@ getState\(callback: AsyncCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------ | ---- | ---------- | - | callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------ | ---- | ---------- | +| callback | AsyncCallback<[SocketStateBase](#section164609984111)> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}); - promise.then(() => { - 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'); - }); - ``` +``` +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'); +}); +``` ### getState @@ -1044,30 +1044,30 @@ getState\(\): Promise >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :----------------------------------------------- | :----------------------------------------- | - | Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取TCPSocket状态的结果。 | +| 类型 | 说明 | +| :----------------------------------------------- | :----------------------------------------- | +| Promise<[SocketStateBase](#section164609984111)> | 以Promise形式返回获取TCPSocket状态的结果。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let promise = tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , timeout: 6000}); - promise.then(() => { - console.log('connect success'); - let promise1 = tcp.getState(); - promise1.then(() => { - console.log('getState success:' + JSON.stringify(data)); - }).catch(err => { - console.log('getState fail'); - }); - }).catch(err => { - console.log('connect fail'); - }); - ``` +``` +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(() => { + console.log('getState success:' + JSON.stringify(data)); + }).catch(err => { + console.log('getState fail'); + }); +}).catch(err => { + console.log('connect fail'); +}); +``` ### setExtraOptions @@ -1079,40 +1079,40 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback\): voi >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#section13892555115718)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | - -- 示例 - - ``` - 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, - 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'); - }); - }).catch(err => { - console.log('connect fail'); - }); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#section13892555115718)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | + +**示例:** + +``` +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, + 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'); + }); +}).catch(err => { + console.log('connect fail'); +}); +``` ### setExtraOptions @@ -1124,45 +1124,45 @@ setExtraOptions\(options: TCPExtraOptions\): Promise >![](public_sys-resources/icon-note.gif) **说明:** >[bind](#section8465924145710)或[connect](#section82761299586)方法调用成功后,才可调用此方法。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | - | options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#section13892555115718)。 | - -- 返回值 - - | 类型 | 说明 | - | :-------------- | :--------------------------------------------------- | - | Promise\ | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 | - - -- 示例 - - ``` - 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, - socketLinger: { on:true, linger:10 } - 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'); - }); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | +| options | [TCPExtraOptions](#section13892555115718) | 是 | TCPSocket连接的其他属性,参考[TCPExtraOptions](#section13892555115718)。 | + +**返回值:** + +| 类型 | 说明 | +| :-------------- | :--------------------------------------------------- | +| Promise\ | 以Promise形式返回设置TCPSocket连接的其他属性的结果。 | + + +**示例:** + +``` +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, + socketLinger: { on:true, linger:10 } + 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'); +}); +``` ### on\('message'\) @@ -1171,21 +1171,21 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock 订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | - | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | - | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - tcp.on('message', value => { - console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo) - }); - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +tcp.on('message', value => { + console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo) +}); +``` ### off\('message'\) @@ -1197,25 +1197,25 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | - | type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | - | callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#section46021613174115)}> | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - let callback = value =>{ - console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo); - } - tcp.on('message', callback); - // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 - tcp.off('message', callback); - tcp.off('message'); - ``` +``` +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'); +``` ### on\('connect' | 'close'\) @@ -1224,25 +1224,25 @@ on\(type: 'connect' | 'close', callback: Callback\): void 订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 订阅的事件类型。
- 'connect':连接事件。
- 'close':关闭事件。 | - | callback | Callback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅的事件类型。
- 'connect':连接事件。
- 'close':关闭事件。 | +| callback | Callback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - tcp.on('connect', () => { - console.log("on connect success") - }); - tcp.on('close', data => { - console.log("on close success") - }); - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +tcp.on('connect', () => { + console.log("on connect success") +}); +tcp.on('close', data => { + console.log("on close success") +}); +``` ### off\('connect' | 'close'\) @@ -1254,32 +1254,32 @@ off\(type: 'connect' | 'close', callback: Callback\): void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 订阅的事件类型。
- 'connect':连接事件。
- 'close':关闭事件。 | - | callback | Callback\ | 否 | 回调函数。 | - -- 示例 - - ``` - 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'); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅的事件类型。
- 'connect':连接事件。
- 'close':关闭事件。 | +| callback | Callback\ | 否 | 回调函数。 | + +**示例:** + +``` +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'); +``` ### on\('error'\) @@ -1288,21 +1288,21 @@ on\(type: 'error', callback: ErrorCallback\): void 订阅TCPSocket连接的error事件。使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------- | ---- | ------------------------------------ | - | type | string | 是 | 订阅的事件类型。'error':error事件。 | - | callback | ErrorCallback | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------ | +| type | string | 是 | 订阅的事件类型。'error':error事件。 | +| callback | ErrorCallback | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let tcp = socket.constructTCPSocketInstance(); - tcp.on('error', err => { - console.log("on error, err:" + JSON.stringify(err)) - }); - ``` +``` +let tcp = socket.constructTCPSocketInstance(); +tcp.on('error', err => { + console.log("on error, err:" + JSON.stringify(err)) +}); +``` ### off\('error'\) @@ -1314,25 +1314,25 @@ off\(type: 'error', callback?: ErrorCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------- | ---- | ------------------------------------ | - | type | string | 是 | 订阅的事件类型。'error':error事件。 | - | callback | ErrorCallback | 否 | 回调函数。 | - -- 示例 - - ``` - 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'); - ``` +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------ | +| type | string | 是 | 订阅的事件类型。'error':error事件。 | +| callback | ErrorCallback | 否 | 回调函数。 | + +**示例:** + +``` +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'); +``` ## TCPConnectOptions diff --git a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md index 42a9304b26..9a797ae52c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md @@ -28,6 +28,8 @@ >![](public_sys-resources/icon-note.gif) **说明:** >本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +> +>当前暂时不支持WebSocket,预计在MR版本支持。 使用WebSocket建立服务器与客户端的双向连接,需要先通过[createWebSocket](#section375081875219)方法创建[WebSocket](#section16411174314593)对象,然后通过[connect](WebSocket连接.md)方法连接到服务器。当连接成功后,客户端会收到[open](#section923017271834)事件的回调,之后客户端就可以通过[send](#section156451414213)方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到[message](#section1066819418488)事件的回调。当客户端不要此连接时,可以通过调用[close](#section202411451433)方法主动断开连接,之后客户端会收到[close](#section169378107484)事件的回调。 @@ -96,17 +98,17 @@ createWebSocket\(\): WebSocket 创建一个WebSocket,里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。 -- 返回值 +**返回值:** - | 类型 | 说明 | - | :---------------------------------- | :----------------------------------------------------------- | - | [WebSocket](#section16411174314593) | 返回一个WebSocket对象,里面包括connect、send、close、on和off方法。 | +| 类型 | 说明 | +| :---------------------------------- | :----------------------------------------------------------- | +| [WebSocket](#section16411174314593) | 返回一个WebSocket对象,里面包括connect、send、close、on和off方法。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ``` +``` +let ws = webSocket.createWebSocket(); +``` ## WebSocket @@ -119,27 +121,27 @@ connect\(url: string, callback: AsyncCallback\): void 根据URL地址,建立一个WebSocket连接,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------ | ---- | ---------------------------- | - | url | string | 是 | 建立WebSocket连接的URL地址。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------------------- | +| url | string | 是 | 建立WebSocket连接的URL地址。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - ws.connect(url, (err, value) => { - if (!err) { - console.log("connect success"); - } else { - console.log("connect fail, err:" + JSON.stringify(err)) - } - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +ws.connect(url, (err, value) => { + if (!err) { + console.log("connect success"); + } else { + console.log("connect fail, err:" + JSON.stringify(err)) + } +}); +``` ### connect @@ -148,33 +150,33 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback< 根据URL地址和header,建立一个WebSocket连接,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------ | ---- | ------------------------------------------------------- | - | url | string | 是 | 建立WebSocket连接的URL地址。 | - | options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#section11251233123910)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ------------------------------------------------------- | +| url | string | 是 | 建立WebSocket连接的URL地址。 | +| options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#section11251233123910)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - ws.connect(url, { - header: { - "key": "value", - "key2": "value2" - } - }, (err, value) => { - if (!err) { - console.log("connect success"); - } else { - console.log("connect fail, err:" + JSON.stringify(err)) - } - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +ws.connect(url, { + header: { + "key": "value", + "key2": "value2" + } +}, (err, value) => { + if (!err) { + console.log("connect success"); + } else { + console.log("connect fail, err:" + JSON.stringify(err)) + } +}); +``` ### connect @@ -183,31 +185,31 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise 根据URL地址和header,建立一个WebSocket连接,使用Promise方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ----------------------- | ---- | ------------------------------------------------------- | - | url | string | 是 | 建立WebSocket连接的URL地址。 | - | options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#section11251233123910)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ----------------------- | ---- | ------------------------------------------------------- | +| url | string | 是 | 建立WebSocket连接的URL地址。 | +| options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#section11251233123910)。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :----------------- | :-------------------------------- | - | Promise\ | 以Promise形式返回建立连接的结果。 | +| 类型 | 说明 | +| :----------------- | :-------------------------------- | +| Promise\ | 以Promise形式返回建立连接的结果。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - let promise = ws.connect(url); - promise.then((value) => { - console.log("connect success") - }).catch((err) => { - console.log("connect fail, error:" + JSON.stringify(err)) - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +let promise = ws.connect(url); +promise.then((value) => { + console.log("connect success") +}).catch((err) => { + console.log("connect fail, error:" + JSON.stringify(err)) +}); +``` ### send @@ -216,28 +218,28 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback\): void 通过WebSocket连接发送数据,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------ | ---- | ------------ | - | data | string \| ArrayBuffer 8+ | 是 | 发送的数据。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ------------ | +| data | string \| ArrayBuffer 8+ | 是 | 发送的数据。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - ws.connect(url, (err, value) => { - ws.send("Hello, server!", (err, value) => { - if (!err) { - console.log("send success"); - } else { - console.log("send fail, err:" + JSON.stringify(err)) - } - }); - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +ws.connect(url, (err, value) => { + ws.send("Hello, server!", (err, value) => { + if (!err) { + console.log("send success"); + } else { + console.log("send fail, err:" + JSON.stringify(err)) + } + }); +}); +``` ### send @@ -246,32 +248,32 @@ send\(data: string | ArrayBuffer\): Promise 通过WebSocket连接发送数据,使用Promise方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------ | ------ | ---- | ------------ | - | data | string \| ArrayBuffer 8+ | 是 | 发送的数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------ | +| data | string \| ArrayBuffer 8+ | 是 | 发送的数据。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :----------------- | :-------------------------------- | - | Promise\ | 以Promise形式返回发送数据的结果。 | +| 类型 | 说明 | +| :----------------- | :-------------------------------- | +| Promise\ | 以Promise形式返回发送数据的结果。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - ws.connect(url, (err, value) => { - let promise = ws.send("Hello, server!"); - promise.then((value) => { - console.log("send success") - }).catch((err) => { - console.log("send fail, error:" + JSON.stringify(err)) - }); - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +ws.connect(url, (err, value) => { + let promise = ws.send("Hello, server!"); + promise.then((value) => { + console.log("send success") + }).catch((err) => { + console.log("send fail, error:" + JSON.stringify(err)) + }); +}); +``` ### close @@ -280,25 +282,25 @@ close\(callback: AsyncCallback\): void 关闭WebSocket连接,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------ | ---- | ---------- | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------- | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - ws.close((err, value) => { - if (!err) { - console.log("close success") - } else { - console.log("close fail, err is " + JSON.stringify(err)) - } - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +ws.close((err, value) => { + if (!err) { + console.log("close success") + } else { + console.log("close fail, err is " + JSON.stringify(err)) + } +}); +``` ### close @@ -307,29 +309,29 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback\): void 根据可选参数code和reason,关闭WebSocket连接,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------ | ---- | ----------------------------------------------------- | - | options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#section12262183471518)。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ----------------------------------------------------- | +| options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#section12262183471518)。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - ws.close({ - code: 1000, - reason: "your reason" - }, (err, value) => { - if (!err) { - console.log("close success") - } else { - console.log("close fail, err is " + JSON.stringify(err)) - } - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +ws.close({ + code: 1000, + reason: "your reason" +}, (err, value) => { + if (!err) { + console.log("close success") + } else { + console.log("close fail, err is " + JSON.stringify(err)) + } +}); +``` ### close @@ -338,33 +340,33 @@ close\(options?: WebSocketCloseOptions\): Promise 根据可选参数code和reason,关闭WebSocket连接,使用Promise方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | --------------------- | ---- | ----------------------------------------------------- | - | options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#section12262183471518)。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------- | ---- | ----------------------------------------------------- | +| options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#section12262183471518)。 | -- 返回值 +**返回值:** - | 类型 | 说明 | - | :--------------- | :-------------------------------- | - | Promise | 以Promise形式返回关闭连接的结果。 | +| 类型 | 说明 | +| :----------------- | :-------------------------------- | +| Promise\ | 以Promise形式返回关闭连接的结果。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let url = "ws://" - let promise = ws.close({ - code: 1000, - reason: "your reason" - }); - promise.then((value) => { - console.log("close success") - }).catch((err) => { - console.log("close fail, err is " + JSON.stringify(err)) - }); - ``` +``` +let ws = webSocket.createWebSocket(); +let url = "ws://" +let promise = ws.close({ + code: 1000, + reason: "your reason" +}); +promise.then((value) => { + console.log("close success") +}).catch((err) => { + console.log("close fail, err is " + JSON.stringify(err)) +}); +``` ### on\('open'\) @@ -373,22 +375,22 @@ on\(type: 'open', callback: AsyncCallback\): void 订阅WebSocket的打开事件,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------- | ---- | ----------------------------- | - | type | string | 是 | 'open':WebSocket的打开事件。 | - | callback | AsyncCallback\ | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ----------------------------- | +| type | string | 是 | 'open':WebSocket的打开事件。 | +| callback | AsyncCallback\ | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.on('open', (err, value) => { - console.log("on open, status:" + value.status + ", message:" + value.message); - }); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.on('open', (err, value) => { + console.log("on open, status:" + value.status + ", message:" + value.message); +}); +``` ### off\('open'\) @@ -400,24 +402,24 @@ off\(type: 'open', callback?: AsyncCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------- | ---- | ----------------------------- | - | type | string | 是 | 'open':WebSocket的打开事件。 | - | callback | AsyncCallback\ | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ----------------------------- | +| type | string | 是 | 'open':WebSocket的打开事件。 | +| callback | AsyncCallback\ | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - let callback1 = (err, value) => { - console.log("on open, status:" + value.status + ", message:" + value.message); - } - ws.on('open', callback1); - // 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅 - ws.off('open', callback1); - ``` +``` +let ws = webSocket.createWebSocket(); +let callback1 = (err, value) => { + console.log("on open, status:" + value.status + ", message:" + value.message); +} +ws.on('open', callback1); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅 +ws.off('open', callback1); +``` ### on\('message'\) @@ -429,22 +431,22 @@ on\(type: 'message', callback: AsyncCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------- | ---- | -------------------------------------------- | - | type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 | - | callback | AsyncCallback\8+\> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | -------------------------------------------- | +| type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 | +| callback | AsyncCallback\8+\> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.on('message', (err, value) => { - console.log("on message, message:" + value); - }); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.on('message', (err, value) => { + console.log("on message, message:" + value); +}); +``` ### off\('message'\) @@ -457,19 +459,19 @@ off\(type: 'message', callback?: AsyncCallback\): void >AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。 >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------------------- | ---- | -------------------------------------------- | - | type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 | - | callback | AsyncCallback\8+\> | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | -------------------------------------------- | +| type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 | +| callback | AsyncCallback\8+\> | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.off('message'); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.off('message'); +``` ### on\('close'\) @@ -478,21 +480,21 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\ 订阅WebSocket的关闭事件,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------------------------- | ---- | ------------------------------ | - | type | string | 是 | 'close':WebSocket的关闭事件。 | - | callback | AsyncCallback<{ code: number, reason: string }> | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ------------------------------ | +| type | string | 是 | 'close':WebSocket的关闭事件。 | +| callback | AsyncCallback<{ code: number, reason: string }> | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.on('close', (err, value) => { - console.log("on close, code is " + value.code + ", reason is " + value.reason); - }); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.on('close', (err, value) => { + console.log("on close, code is " + value.code + ", reason is " + value.reason); +}); +``` ### off\('close'\) @@ -504,20 +506,20 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\ >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ----------------------------------------------- | ---- | ------------------------------ | - | type | string | 是 | 'close':WebSocket的关闭事件。 | - | callback | AsyncCallback<{ code: number, reason: string }> | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ------------------------------ | +| type | string | 是 | 'close':WebSocket的关闭事件。 | +| callback | AsyncCallback<{ code: number, reason: string }> | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.off('close'); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.off('close'); +``` ### on\('error'\) @@ -526,22 +528,22 @@ on\(type: 'error', callback: ErrorCallback\): void 订阅WebSocket的Error事件,使用callback方式作为异步方法。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------- | ---- | ------------------------------- | - | type | string | 是 | 'error':WebSocket的Error事件。 | - | callback | ErrorCallback | 是 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------- | +| type | string | 是 | 'error':WebSocket的Error事件。 | +| callback | ErrorCallback | 是 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.on('error', (err) => { - console.log("on error, error:" + JSON.stringify(err)) - }); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.on('error', (err) => { + console.log("on error, error:" + JSON.stringify(err)) +}); +``` ### off\('error'\) @@ -553,19 +555,19 @@ off\(type: 'error', callback?: ErrorCallback\): void >![](public_sys-resources/icon-note.gif) **说明:** >可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 -- 参数 +**参数:** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------- | ---- | ------------------------------- | - | type | string | 是 | 'error':WebSocket的Error事件。 | - | callback | ErrorCallback | 否 | 回调函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------- | +| type | string | 是 | 'error':WebSocket的Error事件。 | +| callback | ErrorCallback | 否 | 回调函数。 | -- 示例 +**示例:** - ``` - let ws = webSocket.createWebSocket(); - ws.off('error'); - ``` +``` +let ws = webSocket.createWebSocket(); +ws.off('error'); +``` ## WebSocketRequestOptions -- GitLab