WatsonWebsocket

Watson websocket

Watsonwebsocket est le moyen le plus simple et le plus rapide de créer des applications client et serveur qui s'appuient sur la messagerie à l'aide de WebSockets. C'est. Vraiment. Facile.

Merci et appréciation

Un grand merci et beaucoup d'appréciation à ceux qui prennent le temps d'améliorer cette bibliothèque!

@Bryancrotaz @foddermk @caozero @danatobob @ data33 @ ak5nowman @jjxtra @martyix @ rajoreg @ilSnk @xbarra @ mawkish00 @jloppet @ marco -manfroni-pelugiating @giantizmo @exergiste @ ebarale99 @warstekhun @ rubidium37 @codengine

Application de test

Un projet de test pour le client ( TestClient ) et le serveur ( TestServer ) est inclus, ce qui vous aidera à comprendre et à exercer la bibliothèque de classe.

Un projet de test qui engendre un serveur et un client et échange des messages peut être trouvé ici: https://github.com/jchristn/watsonwebsockettest

Systèmes d'exploitation pris en charge

Watsonwebsocket s'appuie actuellement sur la prise en charge de WebSocket étant présente dans le système d'exploitation sous-jacent. Windows 7 ne prend pas en charge WebSockets.

SSL

SSL est soutenu dans Watsonwebsocket. Les constructeurs de WatsonWsServer et WatsonWsClient acceptent un bool indiquant si SSL doit être activé ou non. Étant donné que WebSockets, et en tant que sous-produit Watsonwebsocket, utilisez HTTPS, ils s'appuient sur des certificats dans le magasin de certificats de votre système d'exploitation. Un certificat de test est fourni dans les projets TestClient et TestServer qui peuvent être utilisés à des fins de test. Ceux-ci ne doivent pas être utilisés dans la production.

Pour plus d'informations sur l'utilisation des certificats SSL, veuillez vous référer au wiki.

Nouveau en v4.0.x

• Changements de rupture
• Clients désormais identifiés par Guid dans ClientMetadata
• ListClients Renvoie désormais ClientMetadata complète
• Send* les méthodes maintenant prenez guid par opposition à IpPort
• Ajouter un ciblage pour .NET 7.0 et .NET Framework 4.8
• Correction pour Blazor Wasm, merci @ ebarale99
• Correction pour les caractères de contrôle non valides, merci @warstekhun

Exemple de serveur

 using WatsonWebsocket ;

WatsonWsServer server = new WatsonWsServer ( "[ip]" , port , true | false ) ;
server . ClientConnected += ClientConnected ;
server . ClientDisconnected += ClientDisconnected ;
server . MessageReceived += MessageReceived ; 
server . Start ( ) ;

static void ClientConnected ( object sender , ConnectionEventArgs args ) 
{
    Console . WriteLine ( "Client connected: " + args . Client . ToString ( ) ) ;
}

static void ClientDisconnected ( object sender , DisconnectionEventArgs args ) 
{
    Console . WriteLine ( "Client disconnected: " + args . Client . ToString ( ) ) ;
}

static void MessageReceived ( object sender , MessageReceivedEventArgs args ) 
{ 
    Console . WriteLine ( "Message received from " + args . Client . ToString ( ) + ": " + Encoding . UTF8 . GetString ( args . Data ) ) ;
} 

Exemple du client

 using WatsonWebsocket ;

WatsonWsClient client = new WatsonWsClient ( "[server ip]" , [ server port ] , true | false ) ;
client . ServerConnected += ServerConnected ;
client . ServerDisconnected += ServerDisconnected ;
client . MessageReceived += MessageReceived ; 
client . Start ( ) ; 

static void MessageReceived ( object sender , MessageReceivedEventArgs args ) 
{
    Console . WriteLine ( "Message from server: " + Encoding . UTF8 . GetString ( args . Data ) ) ;
}

static void ServerConnected ( object sender , EventArgs args ) 
{
    Console . WriteLine ( "Server connected" ) ;
}

static void ServerDisconnected ( object sender , EventArgs args ) 
{
    Console . WriteLine ( "Server disconnected" ) ;
} 

Exemple du client à l'aide du navigateur

 server = new WatsonWsServer ( "http://localhost:9000/" ) ;
server . Start ( ) ; 

 let socket = new WebSocket ( "ws://localhost:9000/test/" ) ;
socket . onopen = function ( ) { console . log ( "success" ) ; } ;
socket . onmessage = function ( msg ) { console . log ( msg . data ) ; } ;
socket . onclose = function ( ) { console . log ( "closed" ) ; } ;
// wait a moment
socket . send ( "Hello, world!" ) ; 

Accéder à partir de l'extérieur localhost

Lorsque vous configurez WatsonWebsocket pour écouter sur 127.0.0.1 ou localhost , il ne répondra qu'aux demandes reçues de la machine locale.

Pour configurer l'accès à partir d'autres nœuds en dehors de localhost , utilisez ce qui suit:

• Spécifiez le nom d'hôte DNS exact sur lequel Watsonwebsocket doit écouter dans le constructeur du serveur. L'en-tête hôte sur les demandes HTTP entrantes doit correspondre à cette valeur (il s'agit d'une limitation du système d'exploitation)
• Si vous souhaitez écouter plus d'un nom d'hôte ou d'une adresse IP, utilisez * ou + . Vous devez:
  • Exécutez Watsonwebsocket en tant qu'administrateur pour ce fonctionnement (il s'agit d'une limitation du système d'exploitation)
  • Utilisez le constructeur du serveur qui prend des valeurs d'hôte et de port distinctes (pas le constructeur basé sur URI)
• Si vous souhaitez utiliser un numéro de port inférieur à 1024, vous devez exécuter Watsonwebsocket en tant qu'administrateur (il s'agit d'une limitation du système d'exploitation)
• Si vous écoutez une adresse IP d'interface autre que 127.0.0.1 , vous devrez peut-être s'exécuter en tant qu'administrateur (ce système d'exploitation est-il dépendant)
• Ouvrez un port sur votre pare-feu pour permettre le trafic sur le port TCP sur lequel Watsonwebsocket écoute
• Vous devrez peut-être ajouter des ACL URL, c'est-à-dire des liaisons URL, dans le système d'exploitation à l'aide de la commande netsh :
  • Vérifiez les liaisons existantes à l'aide netsh http show urlacl
  • Ajoutez une liaison à l'aide netsh http add urlacl url=http://[hostname]:[port]/ user=everyone listen=yes
  • Où hostname et port sont les valeurs que vous utilisez dans le constructeur
• Si vous utilisez SSL, vous devrez installer le certificat dans le magasin de certificats et récupérer l'empreinte
  • Reportez-vous à https://github.com/jchristn/watsonwebserver/wiki/using-ssl-on-windows pour plus d'informations, ou si vous utilisez SSL
• Si vous rencontrez toujours des problèmes, n'hésitez pas à déposer un problème ici, et je ferai de mon mieux pour aider et mettre à jour la documentation.

Historique des versions

Veuillez vous référer à Changelog.md pour plus de détails.