anysocket

エニーソケット

複数のトランスポートにわたる抽象ネットワーキング層、クライアント/サーバーに依存せず、E2EE をサポート

• 特徴
• ベンチマーク
• インストール
• 使用法
• ドキュメント/API
• 今後の機能
• ライセンス

重要

これは進行中の作業であり、API は変更される可能性があります。

特徴

• クライアント/サーバーに依存しない
• リクエスト/リプライのサポート
• カスタムAUTHメソッド
• 前方秘匿性を備えたピア間の E2EE
• RPC サポート
• ピア間の NTP 同期のサポート
• プロキシ サーバーを使用した P2P (ピア間の直接 E2EE をサポート)
• バイナリのサポート ( AnySocket.Packerを参照)
• ブラウザのサポート- 31kb のフットプリント (参照: /dist/anysocket.browser.js )
• 複数のトランスポート *(実装された atm: ws/wss 、 http/https )
• すべてのピアには UUIDv4 が関連付けられています
• ハートビートによる切断検出
• 戦闘テストはまだ行われていません...まだ

** httpトランスポートは実験的なものです

情報: バイナリ RPC 引数と応答は自動的にパック/アンパックされます ( AnySocket.Packer.pack / AnySocket.Packer.unpack )。

ベンチマーク

ベンチマークを参照

インストール

 npm install -- save anysocket

または

 < script src =" /dist/anysocket.browser.js " > </ script >

または(AnySocketHTTP を使用している場合)

 < script src =" @anysocket " > </ script > 

使用方法

次の例では、ポート 3000 で WebSocket サーバーを起動します。

 const AnySocket = require ( "anysocket" ) ;
const server = new AnySocket ( ) ;
const PORT = 3000 ;
server . listen ( "ws" , PORT )
    . then ( ( ) => {
        console . log ( "Listening on port:" , PORT ) ;
    } )
    . catch ( ( err ) => {
        console . error ( "Failed to start server:" , err ) ;
    } ) ;
server . on ( "connected" , async ( peer ) => {
    console . log ( "Connected" , peer . id ) ;
    console . log ( await peer . getSyncedTime ( ) ) // { time: 1674671482107, rtt: 2, offset: 0 }
    peer . send ( {
        hello : "world"
    } ) ;
} ) ;
server . on ( "message" , ( packet ) => {
    console . log ( "From:" , packet . peer . id , "Message:" , packet . msg ) ;
} ) ;
server . on ( "disconnected" , ( peer , reason ) => {
    console . log ( "Disconnected" , peer . id , "Reason:" , reason ) ;
} ) ;

次の例では、ポート 3000 の WebSocket に接続します。

 const AnySocket = require ( "anysocket" ) ;
const client = new AnySocket ( ) ;
const PORT = 3000 ;
client . connect ( "ws" , "127.0.0.1" , PORT )
    . then ( ( ) => {
        console . log ( "Connected to server" ) ;
    } )
    . catch ( ( err ) => {
        console . error ( "Failed to connect to server:" , err ) ;
    } ) ;

// after negotiating the AUTH packet, it will trigger the connect event
client . on ( "connected" , async ( peer ) => {
    console . log ( "Connected" , peer . id ) ;
    console . log ( await peer . getSyncedTime ( ) ) // { time: 1674671482107, rtt: 2, offset: 0 }
    peer . send ( {
        hello : "world"
    } ) ;
} ) ;
client . on ( "message" , ( packet ) => {
    console . log ( "From:" , packet . peer . id , "Message:" , packet . msg ) ;
} ) ;
client . on ( "disconnected" , ( peer , reason ) => {
    console . log ( "Disconnected" , peer . id , "Reason:" , reason ) ;
} ) ;

詳細については、 examplesフォルダーを参照してください。

ドキュメント

ドキュメントとサンプルフォルダーを参照してください

今後の機能

• メッシュネットワーク
• 複数のトランスポート: tcp 、 udp *、 ipc
• クライアントの再接続

* プロトコルはパケットが信頼性の高い順序付けられた接続を使用して送信されることを前提としているため、これにはプロトコルの変更が必要になります。

ライセンス

マサチューセッツ工科大学