UnityWebsocketsObserver

Based on NativeWebSocket
Analog for the backend: extented-ws

This is a websocket wrapper for Unity designed to process JSON messages
The observer-handlers approach is used, like in FastAPI and Aiogram it's allows you to quickly integrate web sockets into the project, and expand the list of requests-responses

Installation

Requires Unity 2019.1+ with .NET 4.x+ Runtime

Install via UPM (Unity Package Manager)

1. Open Unity
2. Open Package Manager Window
3. Click Add Package From Git URL
4. Enter URL: https://github.com/endel/NativeWebSocket.git#upm
5. Repert with URL: https://github.com/dexsper/UnityWebsocketsObserver.git

Install manually

1. Download this project
2. Copy the sources from WebsocketsObserver into your Assets directory.

Usage

First you need initialize observer instance in scene:

Singleton

1. Drop class SingletonWebsocketsObserver on gameobject in scene
2. Set websokets url
3. Use SingletonWebsocketsObserver.Instance

For ease of use, you need to use the following JSON format both on the client and on the server:

{
  "Type": "CalculateRequest",
  "Data": {
    "Numbers": [2, 2]
  }
}

{
  "Type": "CalculateResponse",
  "Data": {
    "Result": 4
  }
}

Handle and Send message:

using WebsocketsObserver;
using WebsocketsObserver.Request;

public struct CalculateResponse : IServerMessage
{
    public int Result { get; set; }
}

public struct CalculateRequest : IClientRequest
{
    public int[] Numbers { get; set; }
}

public class Test : MonoBehaviour
{
    private void Start()
    {
        var observerInstance = SingletonWebsocketsObserver.Instance;

        observerInstance.RegisterHandler(OnCalculated);
        observerInstance.SendRequest(new CalculateRequest
        {
            Numbers = new int[2] { 2, 2 }
        });
    }

    private void OnCalculated(CalculateResponse response)
    {
    }
}