Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/havendv/h.socket.io
This is the Socket.IO client for .NET, which is based on ClientWebSocket, provide a simple way to connect to the Socket.IO server. The target framework is .NET Standard 2.0
https://github.com/havendv/h.socket.io
csharp engine-io engine-io-client engineio engineio-client netstandard netstandard20 nuget socket socket-io socket-io-client socket-io-net socketio socketio-client vbnet websocket-client websockets
Last synced: 14 days ago
JSON representation
This is the Socket.IO client for .NET, which is based on ClientWebSocket, provide a simple way to connect to the Socket.IO server. The target framework is .NET Standard 2.0
- Host: GitHub
- URL: https://github.com/havendv/h.socket.io
- Owner: HavenDV
- License: mit
- Created: 2019-11-18T22:09:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T21:04:14.000Z (about 1 month ago)
- Last Synced: 2024-10-19T19:52:39.780Z (25 days ago)
- Topics: csharp, engine-io, engine-io-client, engineio, engineio-client, netstandard, netstandard20, nuget, socket, socket-io, socket-io-client, socket-io-net, socketio, socketio-client, vbnet, websocket-client, websockets
- Language: C#
- Homepage:
- Size: 720 KB
- Stars: 100
- Watchers: 10
- Forks: 15
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [H.Socket.IO](https://github.com/HavenDV/H.Socket.IO/)
[](https://github.com/HavenDV/H.Socket.IO/search?l=C%23&o=desc&s=&type=Code)
[](LICENSE.md)
[](https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.0.md)
[](https://github.com/microsoft/dotnet/blob/master/releases/net45/README.md)
[](https://github.com/HavenDV/H.Socket.IO/actions/workflows/dotnet.yml)
High-performance event-based .NET Socket.IO library with a convenient interface,
aimed at writing the smallest possible code on the user side.
Features:
- Supports the latest version of Socket.IO server
- Supports namespaces
- The library is null-free and does not contain NRE
- Event-based
- Completely asynchronous
### Nuget
[](https://www.nuget.org/packages/H.Socket.IO/)
[](https://www.nuget.org/packages/H.Engine.IO/)
[](https://www.nuget.org/packages/H.WebSockets/)
```
Install-Package H.Socket.IO
```
### Usage
```cs
using System;
using System.Threading.Tasks;
using H.Socket.IO;
#nullable enable
public class ChatMessage
{
public string? Username { get; set; }
public string? Message { get; set; }
public long NumUsers { get; set; }
}
public async Task ConnectToChatNowShTest()
{
await using var client = new SocketIoClient();
client.Connected += (sender, args) => Console.WriteLine($"Connected: {args.Namespace}");
client.Disconnected += (sender, args) => Console.WriteLine($"Disconnected. Reason: {args.Reason}, Status: {args.Status:G}");
client.EventReceived += (sender, args) => Console.WriteLine($"EventReceived: Namespace: {args.Namespace}, Value: {args.Value}, IsHandled: {args.IsHandled}");
client.HandledEventReceived += (sender, args) => Console.WriteLine($"HandledEventReceived: Namespace: {args.Namespace}, Value: {args.Value}");
client.UnhandledEventReceived += (sender, args) => Console.WriteLine($"UnhandledEventReceived: Namespace: {args.Namespace}, Value: {args.Value}");
client.ErrorReceived += (sender, args) => Console.WriteLine($"ErrorReceived: Namespace: {args.Namespace}, Value: {args.Value}");
client.ExceptionOccurred += (sender, args) => Console.WriteLine($"ExceptionOccurred: {args.Value}");
client.On("login", () =>
{
Console.WriteLine("You are logged in.");
});
client.On("login", json =>
{
Console.WriteLine($"You are logged in. Json: \"{json}\"");
});
client.On("login", message =>
{
Console.WriteLine($"You are logged in. Total number of users: {message.NumUsers}");
});
client.On("user joined", message =>
{
Console.WriteLine($"User joined: {message.Username}. Total number of users: {message.NumUsers}");
});
client.On("user left", message =>
{
Console.WriteLine($"User left: {message.Username}. Total number of users: {message.NumUsers}");
});
client.On("typing", message =>
{
Console.WriteLine($"User typing: {message.Username}");
});
client.On("stop typing", message =>
{
Console.WriteLine($"User stop typing: {message.Username}");
});
client.On("new message", message =>
{
Console.WriteLine($"New message from user \"{message.Username}\": {message.Message}");
});
await client.ConnectAsync(new Uri("wss://socketio-chat-h9jt.herokuapp.com/"));
await client.Emit("add user", "C# H.Socket.IO Test User");
await Task.Delay(TimeSpan.FromMilliseconds(200));
await client.Emit("typing");
await Task.Delay(TimeSpan.FromMilliseconds(200));
await client.Emit("new message", "hello");
await Task.Delay(TimeSpan.FromMilliseconds(200));
await client.Emit("stop typing");
await Task.Delay(TimeSpan.FromSeconds(2));
await client.DisconnectAsync();
}
```
### Namespaces
```cs
// Will be sent with all messages(Unless otherwise stated).
// Also automatically connects to it.
client.DefaultNamespace = "my";
// or
// Connects to "my" namespace.
await client.ConnectAsync(new Uri(LocalCharServerUrl), namespaces: "my");
// Sends message to "my" namespace.
await client.Emit("message", "hello", "my");
```
### Custom arguments
```cs
await client.ConnectAsync(new Uri($"wss://socketio-chat-h9jt.herokuapp.com/?access_token={mAccessToken}"));
```
### Live Example
C# .NET Fiddle - https://dotnetfiddle.net/FWMpQ3
VB.NET .NET Fiddle - https://dotnetfiddle.net/WzIdnG
Http client of the tested Socket.IO server - https://socket-io-chat.now.sh/
### Used documentation
Socket.IO Protocol - https://github.com/socketio/socket.io-protocol
Engine.IO Protocol - https://github.com/socketio/engine.io-protocol
Python implementation of Socket.IO - https://github.com/miguelgrinberg/python-socketio/blob/master/socketio/
Python implementation of Engine.IO - https://github.com/miguelgrinberg/python-engineio/blob/master/engineio/
### Contacts
* [mail](mailto:[email protected])