鸿蒙开发网络管理：【@ohos.net.webSocket (WebSocket连接)】

news2024/12/26 14:12:22

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';

var defaultIpAddress = "ws://";
let ws = webSocket.createWebSocket();
ws.on('open', (err, value) => {
    console.log("on open, status:" + value['status'] + ", message:" + value['message']);
    // 当收到on('open')事件时，可以通过send()方法与服务器进行通信
    ws.send("Hello, server!", (err, value) => {
        if (!err) {
            console.log("send success");
        } else {
            console.log("send fail, err:" + JSON.stringify(err));
        }
    });
});
ws.on('message', (err, value) => {
    console.log("on message, message:" + value);
    // 当收到服务器的`bye`消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接
    if (value === 'bye') {
        ws.close((err, value) => {
            if (!err) {
                console.log("close success");
            } else {
                console.log("close fail, err is " + JSON.stringify(err));
            }
        });
    }
});
ws.on('close', (err, value) => {
    console.log("on close, code is " + value.code + ", reason is " + value.reason);
});
ws.on('error', (err) => {
    console.log("on error, error:" + JSON.stringify(err));
});
ws.connect(defaultIpAddress, (err, value) => {
    if (!err) {
        console.log("connect success");
    } else {
        console.log("connect fail, err:" + JSON.stringify(err));
    }
});

webSocket.createWebSocket

createWebSocket(): WebSocket

创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。

系统能力：SystemCapability.Communication.NetStack

返回值：

类型说明
[WebSocket]返回一个WebSocket对象，里面包括connect、send、close、on和off方法。

示例：

let ws = webSocket.createWebSocket();

WebSocket

在调用WebSocket的方法前，需要先通过[webSocket.createWebSocket]创建一个WebSocket。

connect

connect(url: string, callback: AsyncCallback): void

根据URL地址，建立一个WebSocket连接，使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
urlstring是建立WebSocket连接的URL地址。
callbackAsyncCallback是回调函数。

示例：

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

connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback): void

根据URL地址和header，建立一个WebSocket连接，使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
urlstring是建立WebSocket连接的URL地址。
optionsWebSocketRequestOptions是参考[WebSocketRequestOptions]。
callbackAsyncCallback是回调函数。

示例：

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

connect(url: string, options?: WebSocketRequestOptions): Promise

根据URL地址和header，建立一个WebSocket连接，使用Promise方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
urlstring是建立WebSocket连接的URL地址。
optionsWebSocketRequestOptions否参考[WebSocketRequestOptions]。

返回值：

类型说明
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))
});

send

send(data: string | ArrayBuffer, callback: AsyncCallback): void

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

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
datastringArrayBuffer 8+是
callbackAsyncCallback是回调函数。

示例：

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

send(data: string | ArrayBuffer): Promise

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

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
datastringArrayBuffer 8+是

返回值：

类型说明
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))
	});
});

close

close(callback: AsyncCallback): void

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

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
callbackAsyncCallback是回调函数。

示例：

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

close(options: WebSocketCloseOptions, callback: AsyncCallback): void

根据可选参数code和reason，关闭WebSocket连接，使用callback方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
optionsWebSocketCloseOptions是参考[WebSocketCloseOptions]。
callbackAsyncCallback是回调函数。

示例：

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

close(options?: WebSocketCloseOptions): Promise

根据可选参数code和reason，关闭WebSocket连接，使用Promise方式作为异步方法。

需要权限：ohos.permission.INTERNET

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
optionsWebSocketCloseOptions否参考[WebSocketCloseOptions]。

返回值：

类型说明
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))
});

on(‘open’)

on(type: ‘open’, callback: AsyncCallback): void

订阅WebSocket的打开事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘open’：WebSocket的打开事件。
callbackAsyncCallback是回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.on('open', (err, value) => {
	console.log("on open, status:" + value['status'] + ", message:" + value['message']);
});

off(‘open’)

off(type: ‘open’, callback?: AsyncCallback): void

取消订阅WebSocket的打开事件，使用callback方式作为异步方法。

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

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘open’：WebSocket的打开事件。
callbackAsyncCallback否回调函数。

示例：

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’)

