repository·master·Indexed 26 days ago
https://github.com/sta/websocket-sharpA high-performance WebSocket library for .NET (supporting .NET Framework 3.5+ and Mono) that provides both client and server implementations. Compliant with RFC 6455, it includes support for secure connections (WSS), per-message compression (RFC 7692), HTTP authentication, and proxy server connectivity. The library allows for the creation of WebSocket servers, HTTP servers with WebSocket handshake support, and clients with customizable headers, cookies, and origin validation.
websocket-sharp is a .NET library (supporting .NET Framework 3.5+ and Mono) that provides WebSocket capabilities including:
To create a server, use the WebSocketServer class from the WebSocketSharp.Server namespace.
WebSocketBehavior. Override OnMessage, OnOpen, OnError, or OnClose to handle logic. Use Send() to send data to a client or Sessions.Broadcast() to send to all clients.WebSocketServer instance with a port number. If no port is provided, it defaults to 80 (requires root/admin permissions).AddWebSocketService<TBehavior>(string path) or AddWebSocketService<TBehavior>(string path, Action<TBehavior> init) to map paths to behaviors.Start() to begin listening and Stop() to shut down.using System;
using WebSocketSharp;
using WebSocketSharp.Server;
namespace Example
{
public class Laputa : WebSocketBehavior
{
protected override void OnMessage (MessageEventArgs e)
{
var msg = e.Data == "BALUS"
? "Are you kidding?"
: "I'm not available now.";
Send (msg);
}
}
public class Program
{
public static void Main (string[] args)
{
var wssv = new WebSocketServer ("ws://dragonsnest.far");
wssv.AddWebSocketService<Laputa> ("/Laputa");
wssv.Start ();
Console.ReadKey (true);
wssv.Stop ();
}
}
}To use websocket-sharp as a client, use the WebSocket class in the WebSocketSharp namespace. You can wrap the instance in a using block to ensure the connection is closed with status code 1001 (going away) when the block exits.
Key steps:
WebSocket with a URL (e.g., ws:// or wss://).OnOpen, OnMessage, OnError, and OnClose.Connect() or ConnectAsync() to establish the connection.Send() or SendAsync() to transmit data.using System;
using WebSocketSharp;
namespace Example
{
public class Program
{
public static void Main (string[] args)
{
using (var ws = new WebSocket ("ws://dragonsnest.far/Laputa")) {
ws.OnMessage += (sender, e) =>
Console.WriteLine ("Laputa says: " + e.Data);
ws.Connect ();
ws.Send ("BALUS");
Console.ReadKey (true);
}
}
}
}You can install websocket-sharp using the NuGet Package Manager. Note that it is currently distributed as a prerelease version. Use the following command in the Package Manager Console:
PM> Install-Package WebSocketSharp -PreTo use a self-built version of the library, add the compiled websocket-sharp.dll (e.g., from your /bin/Debug/ folder) to your project's library references.
If you are using Unity, add the websocket-sharp.dll to any folder within your project, such as Assets/Plugins, using the Unity Editor.
The repository contains several example projects demonstrating different usage patterns:
You can find these examples in the repository's Example, Example2, and Example3 directories.
To connect through an HTTP proxy, use ws.SetProxy(proxyUrl, username, password) before calling Connect().
Note: If using Squid, ensure http_access deny CONNECT !SSL_ports is disabled in squid.conf to allow CONNECT requests.
var ws = new WebSocket ("ws://example.com");
ws.SetProxy ("http://localhost:3128", "nobita", "password");websocket-sharp.dll. To build it yourself, open websocket-sharp.sln and run the build for the websocket-sharp project using any build configuration (e.g., Debug).Use the wss:// scheme in the WebSocket URL. You can customize certificate validation via ws.SslConfiguration.ServerCertificateValidationCallback.
Initialize WebSocketServer or HttpServer with the useSsl parameter set to true. Provide a certificate using wssv.SslConfiguration.ServerCertificate.
The WebSocket, WebSocketServer, and HttpServer classes provide built-in logging. You can adjust the logging level via the Log.Level property using the LogLevel enum. The default level is LogLevel.Error.
Example of setting level to Debug and logging a message:
ws.Log.Level = LogLevel.Debug;
ws.Log.Debug("This is a debug message.");ws.Log.Level = LogLevel.Debug;
ws.Log.Debug ("This is a debug message.");new WebSocket("ws://example.com/?name=nobita").WebSocketBehavior.QueryString in the service class.ws.Origin = "http://example.com".WebSocketServer.AddWebSocketService using the OriginValidator property on the behavior instance.ws.SetCookie(new Cookie("name", "value")).CookiesResponder property on the behavior.ws.SetUserHeader("Key", "Value"). Read response headers via ws.HandshakeResponseHeaders["Key"].UserHeadersResponder property on the behavior.Use ws.SetCredentials(username, password, preAuth) before connecting. If preAuth is true, credentials are sent in the first handshake request (Basic). If false, they are sent in the second request (Basic or Digest).
Set wssv.AuthenticationSchemes (e.g., AuthenticationSchemes.Basic or AuthenticationSchemes.Digest), define a wssv.Realm, and provide a wssv.UserCredentialsFinder delegate to validate credentials.