web udp下载 - web udp源代码下载

web udp

其他类别

1.0.0

下载

Web-udp

Web-UDP是一个库，用于在节点/浏览器环境中建立不可靠的数据通道。该项目提供一个小型稳定的API的关键目标，任何人都可以用来使用网络上的实时数据。

该库目前是在无序和不可靠的RTCDATACHANNELS之上实现的。由于WEBRTC是一种依赖关系，因此包含基于Websoket的信号服务器，以促进客户端之间的连接。客户/服务器连接可借助WRTC软件包。

API

 Signal < T > . subscribe ( subscriber : T => any )
Signal < T > . unsubscribe ( subscriber : T => any )

Client ( options ?: { url ?: string } )
Client . connect ( to ?: string = "__MASTER__" , options ?: {
  binaryType ?: "arraybuffer" | "blob" ,
  maxRetransmits ?: number ,
  maxPacketLifeTime ?: number ,
  metadata ?: any ,
  UNSAFE_ordered ?: boolean
} ) : Promise < Connection >
Client . route ( ) : Promise < string >
Client . connections : Signal < Connection >

Connection . send ( message : any ) : void
Connection . close ( ) : void
Connection . closed : Signal
Connection . errors : Signal < { err : string } >
Connection . messages : Signal < any >
Connection . metadata : any

// Node
Server ( { server : http . Server , keepAlivePeriod ?: number = 30000 } )
Server . client ( ) : Client
Server . connections : Signal < Connection >

安装

npm i @web-udp/client
npm i @web-udp/server

例子

客户端/服务器

以下是Ping服务器的一个简单示例：

 // client.js

import { Client } from "@web-udp/client"

async function main ( ) {
  const udp = new Client ( )
  const connection = await udp . connect ( )

  connection . send ( "ping" )
  connection . messages . subscribe ( console . log )
}

 // server.js

const server = require ( "http" ) . createServer ( )
const { Server } = require ( "@web-udp/server" )

const udp = new Server ( { server } )

udp . connections . subscribe ( connection => {
  connection . messages . subscribe ( message => {
    if ( message === "ping" ) {
      connection . send ( "pong" )
    }
  } )

  connection . closed . subscribe ( ( ) => console . log ( "A connection closed." ) )

  connection . errors . subscribe ( err => console . log ( err ) )
} )

server . listen ( 8000 )

元数据

Client.connect中的metadata选项用于建立连接后立即发送任意握手数据。建立新连接后，远程客户端可以在连接对象的metadata属性上访问此数据，而无需订阅远程客户端的消息。握手元数据通过安全的RTCDataChannel传输，使其成为诸如密码之类的敏感数据的良好候选者。

在下面的示例中，服务器在订阅客户端消息之前处理身份验证：

 // client.js

const connection = await udp . connect ( {
  metadata : {
    credentials : {
      username : "foo" ,
      password : "bar" ,
    } ,
  } ,
} )

 // server.js

udp . connections . subscribe ( connection => {
  let user

  try {
    user = await fakeAuth . login ( connection . metadata . credentials )
  } catch ( err ) {
    // Authentication failed, close connection immediately.
    connection . send ( fakeProtocol . loginFailure ( ) )
    connection . close ( )
    return
  }
  // The user authenticated successfully.
  connection . send ( fakeProtocol . loginSuccess ( user ) )
  connection . messages . subscribe ( ... )
} )

P2P

web-udp还支持点对点交流。下面的示例演示了两个在同一浏览器选项卡中连接的客户端：

 <!-- index.html -->

< script src =" /node_modules/@web-udp/client/dist/index.js " > </ script >
< script src =" client.js " > </ script >

 // client.js

async function main ( ) {
  const left = new Udp . Client ( )
  const right = new Udp . Client ( )
  const route = await left . route ( )
  const connection = await right . connect ( route )

  left . connections . subscribe ( connection =>
    connection . messages . subscribe ( console . log ) ,
  )

  connection . send ( "HELLO" )
}

 // server.js

const server = require ( "http" ) . createServer ( )
const { Server } = require ( "@web-udp/server" )

Server ( { server } )

server . listen ( 8000 )

可靠性

Client.connect （可选）选择RTCDATACHANNEL maxPacketLifeTime和maxRetransmits选项。这些选项可用于启用无序可靠的数据频道。

已知问题

Websocket用作信号传输。在建立Datachannel以转发其关闭事件（例如关闭浏览器选项卡时）以终止悬挂web-udp连接后，该插座将保持打开状态。在主机带有连接超时的情况下，定期发送keetalive信号，以保持插座打开。可以通过服务器的keepAlivePeriod选项配置发送keepalive信号的周期。