anysocket

N'importe quelle prise

Une couche réseau abstraite sur plusieurs transports, indépendante du client/serveur avec prise en charge d'E2EE

• Caractéristiques
• Repères
• Installation
• Usage
• Documentation/API
• Fonctionnalités à venir
• Licence

Important

Il s'agit d'un travail en cours et l'API est susceptible de changer.

Caractéristiques

• Indépendant du client/serveur
• Prise en charge de la demande/réponse
• Méthode AUTH personnalisée
• E2EE entre pairs avec secret transmis
• Prise en charge du RPC
• Prise en charge de la synchronisation NTP entre pairs
• P2P utilisant un serveur proxy (avec prise en charge de l'E2EE direct entre pairs)
• Prise en charge binaire ( voir : AnySocket.Packer )
• Prise en charge du navigateur - empreinte de 31 Ko ( voir : /dist/anysocket.browser.js )
• Transports multiples *(atm implémenté : ws/wss , http/https )
• Tous les pairs ont un UUIDv4 associé
• Détection de déconnexion à l'aide d'un battement de coeur
• Pas encore testé au combat .

** Le transport http est expérimental

Info : les arguments et réponses binaires RPC sont automatiquement compressés/décompressés ( AnySocket.Packer.pack / AnySocket.Packer.unpack ).

Repères

Voir les benchmarks

Installation

 npm install -- save anysocket

ou

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

ou (si vous utilisez AnySocketHTTP)

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

Comment utiliser

L'exemple suivant démarre un serveur Websocket sur le 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 ) ;
} ) ;

L'exemple suivant se connecte à un websocket sur le port 3000

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

Plus d'informations dans le dossier examples .

Documentation

Voir le dossier documentation et exemples

Fonctionnalités à venir

• Réseau maillé
• Transports multiples : tcp , udp *, ipc
• Reconnexion client

* cela nécessitera un changement dans le protocole, car celui-ci suppose que les paquets sont envoyés à l'aide d'une connexion fiable et ordonnée.

Licence

MIT