on(type: ‘message’, callback: AsyncCallback<string | ArrayBuffer>): void

订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。

 说明：  AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘message’：WebSocket的接收到服务器消息事件。
callbackAsyncCallback<stringArrayBuffer 8+>是

示例：

let ws = webSocket.createWebSocket();
ws.on('message', (err, value) => {
	console.log("on message, message:" + value);
});

off(‘message’)

off(type: ‘message’, callback?: AsyncCallback<string | ArrayBuffer>): void

取消订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。

 说明：  AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘message’：WebSocket的接收到服务器消息事件。
callbackAsyncCallback<stringArrayBuffer 8+>否

示例：

let ws = webSocket.createWebSocket();
ws.off('message');

on(‘close’)

on(type: ‘close’, callback: AsyncCallback<{ code: number, reason: string }>): void

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

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘close’：WebSocket的关闭事件。
callbackAsyncCallback<{ 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);
});

off(‘close’)

off(type: ‘close’, callback?: AsyncCallback<{ code: number, reason: string }>): void

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

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

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘close’：WebSocket的关闭事件。
callbackAsyncCallback<{ code: number, reason: string }>否回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.off('close');

on(‘error’)

on(type: ‘error’, callback: ErrorCallback): void

订阅WebSocket的Error事件，使用callback方式作为异步方法。

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘error’：WebSocket的Error事件。
callbackErrorCallback是回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.on('error', (err) => {
	console.log("on error, error:" + JSON.stringify(err))
});

off(‘error’)

off(type: ‘error’, callback?: ErrorCallback): void

取消订阅WebSocket的Error事件，使用callback方式作为异步方法。

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

系统能力：SystemCapability.Communication.NetStack

参数：

参数名类型必填说明
typestring是‘error’：WebSocket的Error事件。
callbackErrorCallback否回调函数。

示例：

let ws = webSocket.createWebSocket();
ws.off('error');

WebSocketRequestOptions

建立WebSocket连接时，可选参数的类型和说明。

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

参数名类型必填说明
headerObject否建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。

WebSocketCloseOptions

关闭WebSocket连接时，可选参数的类型和说明。

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

参数名类型必填说明
codenumber否错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。
reasonstring否原因值，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为空字符串（“”）。

close错误码说明

发送给服务端的错误码可以自行定义，下面的列表仅供参考。

系统能力：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。

值说明
1000正常关闭
1001服务器主动关闭
1002协议错误
1003无法处理的数据类型
1004~1015保留值

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1861650.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

python基础篇（4）：range语句

python基础篇（4）：range语句

1 功能介绍 range语句的功能是获得一个数字序列&#xff08;可迭代类型的一种&#xff09; 2 语法 语法1&#xff1a; range(num) 获取一个从0开始&#xff0c;到num结束的数字序列&#xff08;不含num本身&#xff09; 如range(5)取得的数据是&#xff1a;[0, 1, 2, 3, 4…
阅读更多...
springboot多数据源应用，A服务依赖于B服务jar包，A服务和B服务业务数据分别入自己的库如何做？

springboot多数据源应用，A服务依赖于B服务jar包，A服务和B服务业务数据分别入自己的库如何做？

上一节我们简单阐述了springboot多数据源如何配置。在实际的业务场景中我们常常遇到A服务依赖于B服务jar包&#xff0c;A服务和B服务业务数据分别入自己的库中。为何要这么做呢&#xff1f;比如B服务是日志SDK&#xff0c;A服务集成B服务来实现记录日志的功能&#xff0c;但是日…
阅读更多...
安卓直装植物大战僵尸杂交版V2.1版完美运行

安卓直装植物大战僵尸杂交版V2.1版完美运行

在移动游戏的世界里&#xff0c;植物大战僵尸无疑是一款深受玩家喜爱的经典游戏。如今&#xff0c;随着技术的发展和玩家需求的变化&#xff0c;植物大战僵尸杂交版V2.1版应运而生&#xff0c;为安卓用户带来了全新的游戏体验。 这一全新版本在原有游戏的基础上进行了多项创新…
阅读更多...
TOP 5免费音频转换器，轻松搞定音频格式转换（白嫖党必备）

