ssocket-js
v1.0.29
Published
仿 Koa 中间件控制的 WebSocket 服务的 Web 客户端程序
Downloads
48
Maintainers
summer.liReadme
仿 Koa 中间件控制的 WebSocket 服务对应的客户端程序，食用简单，上手容易, 支持 GZIP 解压缩和 ProtoBuffer 解压缩配置，觉得小弟写的还行的话，就给个Star⭐️吧~
使用说明
点击安装服务端程序
npm i -s ssocket建立连接
网页食用方式
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
</body>
<script src="./build/ssocket.min.js"></script>
<script>
window.onload = function(){
const client = new Ssocket("ws[wss]://ip[:port]", {
/**ping 超时时间单位：毫秒 */
ping_timeout: 1000 * 60,
/**ping 间隔时间：单位毫秒 */
ping_time: 1000 * 1,
/**重连次数 */
reconnection_count: 60,
/**每次重连的间隔：单位毫秒 */
reconnection_time: 1000 * 2,
})
}
</script>
</html>Webpack/vue/react 食用方式
// npm i -s ssocket-js
const Ssocket = require("ssocket-js");
const client = new Ssocket("ws[wss]://ip[:port]", {
/**ping 超时时间单位：毫秒 */
ping_timeout: 1000 * 60,
/**ping 间隔时间：单位毫秒 */
ping_time: 1000 * 1,
/**重连次数 */
reconnection_count: 60,
/**每次重连的间隔：单位毫秒 */
reconnection_time: 1000 * 2,
})基础事件监听
client.on("close", function(id, code, reason){
console.log("客户端ID", id)
console.log("断开代码", code)
console.log("断开原因", reason)
})
client.on("open", function(){
console.log("连接打开, 开始握手, 此时还不能发送消息")
})
client.on("connection", function(){
console.log("与服务端握手成功， 此时可以开始发送消息")
})
client.on("shakehands", function(status){
console.log("握手状态", status)
})
client.on("reconnectioning", function(count){
console.log("开始重连， 剩余重连次数", count)
})
client.on("reconnection", function(){
console.log("重连成功")
})
client.on("pong", function(server_now_time){
console.log("心跳服务器回应，此时服务器当前时间是", server_now_time)
})
client.on("ping", function(){
console.log("客户端发送一次心跳包")
})
client.on("test", function(ctx){
console.log("收到服务端事件响应")
console.log("返回码", ctx.status)
console.log("返回描述", ctx.msg)
console.log("返回数据", ctx.data)
})发送消息
client.request("test", { id: 123 })
client.request("test", { id: 123 }, function(ctx){
console.log("收到服务端请求返回", )
console.log("返回码", ctx.status)
console.log("返回描述", ctx.msg)
console.log("返回数据", ctx.data)
})
ProtoBuffer 解压缩配置
const client = new Ssocket("ws[wss]://ip[:port]", {
/**protos 开启压缩并配置：注 当数据量大于 128 字节的时候自动开启 GZIP 压缩 */
protos: {
// 配置请求编码
request:{
"test":{
/**
* [required单字段|repeated重复字段|message自定义结构] [string|uint[8|16|32]|float|double] fieldname: 序号同级唯一
*/
"required string username": 0,
}
},
// 配置响应编码
response:{
"test":{
/**
* [required单字段|repeated重复字段|message自定义结构] [string|uint[8|16|32]|float|double] fieldname: 序号同级唯一
*/
"required string username": 0,
"required uint8 age": 1,
"required uint32 amount": 2,
"required string avatar": 3,
"required Data test": 4,
"message Data": {
"required string usernmae": 0,
"repeated List list": 1,
"message List": {
"required uint32 id": 0,
},
},
}
}
}
})
client.request("test", {
username:"测试账号",
}, function(ctx){
console.log("返回状态", ctx.status)// 200
console.log("返回说明", ctx.msg)// ok
console.log("返回数据", ctx.data) // { username:"登录成功，欢迎测试账号" }
})