鸿蒙开发网络管理：【@ohos.net.webSocket (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';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.mzph.cn/news/860412.shtml

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

相关文章

c++ 常用的锁及用法介绍和示例

c++ 常用的锁及用法介绍和示例

2024/6/21 14:20:10 在 C++ 中，常用的锁主要包括以下几种：std::mutex、std::recursive_mutex、std::timed_mutex 和 std::shared_mutex。这些锁可以帮助我们在多线程编程中保护共享数据，避免竞争条件。以下是每种锁的介绍及其用法示例： std::mutex std::mutex 是最基本的互…
阅读更多...
初识仓颉语言

初识仓颉语言

仓颉编程语言是一种面向全场景应用开发的通用编程语言&#xff0c;可以兼顾开发效率和运行性能&#xff0c;并提供良好的编程体验&#xff0c;主要具有如下特点&#xff1a; 语法简明高效&#xff1a;仓颉编程语言提供了一系列简明高效的语法&#xff0c;旨在减少冗余书写、提升…
阅读更多...
接口测试代码和工具

接口测试代码和工具

通过python的requests给接口发送请求进行测试 #coding:utf-8 import requests class TestApi(): url_login "https://legend-sit.omodaglobal.com/api/auth/oauth2/token" url_topic_b "https://legend-sit.omodaglobal.com/api/community/topic_b/page?…
阅读更多...
Python polars学习-07 缺失值

Python polars学习-07 缺失值

背景 polars学习系列文章&#xff0c;第7篇 缺失值 该系列文章会分享到github&#xff0c;大家可以去下载jupyter文件&#xff0c;进行参考学习 仓库地址&#xff1a;https://github.com/DataShare-duo/polars_learn 小编运行环境 import sysprint(python 版本&#xff1a;…
阅读更多...
快手商品详情的应用范围和请求示例笔记

快手商品详情的应用范围和请求示例笔记

应用范围&#xff1a; 快手商品详情的应用范围广泛&#xff0c;主要体现在以下几个方面&#xff1a; 用户购买决策支持&#xff1a; 用户通过查看快手商品详情页&#xff0c;可以获取商品的详细信息&#xff0c;如名称、价格、库存、产地、规格、材质、功能特点等。 商品详…
阅读更多...
Vue71-嵌套（多级）路由

Vue71-嵌套（多级）路由

一、需求 二、开发步骤 2-1、编写路由组件 2-2、编写路由规则 2-3、编写路由标签<router-link>、<router-view> 三、小结
阅读更多...
计算预卷积特征

计算预卷积特征

当冻结卷积层和训练模型时&#xff0c;全连接层或dense层(vgg.classifier)的输入始终是相同的。为了更好地理解&#xff0c;让我们将卷积块(在示例中为vgg.features块)视为具有了已学习好的权重且在训练期间不会更改的函数。因此&#xff0c;计算卷积特征并保存下来将有助于我们…
阅读更多...
阿里云云服务器、ACR镜像服务、容器化实战：搭建企业应用

阿里云云服务器、ACR镜像服务、容器化实战：搭建企业应用

一、容器化基础知识 华为云免费试用服务器&#xff1a;https://activity.huaweicloud.com/free_test/index.html 阿里云docker容器教程&#xff1a;https://edu.aliyun.com/course/3111900/lesson/341807097 查询ip地址&#xff1a;www.ip138.com 二、容器化搭建企业应用实战 2…
阅读更多...
2.中国菜刀使用详解（OWASP实战训练）

2.中国菜刀使用详解（OWASP实战训练）

2.中国菜刀使用详解&#xff08;OWASP实战训练&#xff09;&#xff08;OWASP实战训练&#xff09; Webshell&#xff08;1&#xff09;shell2.php #eval 使用PHP函数&#xff0c;例如PHPinfo&#xff08;2&#xff09;Shell3.php #system 使用Linux系统命令&#xff0c;列如ls…
阅读更多...
【已解决】Python报错：NameError: name ‘Image‘ is not defined

【已解决】Python报错：NameError: name ‘Image‘ is not defined

&#x1f60e; 作者介绍&#xff1a;我是程序员行者孙&#xff0c;一个热爱分享技术的制能工人。计算机本硕&#xff0c;人工制能研究生。公众号&#xff1a;AI Sun&#xff0c;视频号&#xff1a;AI-行者Sun &#x1f388; 本文专栏&#xff1a;本文收录于《AI实战中的各种bug…
阅读更多...
性能评测系列（PT-010）：Spring Boot + MySQL，高并发insert

性能评测系列（PT-010）：Spring Boot + MySQL，高并发insert

一、测试概述 测试场景 场景编号&#xff1a; PT-010场景描述&#xff1a; Java应用&#xff0c;MySQL单表写测试目的&#xff1a;指定规格、配置、环境下&#xff0c;Java应用数据库简单写场景负载能力评估。&#xff08;不含调优&#xff0c;所测结果未必是最优结果&#x…
阅读更多...
软RAID

软RAID

硬盘 连续空间 无法 扩容 lvm 非连续空间 可以动态扩容 raid 备份&#xff0c; 提高读写性能&#xff0c;不能扩容 raid 是磁盘的集合&#xff0c;按照排列组合的方法不 一&#xff0c;给 raid 去了不同的名字 raid0 raid1 raid5 raid10 什么是 RAID "RAID"…
阅读更多...
计算机网络之UDP协议

计算机网络之UDP协议

一.什么是UDP协议&#xff1a; 1.1UDP的基本概念 UDP协议又叫做用户数据报协议&#xff0c;是一个目标在传输层提供直接发送报文的能力&#xff0c;UDP与TCP相比&#xff0c;它不会拆分数据&#xff0c;它只是能够发送报文。 1.2为什么要使用UDP协议 我们可能会想&#xff0c;如…
阅读更多...
three.js - MeshPhongMaterial材质

three.js - MeshPhongMaterial材质

phong网格材质&#xff1a;Mesh - Phong - Material 一种用于具有镜面高光的光泽表面的材质。 它可以模拟&#xff0c;具有镜面高光的光泽表面&#xff0c;提供镜面反射效果。 MeshPhongMaterial&#xff1a; MeshPhongMaterial是一种基于Phong光照模型的材质&#xff0c;主要…
阅读更多...
工作记录2

工作记录2

1. 要实现y轴超出部分滚动的效果&#xff0c;可以这样写 <div style"max-height: 384px; overflow-y: auto;"> </div> 2. 当后端接口还没好的时候&#xff0c;可以自己模拟一下接口返回的数据 export const getCommodityDetail (id) > Promise.re…
阅读更多...
MySQL入门学习-连接查询.复杂连接

MySQL入门学习-连接查询.复杂连接

复杂连接是指涉及多个表之间的连接操作&#xff0c;通过使用条件和连接类型来组合和关联这些表的数据。 一、常见的复杂连接类型及其特点、使用方法和示例代码&#xff1a; 1. INNER JOIN&#xff08;内连接&#xff09;&#xff1a; - 特点&#xff1a;返回两个表中满足连接…
阅读更多...
构建实用的Flutter文件列表：从简到繁的完美演进

构建实用的Flutter文件列表：从简到繁的完美演进

前言&#xff1a;为什么我们需要文件列表&#xff1f; 在现代科技发展迅速的时代&#xff0c;我们的电脑、手机、平板等设备里积累了大量的文件&#xff0c;这些文件可能是我们的照片、文档、音频、视频等等。然而&#xff0c;当文件数量增多时&#xff0c;我们如何快速地找到…
阅读更多...
HTML(20)——定位

HTML(20)——定位

定位 作用&#xff1a;灵活的改变盒子在网页中的位置 实现&#xff1a; 定位模式&#xff1a;position边偏移&#xff1a;设置盒子的位置 leftrighttopbottom 相对定位 position&#xff1a;relative 改变位置的参照物是自己原来的位置&#xff0c;并且不脱标占位&#x…
阅读更多...
程序员是干嘛的？程序员在职场中的重要性

程序员是干嘛的？程序员在职场中的重要性

程序员是干嘛的&#xff1f;程序员在职场中的重要性 随着科技的飞速发展&#xff0c;计算机技术得到了广泛应用&#xff0c;程序员也成为了当今职场中不可或缺的一部分。那么&#xff0c;程序员究竟是干什么的呢&#xff1f;他们为什么如此重要&#xff1f;下面我们来详细探讨一…
阅读更多...
驾校预约管理系统

驾校预约管理系统

摘 要 随着驾驶技术的普及和交通安全意识的增强&#xff0c;越来越多的人选择参加驾校培训&#xff0c;以获取驾驶执照。然而&#xff0c;驾校管理面临着日益增长的学员数量和繁琐的预约管理工作。为了提高驾校的管理效率和服务质量&#xff0c;驾校预约管理系统成为了必不可少…
阅读更多...
最新文章

Copyright @ 2022~2023