Welcome to websocket-sharp!

websocket-sharp supports the followings.

• WebSocket Client and Server
• RFC 6455
• Per-message Compression extension
• Secure Connection
• HTTP Authentication
• .NET 3.5 or later (includes compatible)

Branches

• [master] for production releases.
• [hybi-00] for older [draft-ietf-hybi-thewebsocketprotocol-00]. No longer maintained.
• [draft75] for even more old [draft-hixie-thewebsocketprotocol-75]. No longer maintained.

Build

websocket-sharp is built as a single assembly, websocket-sharp.dll.

websocket-sharp is developed with MonoDevelop. So the simple way to build is to open websocket-sharp.sln and run build for the websocket-sharp project with any of the build configurations (e.g. Debug) in the MonoDevelop.

Install

Self Build

You should add websocket-sharp.dll (e.g. /path/to/websocket-sharp/bin/Debug/websocket-sharp.dll) built yourself to the library references of your project.

If you want to use that websocket-sharp.dll in your Unity project, you should add that dll to any folder of your project (e.g. Assets/Plugins) in the Unity Editor.

NuGet Gallery

websocket-sharp is available on the NuGet Gallery, as still a prerelease version.

• NuGet Gallery: websocket-sharp

You can add websocket-sharp to your project using the NuGet Package Manager, the following command in the Package Manager Console.

PM> Install-Package WebSocketSharp -Pre

Unity Asset Store

websocket-sharp is available on the Unity Asset Store.

• [WebSocket-Sharp for Unity]

It's priced at US$15. I think your $15 makes this project more better and accelerated, Thank you!

Usage

WebSocket Client

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

Step 1

Required namespace.

using WebSocketSharp;

The WebSocket class exists in the WebSocketSharp namespace.

Step 2

Creating an instance of the WebSocket class with the specified WebSocket URL to connect.

using (var ws = new WebSocket ("ws://example.com")) {
  ...
}

The WebSocket class inherits the IDisposable interface, so you can use the using statement.

Step 3

Setting the WebSocket events.

WebSocket.OnOpen Event

A WebSocket.OnOpen event occurs when the WebSocket connection has been established.

ws.OnOpen += (sender, e) => {
  ...
};

e has passed as EventArgs.Empty, so you don't use e.

WebSocket.OnMessage Event

A WebSocket.OnMessage event occurs when the WebSocket receives a WebSocket data frame.

ws.OnMessage += (sender, e) => {
  ...
};

e.Type (WebSocketSharp.MessageEventArgs.Type, its type is WebSocketSharp.Opcode) indicates the type of a received data. So by checking it, you determine which item you should use.

If e.Type equals Opcode.TEXT, you use e.Data (WebSocketSharp.MessageEventArgs.Data, its type is string) that contains a received Text data.

If e.Type equals Opcode.BINARY, you use e.RawData (WebSocketSharp.MessageEventArgs.RawData, its type is byte []) that contains a received Binary data.

if (e.Type == Opcode.TEXT) {
  // Do something with e.Data
  return;
}

if (e.Type == Opcode.BINARY) {
  // Do something with e.RawData
  return;
}

WebSocket.OnError Event

A WebSocket.OnError event occurs when the WebSocket gets an error.

ws.OnError += (sender, e) => {
  ...
};

e.Message (WebSocketSharp.ErrorEventArgs.Message, its type is string) contains an error message, so you use it.

WebSocket.OnClose Event

A WebSocket.OnClose event occurs when the WebSocket connection has been closed.

ws.OnClose += (sender, e) => {
  ...
};

e.Code (WebSocketSharp.CloseEventArgs.Code, its type is ushort) contains a status code indicating the reason for closure and e.Reason (WebSocketSharp.CloseEventArgs.Reason, its type is string) contains the reason for closure, so you use them.

Step 4

Connecting to the WebSocket server.

ws.Connect ();

If you want to connect to the server asynchronously, you should use the WebSocket.ConnectAsync () method.

Step 5

Sending a data to the WebSocket server.

ws.Send (data);

The WebSocket.Send (data) method is overloaded.

The type of data is string, byte [] or System.IO.FileInfo.

If you want to send a data to the server asynchronously, you should use the WebSocket.SendAsync (data, completed) method.

And if you want to do something when the send is complete, you should set any action to completed (its type is Action<bool>).

Step 6

Closing the WebSocket connection.

ws.Close ();

