anysocket

AnySocket

Eine abstrakte Netzwerkschicht über mehrere Transporte, Client/Server-unabhängig mit Unterstützung für E2EE

• Merkmale
• Benchmarks
• Installation
• Verwendung
• Dokumentation / API
• Kommende Funktionen
• Lizenz

Wichtig

Dies ist noch in Arbeit und die API kann sich ändern.

Merkmale

• Client-/Server-unabhängig
• Unterstützung für Anfrage/Antwort
• Benutzerdefinierte AUTH-Methode
• E2EE zwischen Peers mit Vorwärtsgeheimnis
• RPC-Unterstützung
• Unterstützung für NTP-Synchronisierung zwischen Peers
• P2P über einen Proxyserver (mit Unterstützung für direktes E2EE zwischen Peers)
• Binärunterstützung ( siehe: AnySocket.Packer )
• Browserunterstützung – 31 KB Speicherbedarf ( siehe: /dist/anysocket.browser.js )
• Mehrere Transporte * (implementiertes atm: ws/wss , http/https )
• Allen Peers ist eine UUIDv4 zugeordnet
• Trennungserkennung mittels Heartbeat
• Noch nicht kampferprobt

** HTTP- Transport ist experimentell

Info: Binäre RPC-Argumente und -Antworten werden automatisch gepackt/entpackt ( AnySocket.Packer.pack / AnySocket.Packer.unpack ).

Benchmarks

Siehe Benchmarks

Installation

 npm install -- save anysocket

oder

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

oder (bei Verwendung von AnySocketHTTP)

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

Wie zu verwenden

Das folgende Beispiel startet einen Websocket-Server auf Port 3000.

 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 ) ;
} ) ;

Im folgenden Beispiel wird eine Verbindung zu einem Websocket auf Port 3000 hergestellt

 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 ) ;
} ) ;

Mehr im examples .

Dokumentation

Siehe Dokumentations- und Beispielordner

Kommende Funktionen

• Mesh-Netzwerk
• Mehrere Transporte: tcp , udp *, ipc
• Wiederverbindung des Clients

* Dies erfordert eine Änderung des Protokolls, da das Protokoll davon ausgeht, dass die Pakete über eine zuverlässige, geordnete Verbindung gesendet werden

Lizenz

MIT