SocketIOSharp is a Socket.IO protocol revision 4 client library based on Engine.IO and WebSocket protocol. It depends on WebSocketSharp to use WebSocket protocol. Engine.IO protocol is partly implemented by itself.
-
Command
Install-Package SocketIOSharpin nuget package manager console.
using SocketIOSharp.Client;SocketIOClient client = new SocketIOClient(SocketIOClient.Scheme.ws, host, port);public enum Scheme
{
ws,
wss
}It is used to determine whether SocketIOClient instance will connect to server using WebSocket protocol or WebSocketSecure protocol.
public SocketIOClient(SocketIOClient.Scheme Scheme, string Host, int Port, bool JsonOnly = false, bool AutoReconnect = false, bool UseAckTimeout = false)-
bool JsonOnlyis used to determine whetherSocketIOClientinstance will or will not acceptWebSocketbinary packet. -
bool AutoReconnectis used to determine whetherSocketIOClientinstnace will or will not reconnect to server whenWebSocket.OnCloseis called. -
bool UseAckTimeoutis used to determine whetherSocketIOClientinstnace will or will not automatically remove timed out ack actions.
-
All options above can be changed after construct like
client.JsonOnly = false. Default value of these arefalse. -
If
JsonOnlyistrue,SocketIOClientinstance will NOT handleWebSocketbinary packet. -
If
AutoReconnectistrue,SocketIOClientinstance will reconnect afterWebSocket.OnCloseis called. -
If
UseAckTimeoutistrue,SocketIOClientinstance will automatically remove timed out ack actions.
client.Connect();client.Close();or
client.Dispose();Since SocketIOClient implements IDisposable interface, it will be automatically disconnect when SocketIOClient.Dispose is called.
For convenient usage, it is implemented to can be used as Javascript style.
client.On(SocketIOClient.Event.CONNECTION, (JToken[] Data) => // Type of argument is JToken[].
{
Console.WriteLine("Connected!");
});
client.On(SocketIOClient.Event.DISCONNECT, (Data) => // Argument can be used without type.
{
Console.WriteLine("Disconnected!");
});
client.On(SocketIOClient.Event.ERROR, (Data) =>
{
if (Data != null && Data.Length > 0 && Data[0] != null)
{
Console.WriteLine("Error : " + Data[0]);
}
else
{
Console.WrtieLine("Unkown Error");
}
});
client.On("message", (Data) =>
{
if (Data != null && Data.Length > 0 && Data[0] != null)
{
Console.WriteLine("Message : " + Data[0]);
}
});
client.On("CustomEvent", CustomEventHandler); // Handler can be method.
client.On(9001, ItsOverNineThousands); // Type of event is JToken. So, it can be a number.
client.Off(9001, ItsOverNineThousands); // Remove 9001 event handler.client.On("ACK1", (JToken[] Data, (JToken[] Data) => { Console.WriteLine("ACK : " + Data) } =>
{
// Type of first argument is JToken[].
// Type of second arguemtn is Action<JToken[]>.
Console.Write("On event ack1 : " + Data);
});
client.On("ACK2", (Data, AckAction) => // Second argument can be method.
{
Console.Write("On event ack2 : " + Data);
});
client.On("ACK3", CustomAckHandler); // Handler can be method.
client.On(42, LifeTheUniverseAndTheEverything); // Type of event is JToken. So, it can be a number.
client.Off(42, LifeTheUniverseAndTheEverything); // Remove 42 ack handler.public static class Event
{
public static readonly string CONNECTION = "connection";
public static readonly string DISCONNECT = "disconnect";
public static readonly string ERROR = "error";
}These are the common basic Socket.IO events.
client.Emit("Event without data and ack");
client.Emit("Event only with data", "Hello world");
client.Emit("Event only with ack, action as lambda", (Data) => Console.WriteLine("ACK : " + Data));
client.Emit("Event only with ack, action as method", Console.WriteLine);
client.Emit("Event with data and ack, action as lambda", 9001, (Data) => Console.WriteLine("ACK : " + Data));
client.Emit("Event with data and ack, action as method", 42, Console.WriteLine);
// Type of data is JToken. So, it can be a number.- Fully implemented
Socket.IOprotocol includeshartbeat. See Socket.IO protocol specifications for details. - Partly implemented
Engine.IOprotocol. For now,WebSocketis the ONLY supported transport. And the packet typeupgradeandnoopis NOT supproted. See Engine.IO protocol specifications for details.
- Fully implemented
Engine.IOclient (It will implemented as independent project) - Transport without
WebSocket
- Partly implemented Engine.IO : It implements part of
Engine.IOonly for processingSocket.IOpacket. Therefore, it can NOT be used asEngine.IOclient. - Only with WebSocket : Since it uses
Websocketas transport, it can be used ONLY whenWebSocketis avalible atSocket.IOserver. - Code style :
SocketIOSharpis written in 2016 by a college student. It can be looked as old or odd style.
Welcome to report issue or create pull request. I will check it happily.
SocketIOSharp is under The MIT License.