TOP 5免费音频转换器，轻松搞定音频格式转换（白嫖党必备）

你是否正在寻找能提升音乐体验并满足各种需求的好用的免费音频转换器呢&#xff1f;如果是的话&#xff0c;那么请不用再找了&#xff01;在本篇文章中&#xff0c;我们汇总了顶级的音频格式转换软件&#xff0c;并且列出了其所兼容的操作系统及适合人群&#xff0c;从而满足你…
阅读更多...
【PyTorch函数解析】einsum的用法示例

【PyTorch函数解析】einsum的用法示例

一、前言 einsum 是一个非常强大的函数&#xff0c;用于执行张量&#xff08;Tensor&#xff09;运算。它的名称来源于爱因斯坦求和约定&#xff08;Einstein summation convention&#xff09;&#xff0c;在PyTorch中&#xff0c;einsum 可以方便地进行多维数组的操作和计算…
阅读更多...
PCL笔记二 之VS环境配置（不同版本Debug+Release编译）

PCL笔记二 之VS环境配置（不同版本Debug+Release编译）

PCL笔记二 之VS环境配置&#xff08;不同版本DebugRelease编译&#xff09; PCL官网&#xff1a;https://github.com/PointCloudLibrary/pcl/releases众所周知&#xff0c;PCL是一个用于点云处理并且依赖不少三方库的一个算法库&#xff0c;同时在编译配置环境时也很复杂&…
阅读更多...
【ONLYOFFICE8.1桌面编辑器】强势来袭—— 一款全面的办公软件套件

【ONLYOFFICE8.1桌面编辑器】强势来袭—— 一款全面的办公软件套件

在日常工作和学习中&#xff0c;我们经常需要处理各种文档、表格和演示文稿。一款功能强大、易于使用的办公软件成为我们提高工作效率、便捷沟通和展示想法的得力助手。 而ONLYOFFICE 8.1桌面编辑器正是一款全面、高效的办公软件&#xff0c;集合了Word、PPT、Excel的功能&…
阅读更多...
如何设置windows计划任务

如何设置windows计划任务

如何设置windows计划任务 前言&#xff1a;在工作过程中写了一个python脚本&#xff0c;用于调用jira接口查询bug单数量&#xff0c;想要在本地定时任务执行&#xff0c;每天发送到钉钉群提醒&#xff0c;写下操作步骤用于记录。 1. 准备 Python 脚本 确保你的 Python 脚本已…
阅读更多...
暗影精灵8Pro声音没有了，这个方法可以解决，亲测有效！

暗影精灵8Pro声音没有了，这个方法可以解决，亲测有效！

这个OMEN by HP Gaming Laptop 16-k0xxx Windows 10 Sound Driver Mod &#xff0c;真的解决了我的大问题&#xff01; 如果你的暗影精灵8 Pro酷睿版突然变得哑巴了&#xff0c;扬声器和麦克风都发不出声音&#xff0c;那可能是声卡驱动出了问题。 别担心&#xff0c;我也是个…
阅读更多...
Android简介

Android简介

1. Android简介 Android是一种基于Linux内核的自由及开放源代码的操作系统。最初是由安迪鲁宾(Andy Rubin)开发的一款相机操作系统。2005年8月被Google收购。2007年11月&#xff0c;Google与84家硬件制造商、软件开发商及电信营运商组建开放手机联盟共同研发改良Android系统。…
阅读更多...
8.12 矢量图层面要素单一符号使用七(随机标记填充)

8.12 矢量图层面要素单一符号使用七(随机标记填充)

文章目录 前言随机标记填充&#xff08;Random Marker Fill&#xff09;QGis设置面符号为随机标记填充&#xff08;Random Marker Fill&#xff09;二次开发代码实现随机标记填充&#xff08;Random Marker Fill&#xff09; 总结 前言 本章介绍矢量图层线要素单一符号中使用随…
阅读更多...
手机照片压缩到20k以内免费，这几款心动软件快收好！

手机照片压缩到20k以内免费，这几款心动软件快收好！