If you want to close the connection explicitly, you should use the WebSocket.Close method.

The WebSocket.Close method is overloaded.

The WebSocket.Close (), WebSocket.Close (code) and WebSocket.Close (code, reason) methods exist.

The type of code is WebSocketSharp.CloseStatusCode or ushort, and the type of reason is string.

If you want to close the connection asynchronously, you should use the WebSocket.CloseAsync method.

WebSocket Server

using System;
using WebSocketSharp;
using WebSocketSharp.Server;

namespace Example
{
  public class Laputa : WebSocketService
  {
    protected override void OnMessage (MessageEventArgs e)
    {
      var msg = e.Data == "BALUS"
              ? "I've been balused already..."
              : "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 ();
    }
  }
}

Step 1

Required namespace.

using WebSocketSharp.Server;

The WebSocketService and WebSocketServer classes exist in the WebSocketSharp.Server namespace.

Step 2

Creating the class that inherits the WebSocketService class.

For example, if you provide an echo service,

using System;
using WebSocketSharp;
using WebSocketSharp.Server;

public class Echo : WebSocketService
{
  protected override void OnMessage (MessageEventArgs e)
  {
    Send (e.Data);
  }
}

And if you provide a chat service,

using System;
using WebSocketSharp;
using WebSocketSharp.Server;

public class Chat : WebSocketService
{
  private string _suffix;

  public Chat ()
    : this (null)
  {
  }

  public Chat (string suffix)
  {
    _suffix = suffix ?? String.Empty;
  }

  protected override void OnMessage (MessageEventArgs e)
  {
    Sessions.Broadcast (e.Data + _suffix);
  }
}

If you override the WebSocketService.OnMessage method, it's bound to the server side WebSocket.OnMessage event.

And if you override the WebSocketService.OnOpen, WebSocketService.OnError and WebSocketService.OnClose methods, each of them is bound to each server side event of WebSocket.OnOpen, WebSocket.OnError and WebSocket.OnClose.

The WebSocketService.Send method sends a data to the client of the current session to the WebSocket service.

The WebSocketService.Sessions (its type is WebSocketSharp.Server.WebSocketSessionManager) property provides some functions for the sessions to the WebSocket service.

The WebSocketService.Sessions.Broadcast method sends a data to all clients of the WebSocket service.

Step 3

Creating an instance of the WebSocketServer class.

var wssv = new WebSocketServer (4649);
wssv.AddWebSocketService<Echo> ("/Echo");
wssv.AddWebSocketService<Chat> ("/Chat");
wssv.AddWebSocketService<Chat> ("/ChatWithNiceBoat", () => new Chat (" Nice boat."));

You can add any WebSocket service with the specified path to the service to your WebSocketServer by using the WebSocketServer.AddWebSocketService<TWithNew> or WebSocketServer.AddWebSocketService<T> method.

The type of TWithNew must inherit the WebSocketService class and must have a public parameterless constructor.

The type of T must inherit WebSocketService class.

So you can use the classes created in Step 2.

If you create an instance of the WebSocketServer class without the port number, the WebSocketServer set the port number to 80 automatically. So it's necessary to run with root permission.

$ sudo mono example2.exe

Step 4

Starting the server.

wssv.Start ();

Step 5

Stopping the server.

wssv.Stop ();

HTTP Server with the WebSocket

I modified the System.Net.HttpListener, System.Net.HttpListenerContext and some other classes of Mono to create the HTTP server that can upgrade the connection to the WebSocket connection when it receives a WebSocket connection request.

You can add any WebSocket service with the specified path to the service to your HttpServer by using the HttpServer.AddWebSocketService<TWithNew> or HttpServer.AddWebSocketService<T> method.

var httpsv = new HttpServer (4649);
httpsv.AddWebSocketService<Echo> ("/Echo");
httpsv.AddWebSocketService<Chat> ("/Chat");
httpsv.AddWebSocketService<Chat> ("/ChatWithNiceBoat", () => new Chat (" Nice boat."));

For more information, could you see Example3?

WebSocket Extensions

Per-message Compression

