harmony 鸿蒙@ohos.net.webSocket (WebSocket连接)
@ohos.net.webSocket (WebSocket连接)
说明:
本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
使用WebSocket建立服务器与客户端的双向连接,需要先通过createWebSocket方法创建WebSocket对象,然后通过connect方法连接到服务器。 当连接成功后,客户端会收到open事件的回调,之后客户端就可以通过send方法与服务器进行通信。 当服务器发信息给客户端时,客户端会收到message事件的回调。当客户端不要此连接时,可以通过调用close方法主动断开连接,之后客户端会收到close事件的回调。
若在上述任一过程中发生错误,客户端会收到error事件的回调。
导入模块
import webSocket from '@ohos.net.webSocket';
完整示例
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let defaultIpAddress = "ws://";
let ws = webSocket.createWebSocket();
ws.on('open', (err:BusinessError, value: Object) => {
if (err != undefined) {
console.log(JSON.stringify(err))
return
}
// 当收到on('open')事件时,可以通过send()方法与服务器进行通信
ws.send("Hello, server!", (err: BusinessError, value: boolean) => {
if (!err) {
console.log("send success");
} else {
console.log("send fail, err:" + JSON.stringify(err));
}
});
});
ws.on('message', (err: BusinessError, value: string) => {
console.log("on message, message:" + value);
// 当收到服务器的`bye`消息时(此消息字段仅为示意,具体字段需要与服务器协商),主动断开连接
if (value === 'bye') {
ws.close((err: BusinessError, value: boolean) => {
if (!err) {
console.log("close success");
} else {
console.log("close fail, err is " + JSON.stringify(err));
}
});
}
});
ws.on('close', (err: BusinessError, value: webSocket.CloseResult) => {
console.log("on close, code is " + value.code + ", reason is " + value.reason);
});
ws.on('error', (err: BusinessError) => {
console.log("on error, error:" + JSON.stringify(err));
});
ws.connect(defaultIpAddress, (err: BusinessError, value: boolean) => {
if (!err) {
console.log("connect success");
} else {
console.log("connect fail, err:" + JSON.stringify(err));
}
});
webSocket.createWebSocket6+
createWebSocket(): WebSocket
创建一个WebSocket,里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。
系统能力:SystemCapability.Communication.NetStack
返回值:
类型 | 说明 |
---|---|
WebSocket | 返回一个WebSocket对象,里面包括connect、send、close、on和off方法。 |
示例:
let ws: webSocket = webSocket.createWebSocket();
WebSocket6+
在调用WebSocket的方法前,需要先通过webSocket.createWebSocket创建一个WebSocket。
connect6+
connect(url: string, callback: AsyncCallback<boolean>): void
根据URL地址,建立一个WebSocket连接,使用callback方式作为异步方法。
说明: 可通过监听error事件获得该接口的执行结果,错误发生时会得到错误码:200。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 建立WebSocket连接的URL地址。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err: BusinessError, value: boolean) => {
if (!err) {
console.log("connect success");
} else {
console.log("connect fail, err:" + JSON.stringify(err))
}
});
connect6+
connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<boolean>): void
根据URL地址和header,建立一个WebSocket连接,使用callback方式作为异步方法。
说明: 可通过监听error事件获得该接口的执行结果,错误发生时会得到错误码:200。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 建立WebSocket连接的URL地址。 |
options | WebSocketRequestOptions | 是 | 参考WebSocketRequestOptions。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
let header: Map<string, string>
header.set("key", "value")
header.set("key2", "value2")
let url = "ws://"
ws.connect(url, header as webSocket.WebSocketRequestOptions, (err: BusinessError, value: Object) => {
if (!err) {
console.log("connect success");
} else {
console.log("connect fail, err:" + JSON.stringify(err))
}
});
connect6+
connect(url: string, options?: WebSocketRequestOptions): Promise<boolean>
根据URL地址和header,建立一个WebSocket连接,使用Promise方式作为异步方法。
说明: 可通过监听error事件获得该接口的执行结果,错误发生时会得到错误码:200。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 建立WebSocket连接的URL地址。 |
options | WebSocketRequestOptions | 否 | 参考WebSocketRequestOptions。 |
返回值:
类型 | 说明 |
---|---|
Promise<boolean> | 以Promise形式返回建立连接的结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
let ws = webSocket.createWebSocket();
let url = "ws://"
let promise = ws.connect(url);
promise.then((value: boolean) => {
console.log("connect success")
}).catch((err:string) => {
console.log("connect fail, error:" + JSON.stringify(err))
});
send6+
send(data: string|ArrayBuffer, callback: AsyncCallback<boolean>): void
通过WebSocket连接发送数据,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
data | string |ArrayBuffer | 是 | 发送的数据。 API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err: BusinessError, value: boolean) => {
ws.send("Hello, server!", (err: BusinessError, value: boolean) => {
if (!err) {
console.log("send success");
} else {
console.log("send fail, err:" + JSON.stringify(err))
}
});
});
send6+
send(data: string|ArrayBuffer): Promise<boolean>
通过WebSocket连接发送数据,使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
data | string |ArrayBuffer | 是 | 发送的数据。 API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
返回值:
类型 | 说明 |
---|---|
Promise<boolean> | 以Promise形式返回发送数据的结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
let url = "ws://"
ws.connect(url, (err: BusinessError, value: boolean) => {
let promise = ws.send("Hello, server!");
promise.then((value: boolean) => {
console.log("send success")
}).catch((err:string) => {
console.log("send fail, error:" + JSON.stringify(err))
});
});
close6+
close(callback: AsyncCallback<boolean>): void
关闭WebSocket连接,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
callback | AsyncCallback<boolean> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
ws.close((err: BusinessError) => {
if (!err) {
console.log("close success")
} else {
console.log("close fail, err is " + JSON.stringify(err))
}
});
close6+
close(options: WebSocketCloseOptions, callback: AsyncCallback<boolean>): void
根据可选参数code和reason,关闭WebSocket连接,使用callback方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | WebSocketCloseOptions | 是 | 参考WebSocketCloseOptions。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
let options: webSocket.WebSocketCloseOptions
options.code = 1000
options.reason = "your reason"
ws.close(options, (err: BusinessError) => {
if (!err) {
console.log("close success")
} else {
console.log("close fail, err is " + JSON.stringify(err))
}
});
close6+
close(options?: WebSocketCloseOptions): Promise<boolean>
根据可选参数code和reason,关闭WebSocket连接,使用Promise方式作为异步方法。
需要权限:ohos.permission.INTERNET
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
options | WebSocketCloseOptions | 否 | 参考WebSocketCloseOptions。 |
返回值:
类型 | 说明 |
---|---|
Promise<boolean> | 以Promise形式返回关闭连接的结果。 |
错误码:
错误码ID | 错误信息 |
---|---|
401 | Parameter error. |
201 | Permission denied. |
示例:
import webSocket from '@ohos.net.webSocket';
let ws = webSocket.createWebSocket();
let options: webSocket.WebSocketCloseOptions
options.code = 1000
options.reason = "your reason"
let promise = ws.close();
promise.then((value: boolean) => {
console.log("close success")
}).catch((err:string) => {
console.log("close fail, err is " + JSON.stringify(err))
});
on(‘open’)6+
on(type: ‘open’, callback: AsyncCallback<Object>): void
订阅WebSocket的打开事件,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘open’:WebSocket的打开事件。 |
callback | AsyncCallback<Object> | 是 | 回调函数。 |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError, Callback } from '@ohos.base';
let ws= webSocket.createWebSocket();
class OutValue {
status: number = 0
message: string = ""
}
ws.on('open', (err: BusinessError, value: OutValue) => {
console.log("on open, status:" + value.status + ", message:" + value.message);
});
off(‘open’)6+
off(type: ‘open’, callback?: AsyncCallback<Object>): void
取消订阅WebSocket的打开事件,使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘open’:WebSocket的打开事件。 |
callback | AsyncCallback<Object> | 否 | 回调函数。 |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
class OutValue {
status: number = 0
message: string = ""
}
let callback1 = (err: BusinessError, value: OutValue) => {
console.log("on open, status:" + value.status + ", message:" + value.message);
}
ws.on('open', callback1);
// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅
ws.off('open', callback1);
on(‘message’)6+
on(type: ‘message’, callback: AsyncCallback<string|ArrayBuffer>): void
订阅WebSocket的接收到服务器消息事件,使用callback方式作为异步方法。每个消息最大长度为4K,超过4K自动分片。
说明: AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘message’:WebSocket的接收到服务器消息事件。 |
callback | AsyncCallback<string |ArrayBuffer 8+> | 是 | 回调函数。 |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
ws.on('message', (err: BusinessError, value: string) => {
console.log("on message, message:" + value);
});
off(‘message’)6+
off(type: ‘message’, callback?: AsyncCallback<string|ArrayBuffer>): void
取消订阅WebSocket的接收到服务器消息事件,使用callback方式作为异步方法。每个消息最大长度为4K,超过4K自动分片。
说明: AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘message’:WebSocket的接收到服务器消息事件。 |
callback | AsyncCallback<string |ArrayBuffer 8+> | 否 | 回调函数。 |
示例:
import webSocket from '@ohos.net.webSocket';
let ws = webSocket.createWebSocket();
ws.off('message');
on(‘close’)6+
on(type: ‘close’, callback: AsyncCallback<CloseResult>): void
订阅WebSocket的关闭事件,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘close’:WebSocket的关闭事件。 |
callback | AsyncCallback<CloseResult> | 是 | 回调函数。 close:close错误码,reason:错误码说明 |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
ws.on('close', (err: BusinessError, value: webSocket.CloseResult) => {
console.log("on close, code is " + value.code + ", reason is " + value.reason);
});
off(‘close’)6+
off(type: ‘close’, callback?: AsyncCallback<CloseResult>): void
取消订阅WebSocket的关闭事件,使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘close’:WebSocket的关闭事件。 |
callback | AsyncCallback<CloseResult> | 否 | 回调函数。 close:close错误码,reason:错误码说明 |
示例:
import webSocket from '@ohos.net.webSocket';
let ws = webSocket.createWebSocket();
ws.off('close');
on(‘error’)6+
on(type: ‘error’, callback: ErrorCallback): void
订阅WebSocket的Error事件,使用callback方式作为异步方法。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘error’:WebSocket的Error事件。 |
callback | ErrorCallback | 是 | 回调函数。 常见错误码:200 |
示例:
import webSocket from '@ohos.net.webSocket';
import { BusinessError } from '@ohos.base';
let ws = webSocket.createWebSocket();
ws.on('error', (err: BusinessError) => {
console.log("on error, error:" + JSON.stringify(err))
});
off(‘error’)6+
off(type: ‘error’, callback?: ErrorCallback): void
取消订阅WebSocket的Error事件,使用callback方式作为异步方法。
说明: 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
系统能力:SystemCapability.Communication.NetStack
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
type | string | 是 | ‘error’:WebSocket的Error事件。 |
callback | ErrorCallback | 否 | 回调函数。 |
示例:
import webSocket from '@ohos.net.webSocket';
let ws = webSocket.createWebSocket();
ws.off('error');
WebSocketRequestOptions
建立WebSocket连接时,可选参数的类型和说明。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
header | Object | 否 | 建立WebSocket连接可选参数,代表建立连接时携带的HTTP头信息。参数内容自定义,也可以不指定。 |
WebSocketCloseOptions
关闭WebSocket连接时,可选参数的类型和说明。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
code | number | 否 | 错误码,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为1000。 |
reason | string | 否 | 原因值,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为空字符串(”“)。 |
CloseResult10+
关闭WebSocket连接时,订阅close事件得到的关闭结果。
系统能力:SystemCapability.Communication.NetStack
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
code | number | 是 | 错误码,订阅close事件得到的关闭连接的错误码。 |
reason | string | 是 | 原因值,订阅close事件得到的关闭连接的错误原因。 |
close错误码说明
发送给服务端的错误码可以自行定义,下面的列表仅供参考。
系统能力:SystemCapability.Communication.NetStack
值 | 说明 |
---|---|
1000 | 正常关闭 |
1001 | 服务器主动关闭 |
1002 | 协议错误 |
1003 | 无法处理的数据类型 |
1004~1015 | 保留值 |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