socket-sync-buffer
v1.3.2
Published
promise wrap for Net.socket
Downloads
4
Readme
node-socket-sync-buffer
同步操作socket, 基于 promise, 见例子 examples
网址: https://gitee.com/linuxmail/node-socket-sync-buffer
基本用法
创建对象
const socketSyncBuffer = require("socket-sync-buffer").socketSyncBuffer
// host: string, 地址
// port: number, 端口
// ssl?: boolean, 是否开启ssl
// timeout?: number, 读写超时(毫秒)
// rejectUnauthorized?: boolean, 如果证书有问题是否拒绝连接
let socket = new socketSyncBuffer({ host: "127.0.0.1", port: 465, ssl: false, timeout: 0 })
连接
返回值是 boolean 类型, 返回 false 表示连接失败, 返回 true 表示成功
let res = await socket.connect()
读数据
返回 null 表示网络失败, 或连接关闭, 否则表示成功, 类型为 Buffer
// 读一行,
let res = await socket.gets()
let res = await socket.readDelimiter("\n")
// 读到指定字符(长度为 1)
// 最多读取 maxSize个字符, maxSize为 0 表示不限制
let res = await socket.readDelimiter(delimiter: string, maxSize: number = 0)
// 读指定长度的数据
let res = await socket.readn(size: number)
// 读数据, 数据长度不定
let res = await socket.read()
写数据
返回值是 boolean 类型, 返回 false 表示网络错误,或连接关闭,返回 true 表示成功
// 写 string
let res = await socket.write(str: string)
// 写 Buffer
let res = await socket.writeBuffer(buf: Buffer)
// flush 写缓存
let res = await socket.flush()
发起 ssl 连接
返回值是 boolean 类型, 返回 false 表示网络错误,或连接关闭,返回 true 表示成功
let res = await socket.tlsConnect()
属性
返回值是 boolean 类型
// 是否出错, 一般指的是网络错误
let res = socket.isError()
// 是否超时错误
let res = socket.isTimeout()
// 是否连接关闭
let res = socket.isClosed()