WatsonWebsocket

Watson Websocket

WatsonWebSocket es la forma más fácil y rápida de crear aplicaciones de clientes y servidores que dependen de los mensajes utilizando WebSockets. Es. En realidad. Fácil.

Gracias y aprecio

¡Muchas gracias y mucho aprecio a aquellos que se toman el tiempo para mejorar esta biblioteca!

@BryancroTaz @Foddermk @Caozero @danatobob @data33 @ak5nowman @jjxtra @martyix @rajeshdua123 @tersers @mackey-255 @krookoo1 @joreg @ilsnk @xbarra @mawkish00 @jlopvet @marco-manfroni-perugiatiming @Exergist @eBarale99 @warstekhun @rubidium37 @Codengine

Aplicación de prueba

Se incluye un proyecto de prueba tanto para el cliente ( TestClient ) como para el servidor ( TestServer ) que lo ayudará a comprender y ejercer la biblioteca de clases.

Aquí se puede encontrar un proyecto de prueba que genere un servidor y un cliente y se intercambia mensajes: https://github.com/jchristn/watsonwebsockettest

Sistemas operativos compatibles

WatsonWebSocket se basa actualmente en que el soporte de WebSocket está presente en el sistema operativo subyacente. Windows 7 no admite WebSockets.

Ssl

SSL es apoyado en WatsonwebSocket. Los constructores de WatsonWsServer y WatsonWsClient aceptan un bool que indica si SSL debe estar habilitado o no. Dado que WebSockets, y como subproducto WatsonWebSocket, usan HTTPS, dependen de los certificados dentro del almacén de certificados de su sistema operativo. Se proporciona un certificado de prueba en los proyectos TestClient y TestServer que pueden usarse para fines de prueba. Estos no deben usarse en la producción.

Para obtener más información sobre el uso de certificados SSL, consulte el wiki.

Nuevo en v4.0.x

• Cambios de ruptura
• Clientes ahora identificados por Guid en ClientMetadata
• ListClients ahora devuelve ClientMetadata completo
• Send* métodos ahora tome guid en lugar de IpPort
• Agregue la orientación para .NET 7.0 y .NET Framework 4.8
• FIJO para Blazor Wasm, gracias @ebarale99
• FIJA PARA CONTROL DE CONTROL INVÁLIDO, GRACIAS @WARSTEKHUN

Ejemplo del servidor

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

Ejemplo del cliente

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

Ejemplo del cliente usando el navegador

 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!" ) ; 

Acceso desde el exterior de localhost

Cuando configura WatsonWebSocket para escuchar en 127.0.0.1 o localhost , solo responderá a las solicitudes recibidas de la máquina local.

Para configurar el acceso desde otros nodos fuera de localhost , use lo siguiente:

• Especifique el nombre de host DNS exacto sobre el cual WatsonWebSocket debe escuchar en el constructor del servidor. El encabezado del host en las solicitudes HTTP entrantes debe coincidir con este valor (esta es una limitación del sistema operativo)
• Si desea escuchar en más de un nombre de host o dirección IP, use * o + . Usted debe:
  • Ejecute WatsonWebSocket como administrador para que esto funcione (esta es una limitación del sistema operativo)
  • Use el constructor del servidor que toma un nombre de host y valores de puerto distintos (no el constructor basado en URI)
• Si desea usar un número de puerto inferior a 1024, debe ejecutar WatsonWebSocket como administrador (esta es una limitación del sistema operativo)
• Si escucha en una dirección IP de interfaz que no sea 127.0.0.1 , es posible que deba ejecutar como administrador (esto depende del sistema operativo)
• Abra un puerto en su firewall para permitir el tráfico en el puerto TCP sobre el cual WatsonwebSocket está escuchando
• Es posible que deba agregar ACL de URL, es decir, enlaces de URL, dentro del sistema operativo utilizando el comando netsh :
  • Verifique los enlaces existentes utilizando netsh http show urlacl
  • Agregue un enlace usando netsh http add urlacl url=http://[hostname]:[port]/ user=everyone listen=yes
  • Donde hostname y port son los valores que está utilizando en el constructor
• Si está utilizando SSL, deberá instalar el certificado en la tienda de certificados y recuperar la huella digital
  • Consulte https://github.com/jchristn/watsonwebserver/wiki/using-ssl-on-windows para obtener más información, o si está utilizando SSL
• Si todavía tiene problemas, no dude en presentar un problema aquí, y haré todo lo posible para ayudar y actualizar la documentación.

Historial de versiones

Consulte ChangeLog.md para más detalles.