Table of Contents

Namespace Firesplash.GameDevAssets.SocketIOPlus

Classes

DataTypes

Contains simple DataTypes used for Socket.IO communication and states

DataTypes.SocketIOErrorPayload

A Payload template to mimic JS "Error" events. Error messages are contained in the "message" property

DataTypes.SocketIOException

This is the base class all Socket.IO-Exceptions derive from

DataTypes.SocketIOProtocolViolationException

This exception is thrown, when the application is trying to violate a protocol constraint. There are only rare possibilities to do so, though. This exception is NOT thrown for incoming packages!

DefaultParser

This implemented the default Socket.IO parser to parse string typed EngineIO messages into Socket.IO and encode packets vice versa.

Parser

This is a skeleton class for writing Socket.IO / Engine.IO transcoders

SocketIOClient

This MonoBehavior derives from EngineIOClient and implements the main Socket.IO Manager logic on top of Engine.IO. It implements Socket.IO protocol version 5 (which is used by Socket.IO v3 and v4)

SocketIOEvent
SocketIONamespace

This class represents a (usually connected) Socket.IO namespace and implements the EventEmitter and the EventReceiver. We try to keep our API as near to the official Socket.IO V4 API as possible within this class. https://socket.io/docs/v4/emitting-events/https://socket.io/docs/v4/listening-to-events/#eventemitter-methods

SocketIOPacket

This class represents a lowlevel SocketIO packet in its parsed state.

Enums

DataTypes.ConnectionState
DataTypes.PacketType

Delegates

DataTypes.SocketIOAuthPayloadCallback

This delegate gets called when a Socket.IO namespace is being connected. Your function must return null if not auht payload is required for the namespace, or an object that can be serialized by Json.Net if a payload must be provided

DataTypes.ThreadedSocketIOEvent

This delegate gets called on a namespace for any Socket.IO event (received or internally generated). The delegate is invoked from a Thread so it is not safe to access Unity functions from it.