在数字化时代&#xff0c;手机拍照已成为我们记录生活的重要方式之一。然而&#xff0c;高清的照片也意味着占用着越来越多的手机存储空间。如果你正在为手机内存告急而烦恼&#xff0c;那么这几款手机照片压缩神器或许能成为你的救星&#xff01;它们不仅可以将照片轻松压缩至…
阅读更多...
Three.js——第一篇：部署以及基础代码创建场景、GUI调整样式

Three.js——第一篇：部署以及基础代码创建场景、GUI调整样式

three.js官网&#xff1a;three.js docs 中文技术文档1&#xff1a;| 麒跃科技 中文技术文档2&#xff1a;3. 开发和学习环境&#xff0c;引入threejs | Three.js中文网 很多教程一开始要大家自己部署three.js的中文本地部署&#xff0c;我就不弄了&#xff0c;我弄了半天也没…
阅读更多...
大厂薪资福利篇第四弹：字节跳动

大厂薪资福利篇第四弹：字节跳动

欢迎来到绝命Coding&#xff01; 今天继续更新大家最关心的 大厂薪资福利系列&#xff01; 往期分享&#xff1a; 福利开水喝不完&#xff1f;大厂薪资福利篇&#xff01;美团 职场文化发源地&#xff1f;大厂薪资福利篇&#xff01;阿里巴巴 给这么多&#xff01;还能带宠物上…
阅读更多...
Adams Flex模块功能介绍

Adams Flex模块功能介绍

通过该教程对Adams Flex模块有基本的认知&#xff0c;为以后使用柔性体进行刚柔耦合做好基础学习。 有需要购买的可以邮箱&#xff08;digitaltwins126.com&#xff09;或站内信联系&#xff0c;谢谢&#xff01;
阅读更多...
机器学习之数学基础(七)～过拟合(over-fitting)和欠拟合(under-fitting)

机器学习之数学基础(七)～过拟合(over-fitting)和欠拟合(under-fitting)

目录 1. 过拟合与欠拟合 1.1 Preliminary concept 1.2 过拟合 over-fitting 1.3 欠拟合 under-fitting 1.4 案例解析&#xff1a;黑天鹅 1. 过拟合与欠拟合 1.1 Preliminary concept 误差 经验误差&#xff1a;模型对训练集数据的误差。泛化误差&#xff1a;模型对测试…
阅读更多...
基于SpringBoot的“智慧食堂”管理系统设计与实现

基于SpringBoot的“智慧食堂”管理系统设计与实现

你好呀&#xff0c;我是计算机学姐码农小野&#xff01;如果有相关需求&#xff0c;可以私信联系我。 开发语言&#xff1a;Java 数据库&#xff1a;MySQL 技术&#xff1a;SpringBootVue 工具&#xff1a;IDEA/Eclipse、Navicat、Maven 系统展示 首页 用户管理界面 菜品…
阅读更多...
超炫酷， 不用学前端也能自己做网页！这个Python库，3分钟内复刻GPT WEB应用

超炫酷， 不用学前端也能自己做网页！这个Python库，3分钟内复刻GPT WEB应用

大家好&#xff0c;我是海鸽。 今天&#xff0c;我要和大家分享如何将请求 GPT 的案例&#xff0c;快速“复刻”成 GPT 网页版。这不仅简单&#xff0c;而且对于我们这些后端开发者来说&#xff0c;简直是福音&#xff01; 先睹为快 看看这个界面&#xff0c;是不是感觉很熟…
阅读更多...
更适合敏感口腔的护理牙刷

更适合敏感口腔的护理牙刷

最近在用一款清九野小红盾舒敏牙刷&#xff0c;感觉它很适合牙龈敏感的人&#xff0c;让刷牙体验有了显著的提升。这款牙刷的柔软刷毛和精细设计让我的刷牙过程变得轻松愉快。它的内外圈双重植毛技术&#xff0c;在清洁牙齿的同时&#xff0c;还能深入牙缝&#xff0c;温和地去…
阅读更多...
js实现数据加密，jwt加密方式

js实现数据加密，jwt加密方式

一个简单的数据加密 const crypto require("crypto");// 普通的数据加密 function sign(msg,key){ // 原始信息&#xff0c;密钥 String// "sha256" :加密的算法&#xff0c;key :密钥&#xff0c;msg :要加密的信息&#xff0c;"hex" :转成16…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023