WatsonWebsocket

Watson Websocket

WatsonWebsocket adalah cara termudah dan tercepat untuk membangun aplikasi klien dan server yang mengandalkan pesan menggunakan websockets. Dia. Benar-benar. Mudah.

Terima kasih dan penghargaan

Terima kasih banyak dan penghargaan kepada mereka yang meluangkan waktu untuk membuat perpustakaan ini lebih baik!

Penyerahan @danatobob @data33 @ak5nowman @jjxtra @martyix @rajeshdua123 @terssters @mackey-255 @krookoo @joreg @konk @xbarra @mawkish00 @jlopvon @per-mmonr @xbarra @mawkish00 @exergist @ebarae99 @warstekhun @rubidium37 @codengine

Uji aplikasi

Proyek uji untuk klien ( TestClient ) dan server ( TestServer ) disertakan yang akan membantu Anda memahami dan melatih perpustakaan kelas.

Proyek uji yang memunculkan server dan klien dan bertukar pesan dapat ditemukan di sini: https://github.com/jchristn/watsonwebsockettest

Sistem Operasi yang Didukung

WatsonWebsocket saat ini mengandalkan dukungan WebSocket yang hadir dalam sistem operasi yang mendasarinya. Windows 7 tidak mendukung websockets.

SSL

SSL didukung di Watsonwebsocket. Konstruktor untuk WatsonWsServer dan WatsonWsClient menerima bool yang menunjukkan apakah SSL harus diaktifkan atau tidak. Sejak websockets, dan sebagai produk sampingan watsonwebsocket, gunakan https, mereka mengandalkan sertifikat di dalam toko sertifikat sistem operasi Anda. Sertifikat pengujian disediakan dalam proyek TestClient dan TestServer yang dapat digunakan untuk tujuan pengujian. Ini tidak boleh digunakan dalam produksi.

Untuk informasi lebih lanjut tentang penggunaan sertifikat SSL, silakan merujuk ke wiki.

Baru di v4.0.x

• Melanggar perubahan
• Klien sekarang diidentifikasi oleh Guid di ClientMetadata
• ListClients sekarang mengembalikan ClientMetadata lengkap
• Send* Metode sekarang ambil guid sebagai lawan IpPort
• Tambahkan penargetan untuk .NET 7.0 dan .NET Framework 4.8
• Perbaiki untuk Blazor Wasm, terima kasih @eBARALE99
• Perbaiki untuk karakter kontrol yang tidak valid, terima kasih @warstekhun

Contoh server

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

Contoh Klien

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

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

Mengakses dari luar localhost

Saat Anda mengonfigurasi WatsonWebsocket untuk mendengarkan pada 127.0.0.1 atau localhost , itu hanya akan menanggapi permintaan yang diterima dari dalam mesin lokal.

Untuk mengonfigurasi akses dari node lain di luar localhost , gunakan yang berikut:

• Tentukan nama host DNS yang tepat di mana WatsonWebsocket harus mendengarkan di konstruktor server. Header host pada permintaan HTTP yang masuk harus sesuai dengan nilai ini (ini adalah batasan sistem operasi)
• Jika Anda ingin mendengarkan lebih dari satu nama host atau alamat IP, gunakan * atau + . Anda harus:
  • Jalankan WatsonWebsocket sebagai administrator agar ini berfungsi (ini adalah batasan sistem operasi)
  • Gunakan konstruktor server yang mengambil nama host dan nilai port yang berbeda (bukan konstruktor berbasis URI)
• Jika Anda ingin menggunakan nomor port kurang dari 1024, Anda harus menjalankan WatsonWebsocket sebagai administrator (ini adalah batasan sistem operasi)
• Jika Anda mendengarkan alamat IP antarmuka selain 127.0.0.1 , Anda mungkin perlu berjalan sebagai administrator (ini tergantung pada sistem operasi)
• Buka port di firewall Anda untuk mengizinkan lalu lintas di port TCP tempat WatsonWebsocket mendengarkan
• Anda mungkin harus menambahkan ACL URL, IE URL Bindings, dalam sistem operasi menggunakan perintah netsh :
  • Periksa binding yang ada menggunakan netsh http show urlacl
  • Tambahkan Ikatan Menggunakan netsh http add urlacl url=http://[hostname]:[port]/ user=everyone listen=yes
  • Di mana hostname dan port adalah nilai yang Anda gunakan di konstruktor
• Jika Anda menggunakan SSL, Anda harus menginstal sertifikat di toko sertifikat dan mengambil cap jempol
  • Lihat https://github.com/jchristn/watsonwebserver/wiki/using-ssl-on-windows untuk informasi lebih lanjut, atau jika Anda menggunakan SSL
• Jika Anda masih mengalami masalah, jangan ragu untuk mengajukan masalah di sini, dan saya akan melakukan yang terbaik untuk membantu dan memperbarui dokumentasi.

Sejarah Versi

Silakan merujuk ke changelog.md untuk detailnya.