Getting Started¶

Connecting¶

First step to connect to a Socket.IO server is to include its namespace (Best.SocketIO) and create a SocketManager instance:

1
2
3

using Best.SocketIO;

var manager = new SocketManager(new Uri("http://localhost:3000"));

By default, SocketManager going to start connecting to the server as soon as a namespace is accessed through the Socket property or GetSocket function:

1
2
3
4
5
6
7
8

using Best.SocketIO;

var manager = new SocketManager(new Uri("http://localhost:3000"));

// Accessing the root ("/") socket
var root = manager.Socket;

// At this point the manager already started to connect to the server

This auto connection can be disabled by using and setting up a SocketOptions instance:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

using Best.SocketIO;

SocketOptions options = new SocketOptions();
options.AutoConnect = false;

var manager = new SocketManager(new Uri("http://localhost:3000"), options);

var root = manager.Socket;

// AutoConnect is turned off, Open must be called
manager.Open();

This way the SocketManager will start connecting to the server only when its Open function is called. Check out the SocketOptions topic for more options and callbacks!

The Connect Event¶

To get notified when the connection to the server completes, we can subscribe to the connect default event:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

using Best.SocketIO;
using Best.SocketIO.Events;

var manager = new SocketManager(new Uri("http://localhost:3000"));

manager.Socket.On<ConnectResponse>(SocketIOEventTypes.Connect, OnConnected);

void OnConnected(ConnectResponse resp)
{
    Debug.Log("Connected!");
}

Disconnecting¶

SocketManager's Close function closes all sockets, shuts down the transport and no more communication is done to the server. Calling Disconnect on a socket disconnects only that socket, communication through other sockets are still possible. Disconnecting the last socket will also close the SocketManager.

Complete Example¶

To put it together, here's a complete example.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

using System;

using Best.SocketIO;

using UnityEngine;

namespace SocketIOExample
{
    public sealed class ChatSample : MonoBehaviour
    {
        private SocketManager manager;

        // Unity Start event
        void Start()
        {
            // Create and setup SocketOptions
            SocketOptions options = new SocketOptions();
            options.AutoConnect = false;

            // Create and setup SocketManager
            this.manager = new SocketManager(new Uri("http://localhost:3000"), options);

            // Set subscriptions
            manager.Socket.On<ConnectResponse>(SocketIOEventTypes.Connect, OnConnected);

            // Start connecting to the server
            this.manager.Open();
        }

        // Connected event handler implementation
        void OnConnected(ConnectResponse resp)
        {
            Debug.Log("Connected!");
        }

        // Unity OnDestroy event
        void OnDestroy()
        {
            this.manager?.Close();
            this.manager = null;
        }
    }
}

Comments