websocket-sharp supports [Per-message Compression][compression] extension. (But it doesn't support with [extension parameters].)

If you enable this extension as a WebSocket client, you should do like the following.

ws.Compression = CompressionMethod.DEFLATE;

And then your WebSocket client sends the following header in the opening handshake to a WebSocket server.

Sec-WebSocket-Extensions: permessage-deflate

If the server supports this extension, it responds the same header. And when your client receives the header, it enables this extension.

Secure Connection

As a WebSocket Client, creating an instance of the WebSocket class with the specified wss scheme URL to connect.

using (var ws = new WebSocket ("wss://example.com")) {
  ...
}

If you set the custom validation for the server certificate, you use the WebSocket.ServerCertificateValidationCallback property.

ws.ServerCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => {
  // Do something to validate the server certificate.
  return true; // If the server certificate is valid.
};

If you set this property to nothing, the validation does nothing with the server certificate and returns valid.

As a WebSocket Server, creating an instance of the WebSocketServer or HttpServer class with some settings for the secure connection.

var wssv = new WebSocketServer (4649, true);
wssv.Certificate = new X509Certificate2 ("/path/to/cert.pfx", "password for cert.pfx");

HTTP Authentication

websocket-sharp supports the HTTP Authentication (Basic/Digest).

As a WebSocket Client, you should set a pair of user name and password for the HTTP Authentication, using the WebSocket.SetCredentials (username, password, preAuth) method before connecting.

ws.SetCredentials ("nobita", "password", true);

If preAuth is true, the WebSocket sends the Basic authentication credentials with the first connection request to the server.

And if preAuth is false, the WebSocket sends either the Basic or Digest authentication (determined by the unauthorized response to the first connection request) credentials with the second connection request to the server.

As a WebSocket Server, you should set an HTTP authentication scheme, a realm, and any function to find the user credentials before starting. It's like the following.

wssv.AuthenticationSchemes = AuthenticationSchemes.Basic;
wssv.Realm = "WebSocket Test";
wssv.UserCredentialsFinder = identity => {
  var name = identity.Name;
  return name == "nobita"
         ? new NetworkCredential (name, "password")
         : null; // If the user credentials not found.
};

If you want to provide the Digest authentication, you should set like the following.

wssv.AuthenticationSchemes = AuthenticationSchemes.Digest;

Logging

The WebSocket class includes own logging functions.

The WebSocket.Log property provides the logging functions.

If you change the current logging level (the default is LogLevel.ERROR), you use the WebSocket.Log.Level property.

ws.Log.Level = LogLevel.DEBUG;

The above means that the logging outputs with a less than LogLevel.DEBUG are not outputted.

And if you output a log, you use any of some output methods. The following outputs a log with LogLevel.DEBUG.

ws.Log.Debug ("This is a debug message.");

The WebSocketServer and HttpServer classes include the same logging functions.

Examples

Examples using websocket-sharp.

Example

Example connects to the Echo server using the WebSocket.

Example1

Example1 connects to the Audio Data delivery server using the WebSocket (Example1 is only implemented the chat feature, still unfinished).

And Example1 uses Json.NET.

Example2

Example2 starts a WebSocket server.

Example3

Example3 starts an HTTP server that can upgrade the connection to the WebSocket connection.

Could you access to http://localhost:4649 to do WebSocket Echo Test with your web browser after Example3 running?

Supported WebSocket Specifications

websocket-sharp supports [RFC 6455][rfc6455] and is based on the following WebSocket references.

• [The WebSocket Protocol][rfc6455]
• [The WebSocket API][api]
• [Compression Extensions for WebSocket][compression]

Thanks for translating to japanese.

• [The WebSocket Protocol 日本語訳][rfc6455_ja]
• [The WebSocket API 日本語訳][api_ja]

License

websocket-sharp is provided under The MIT License.

[WebSocket-Sharp for Unity]: http://u3d.as/content/sta-blockhead/websocket-sharp-for-unity[api]: http://www.w3.org/TR/websockets [api_ja]: http://www.hcn.zaq.ne.jp//WEB/WebSocket-ja.html [compression]: http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-09 [draft-hixie-thewebsocketprotocol-75]: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 [draft-ietf-hybi-thewebsocketprotocol-00]: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00 [draft75]: https://github.com/sta/websocket-sharp/tree/draft75 [extension parameters]: http://tools.ietf.org/html/draft-ietf-hybi-permessage-compression-09#section-8.1 [hybi-00]: https://github.com/sta/websocket-sharp/tree/hybi-00 [master]: https://github.com/sta/websocket-sharp/tree/master [rfc6455]: http://tools.ietf.org/html/rfc6455 [rfc6455_ja]: http://www.hcn.zaq.ne.jp//WEB/RFC6455-ja.html