WatsonWebsocket

Watson WebSocket

O WatsonWebSocket é a maneira mais fácil e rápida de criar aplicativos de clientes e servidores que dependem de mensagens usando o WebSockets. Isso é. Realmente. Fácil.

Obrigado e apreço

Muito obrigado e muito agradecimento àqueles que dedicam um tempo para melhorar esta biblioteca!

@Bryancrotaz @foddermk @caoZero @danatobob @data33 @ak5nowman @jjxtra @martyix @rajeshdua123 @tersers @mackkey-255 @krookoo1 @joreg @ilco @xBarra @mawkhish005 @krookoo1 @joreg @ilco @xBarra @mawksh005 @krookoo1 @joreg @ilco @xBarra @mAwkh005 @exergist @ebarale99 @warstekhun @rubidium37 @codengine

Aplicativo de teste

É incluído um projeto de teste para clientes ( TestClient ) e servidor ( TestServer ), que ajudará você a entender e exercitar a biblioteca de classes.

Um projeto de teste que gera mensagens de servidor e cliente e trocas pode ser encontrado aqui: https://github.com/jchristn/watsonwebsockettestestest

Sistemas operacionais suportados

Atualmente, o WatsonWebSocket depende do suporte do WebSocket no sistema operacional subjacente. O Windows 7 não suporta websockets.

Ssl

O SSL é suportado no WatsonwebSocket. Os construtores do WatsonWsServer e WatsonWsClient aceitam um bool indicando se o SSL deve ou não ser ativado. Como o WebSockets, e como um subproduto WatsonWebSocket, use o HTTPS, eles dependem de certificados no armazenamento de certificados do seu sistema operacional. Um certificado de teste é fornecido nos projetos TestClient e TestServer , que podem ser usados ​​para fins de teste. Estes não devem ser usados ​​na produção.

Para obter mais informações sobre o uso de certificados SSL, consulte o wiki.

Novo em v4.0.x

• Quebrando mudanças
• Clientes agora identificados por Guid em ClientMetadata
• ListClients agora retorna ClientMetadata completo Metadata
• Send* Métodos agora tomam guid em oposição ao IpPort
• Adicione a segmentação para o .NET 7.0 e .NET Framework 4.8
• Corrigir para Blazor Wasm, obrigado @eBarale99
• Corrija para caracteres de controle inválido, obrigado @warstekhun

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

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

Exemplo de cliente usando o 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!" ) ; 

Acessando de fora do local para localhost

Quando você configura o WatsonWebSocket para ouvir em 127.0.0.1 ou localhost , ele só responderá às solicitações recebidas de dentro da máquina local.

Para configurar o acesso de outros nós fora do localhost , use o seguinte:

• Especifique o nome exato do host do DNS sobre o qual o WatsonWebSocket deve ouvir no construtor do servidor. O cabeçalho do host nas solicitações HTTP recebidas deve corresponder a esse valor (esta é uma limitação do sistema operacional)
• Se você quiser ouvir mais de um nome de host ou endereço IP, use * ou + . Você deve:
  • Execute o WatsonWebSocket como administrador para que isso funcione (esta é uma limitação do sistema operacional)
  • Use o construtor do servidor que leva o nome do host distinto e os valores da porta (não o construtor baseado em URI)
• Se você deseja usar um número de porta inferior a 1024, deve executar o WatsonWebSocket como administrador (esta é uma limitação do sistema operacional)
• Se você ouvir em um endereço IP da interface que não seja 127.0.0.1 , pode ser necessário executar como administrador (este depende do sistema operacional)
• Abra uma porta no seu firewall para permitir o tráfego na porta TCP na qual o Watsonwebsocket está ouvindo
• Você pode precisar adicionar URL ACLs, ou seja, URL ligações, dentro do sistema operacional usando o comando netsh :
  • Verifique se há ligações existentes usando netsh http show urlacl
  • Adicione uma ligação usando netsh http add urlacl url=http://[hostname]:[port]/ user=everyone listen=yes
  • Onde hostname e port são os valores que você está usando no construtor
• Se você estiver usando o SSL, precisará instalar o certificado no armazenamento de certificados e recuperar a impressão digital
  • Consulte https://github.com/jchristn/watsonwebserver/wiki/USing-Ssl-on-Windows para obter mais informações, ou se você estiver usando SSL
• Se você ainda estiver tendo problemas, não hesite em apresentar um problema aqui e farei o possível para ajudar e atualizar a documentação.

Histórico da versão

Consulte o Changelog.md para obter detalhes.