+
+
websocket-sharp
- A C# implementation of the WebSocket protocol client and server
- View project onGitHub
-
-
-
-
-
-
-
+
A C# implementation of the WebSocket protocol client and server
+ View the Project on GitHub sta/websocket-sharp
+
+
+
+
Welcome to websocket-sharp!
-websocket-sharp supports the followings.
+websocket-sharp supports the followings:
Branches
@@ -55,7 +55,7 @@
Build
-websocket-sharp is built as a single assembly, websocket-sharp.dll.
+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.
@@ -67,12 +67,12 @@
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 use that websocket-sharp.dll in your Unity project, you should add it to any folder of your project (e.g. Assets/Plugins) in the Unity Editor.
+If you would like 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.
+websocket-sharp is available on the NuGet Gallery, as still a prerelease version.
- NuGet Gallery: websocket-sharp
@@ -84,10 +84,10 @@
Unity Asset Store
-websocket-sharp is available on the Unity Asset Store.
+websocket-sharp is available on the Unity Asset Store.
It's priced at US$15. I think your $15 makes this project more better and accelerated, Thank you!
@@ -106,9 +106,8 @@
public static void Main (string [] args)
{
using (var ws = new WebSocket ("ws://dragonsnest.far/Laputa")) {
- ws.OnMessage += (sender, e) => {
+ ws.OnMessage += (sender, e) =>
Console.WriteLine ("Laputa says: " + e.Data);
- };
ws.Connect ();
ws.Send ("BALUS");
@@ -132,14 +131,14 @@
Step 2
-
Creating an instance of the WebSocket class with the specified WebSocket URL to connect.
+Creating an instance of the WebSocket class with the 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.
+The WebSocket class inherits the System.IDisposable interface, so you can use the using statement.
Step 3
@@ -156,23 +155,25 @@
};
-
e has passed as EventArgs.Empty, so you don't use e.
+
e has passed as the System.EventArgs.Empty, so you don't use e.
WebSocket.OnMessage Event
-
A WebSocket.OnMessage event occurs when the WebSocket receives a WebSocket data frame.
+
A WebSocket.OnMessage event occurs when the WebSocket receives a WebSocket message.
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.
+
e has passed as a WebSocketSharp.MessageEventArgs.
-
If e.Type equals Opcode.TEXT, you use e.Data (WebSocketSharp.MessageEventArgs.Data, its type is string) that contains a received Text data.
+
e.Type property returns either WebSocketSharp.Opcode.TEXT or WebSocketSharp.Opcode.BINARY that represents the type of the received message. So by checking it, you determine which item you should use.
-
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 is Opcode.TEXT, you should use e.Data property (returns a string) that represents the received Text message.
+
+
Or if e.Type is Opcode.BINARY, you should use e.RawData property (returns a byte []) that represents the received Binary message.
if (e.Type == Opcode.TEXT) {
// Do something with e.Data
@@ -195,7 +196,9 @@
};
-
e.Message (WebSocketSharp.ErrorEventArgs.Message, its type is string) contains an error message, so you use it.
+
e has passed as a WebSocketSharp.ErrorEventArgs.
+
+
e.Message property returns a string that represents the error message. So you should use it to get the error message.
WebSocket.OnClose Event
@@ -207,7 +210,9 @@
};
-
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.
+
e has passed as a WebSocketSharp.CloseEventArgs.
+
+
e.Code property returns a ushort that represents the status code that indicates the reason for closure, and e.Reason property returns a string that represents the reason for closure. So you should use them to get the reason for closure.
Step 4
@@ -217,23 +222,26 @@
+
If you would like to connect to the server asynchronously, you should use the WebSocket.ConnectAsync () method.
+
Step 5
-
Sending a data.
+
Sending a data to the WebSocket server.
The WebSocket.Send method is overloaded.
-
The types of data are string, byte [] and System.IO.FileInfo.
+
You can use the WebSocket.Send (string), WebSocket.Send (byte []), and WebSocket.Send (System.IO.FileInfo) methods to send a data.
-
In addition, the WebSocket.Send (stream, length) method exists, too.
+
If you would like to send a data asynchronously, you should use the WebSocket.SendAsync method.
-
These methods don't wait for the send to be complete. It means these methods behave asynchronously.
+
ws.SendAsync (data, completed);
+
-
If you do something when the send is complete, you use any of some WebSocket.Send (data, completed) methods.
+
And if you would like to do something when the send is complete, you should set completed to any Action<bool>.
Step 6
@@ -243,13 +251,13 @@
-
If you explicitly close the WebSocket connection, you use the WebSocket.Close method.
+
If you would like to close the connection explicitly, you should use the WebSocket.Close method.
The WebSocket.Close method is overloaded.
-
The types of code are WebSocketSharp.CloseStatusCode and ushort, and the type of reason is string.
+
You can use the WebSocket.Close (), WebSocket.Close (ushort), WebSocket.Close (WebSocketSharp.CloseStatusCode), WebSocket.Close (ushort, string), or WebSocket.Close (WebSocketSharp.CloseStatusCode, string) method to close the connection.
-
In addition, the WebSocket.Close () and WebSocket.Close (code) methods exist, too.
+
If you would like to close the connection asynchronously, you should use the WebSocket.CloseAsync method.
WebSocket Server
@@ -294,14 +302,14 @@
using WebSocketSharp.Server;
-
The WebSocketService and WebSocketServer classes exist in the WebSocketSharp.Server namespace.
+
The WebSocketServer and WebSocketService 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,
+
For example, if you would like to provide an echo service,
using System;
using WebSocketSharp;
@@ -316,7 +324,7 @@
}
-
And if you provide a chat service,
+
And if you would like to provide a chat service,
using System;
using WebSocketSharp;
@@ -343,15 +351,15 @@
}
-
If you override the WebSocketService.OnMessage method, it's bound to the server side WebSocket.OnMessage event.
+
If you override the WebSocketService.OnMessage (MessageEventArgs) method, that overridden method is called when the OnMessage event of the current session's WebSocket occurs.
-
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.
+
And if you override the WebSocketService.OnOpen (), WebSocketService.OnError (ErrorEventArgs), and WebSocketService.OnClose (CloseEventArgs) methods, each of them is called when each event of the current session's WebSocket (the OnOpen, OnError, and OnClose events) occurs.
-
The WebSocketService.Send method sends a data to the client of the current session to the WebSocket service.
+
The WebSocketService.Send method sends a data to the client on the current session in the WebSocket service.
-
The WebSocketService.Sessions (its type is WebSocketSharp.Server.WebSocketSessionManager) property provides some functions for the sessions to the WebSocket service.
+
If you would like to access the sessions in the WebSocket service, you should use the WebSocketService.Sessions property (returns a WebSocketSharp.Server.WebSocketSessionManager).
-
The WebSocketService.Sessions.Broadcast method sends a data to all clients of the WebSocket service.
+
The WebSocketService.Sessions.Broadcast method broadcasts a data to all clients of the WebSocket service.
Step 3
@@ -364,15 +372,15 @@
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.
+Starting the server.
+Starting the WebSocket server.
Stopping the server.
+Stopping the WebSocket server.
-wssv.Stop ();
+wssv.Stop (code, reason);
The WebSocketServer.Stop method is overloaded.
+
+You can use the WebSocketServer.Stop (), WebSocketServer.Stop (ushort, string), or WebSocketServer.Stop (WebSocketSharp.CloseStatusCode, string) method to stop the server.
+
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.
+I modified the System.Net.HttpListener, System.Net.HttpListenerContext, and some other classes of Mono to create the HTTP server that allows to accept the WebSocket connection requests.
-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.
+So websocket-sharp provides the WebSocketSharp.Server.HttpServer class.
+
+You can add any WebSocket service to your HttpServer with the specified path to the service, using the HttpServer.AddWebSocketService<TWithNew> (string) and HttpServer.AddWebSocketService<T> (string, Func<T>) methods.
var httpsv = new HttpServer (4649);
httpsv.AddWebSocketService<Echo> ("/Echo");
@@ -414,31 +428,33 @@
Per-message Compression
-websocket-sharp supports Per-message Compression extension. (But it doesn't support with extension parameters.)
+websocket-sharp supports the Per-message Compression extension. (But it doesn't support with the extension parameters.)
-If you enable this extension as a WebSocket client, you should do like the following.
+If you would like to enable this extension as a WebSocket client, you should set like the following.
ws.Compression = CompressionMethod.DEFLATE;
And then your WebSocket client sends the following header in the opening handshake to a WebSocket server.
+And then your client sends the following header with the connection request to the 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.
+If the server supports this extension, it returns the same header. And when your client receives that 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.
+websocket-sharp supports the Secure Connection (SSL).
+
+As a WebSocket Client, you should create an instance of the WebSocket class with the wss scheme WebSocket 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.
+And if you would like to set the custom validation for the server certificate, you should set the WebSocket.ServerCertificateValidationCallback property.
ws.ServerCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => {
// Do something to validate the server certificate.
@@ -448,32 +464,63 @@
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.
+As a WebSocket Server, you should create an instance of the WebSocketServer or HttpServer class with some settings for the secure connection. It's like the following.
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 (string, string, bool) method before connecting.
+
+ws.SetCredentials (username, password, preAuth);
+
If preAuth is true, the WebSocket sends the Basic authentication credentials with the first connection request to the server.
+
+Or 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 expected = "nobita";
+ return identity.Name == expected
+ ? new NetworkCredential (expected, "password", "gunfighter") // User name, password, and roles
+ : null; // If the user credentials not found.
+};
+If you would like 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 class includes the own logging function.
-The WebSocket.Log property provides the logging functions.
+You can access it with the WebSocket.Log property (returns a WebSocketSharp.Logger).
-If you change the current logging level (the default is LogLevel.ERROR), you use the WebSocket.Log.Level property.
+So if you would like to change the current logging level (WebSocketSharp.LogLevel.ERROR as the default), you should set the WebSocket.Log.Level property to any of the LogLevel enum values.
ws.Log.Level = LogLevel.DEBUG;
The above means that the logging outputs with a less than LogLevel.DEBUG are not outputted.
+This means a log with less than LogLevel.DEBUG isn't outputted.
-And if you output a log, you use any of some output methods. The following outputs a log with LogLevel.DEBUG.
+And if you would like to output a log, you should use any of the 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.
+The WebSocketServer and HttpServer classes include the same logging function.
Examples
@@ -483,31 +530,31 @@
Example
-Example connects to the Echo server using the WebSocket.
+Example connects to the Echo server with the WebSocket.
Example1
-Example1 connects to the Audio Data delivery server using the WebSocket (Example1 is only implemented the chat feature, still unfinished).
+Example1 connects to the Audio Data delivery server with the WebSocket. (But it's only implemented the chat feature, still unfinished.)
-And Example1 uses Json.NET.
+And Example1 uses Json.NET.
Example2
-Example2 starts a WebSocket server.
+Example2 starts a WebSocket server.
Example3
-Example3 starts an HTTP server that can upgrade the connection to the WebSocket connection.
+Example3 starts an HTTP server that allows to accept the WebSocket connection requests.
-Could you access to http://localhost:4649 to do WebSocket Echo Test with your web browser after Example3 running?
+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 and is based on the following WebSocket references.
+websocket-sharp supports RFC 6455 and is based on the following WebSocket references.
License
-
websocket-sharp is provided under The MIT License.
-
-
-
-
websocket-sharp is provided under The MIT License.
+