WatsonWebsocket

Watson Websocket

WatsonWebsocket ist der einfachste und schnellste Weg, um Client- und Serveranwendungen zu erstellen, die mithilfe von Websockets auf Messaging beruhen. Es ist. Wirklich. Einfach.

Danke und Wertschätzung

Vielen Dank und viel Wertschätzung für diejenigen, die sich die Zeit nehmen, diese Bibliothek besser zu machen!

@BryanCrotaz @FodderMK @caozero @Danatobob @Data33 @AK5nowman @jjxtra @MartyIX @rajeshdua123 @tersers @MacKey-255 @KRookoo1 @joreg @ilsnk @xbarra @mawkish00 @jlopvet @marco-manfroni-perugiatiming @GiaNTizmO @exergist @ebarale99 @warstekhun @rubidium37 @Codengine

Test App

Ein Testprojekt für Client ( TestClient ) und Server ( TestServer ) ist enthalten, das Ihnen hilft, die Klassenbibliothek zu verstehen und auszuüben.

Ein Testprojekt, bei dem hier ein Server und ein Client- und Austausch von Nachrichten erzeugt werden

Unterstützte Betriebssysteme

Watsonwebsocket stützt sich derzeit auf WebSocket -Unterstützung, die im zugrunde liegenden Betriebssystem vorhanden sind. Windows 7 unterstützt keine Websockets.

SSL

SSL wird in Watsonwebocket unterstützt. Die Konstruktoren für WatsonWsServer und WatsonWsClient akzeptieren einen bool der angibt, ob SSL aktiviert werden sollte oder nicht. Da WebSockets und als Nebenprodukt Watsonwebsocket HTTPS verwenden, verlassen sie sich auf Zertifikate im Zertifikatspeicher Ihres Betriebssystems. Ein Testzertifikat wird sowohl in den TestClient als auch in TestServer -Projekten bereitgestellt, die für Testzwecke verwendet werden können. Diese sollten nicht in der Produktion verwendet werden.

Weitere Informationen zur Verwendung von SSL -Zertifikaten finden Sie im Wiki.

Neu in v4.0.x

• Veränderungen brechen
• Kunden, die jetzt nach Guid in ClientMetadata identifiziert wurden
• ListClients gibt jetzt vollständige ClientMetadata zurück
• Send* Methoden nehmen jetzt im Gegensatz zu IpPort guid ein
• Fügen Sie Targeting für .NET 7.0 und .NET Framework 4.8 hinzu
• Fix für Blazor Wasm, danke @ebarale99
• Fix für ungültige Steuerzeichen, danke @warstekhun

Serverbeispiel

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

Client -Beispiel

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

Client -Beispiel mit Browser

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

Zugriff von außerhalb von Localhost

Wenn Sie Watsonwebsocket so konfigurieren, dass sie 127.0.0.1 oder localhost zuhören, wird nur auf Anfragen beantwortet, die von innerhalb des lokalen Maschine eingegangen sind.

Verwenden Sie Folgendes, um den Zugriff von anderen Knoten außerhalb von localhost zu konfigurieren:

• Geben Sie den genauen DNS -Hostnamen an, auf dem Watsonwebsocket im Serverkonstruktor zuhören soll. Der Host -Header für eingehende HTTP -Anforderungen muss mit diesem Wert übereinstimmen (dies ist eine Betriebssystembeschränkung)
• Wenn Sie mehr als einen Hostnamen oder eine IP -Adresse anhören möchten, verwenden Sie * oder + . Sie müssen:
  • Führen Sie Watsonwebsocket als Administrator aus, damit dies funktioniert (dies ist eine Einschränkung des Betriebssystems)
  • Verwenden Sie den Serverkonstruktor, der unterschiedliche Hostname- und Portwerte (nicht den URI-basierten Konstruktor) aufnimmt.
• Wenn Sie eine Portnummer von weniger als 1024 verwenden möchten, müssen Sie Watsonwebsocket als Administrator ausführen (dies ist eine Betriebssystembeschränkung)
• Wenn Sie eine andere Schnittstellen -IP -Adresse als 127.0.0.1 anhören, müssen Sie möglicherweise als Administrator ausgeführt werden (dies ist ein Betriebssystem abhängig).
• Öffnen Sie einen Port auf Ihrer Firewall, um den Verkehr am TCP -Anschluss zu ermöglichen, auf dem Watsonwebsocket zuhört
• Möglicherweise müssen Sie URL -ACLs, dh URL -Bindungen, innerhalb des Betriebssystems mit dem Befehl netsh hinzufügen:
  • Überprüfen Sie nach vorhandenen Bindungen mit netsh http show urlacl
  • Fügen Sie eine Bindung mit netsh http add urlacl url=http://[hostname]:[port]/ user=everyone listen=yes
  • Wo hostname und port die Werte sind, die Sie im Konstruktor verwenden
• Wenn Sie SSL verwenden, müssen Sie das Zertifikat im Zertifikatspeicher installieren und den Daumenabdruck abrufen
  • Weitere Informationen finden Sie unter https://github.com/jchristn/watsonwebserver/wiki/using-Sl-on-windows, um weitere Informationen zu erhalten, oder wenn Sie SSL verwenden
• Wenn Sie immer noch Probleme haben, zögern Sie bitte nicht, hier ein Problem einzureichen, und ich werde mein Bestes tun, um die Dokumentation zu helfen und zu aktualisieren.

Versionsgeschichte

Weitere Informationen finden Sie in ChangeLog.md.