👁 Image
MicroSerializationLibrary 2.1.0.1

Micro Serialization Library

Fast, Efficient, 100% Managed, Peer to Peer, Non Generic, Extensible TCP Client & Server with built in Serialization that can be used to transmit any type.

Micro Serialization Library automatically serializes Public Properties for transfer within each object you send or receive without requiring generics.

No Serializer is inlcuded in this package.

Please Install MicroSerializationLibrary.JSON or MicroserializionLibrary.MsgPack to use this package.

MSL.JSON Nuget Package

PM> NuGet\Install-Package MicroSerializationLibrary.JSON

MSL.MessagePack Nuget Package

PM> NuGet\Install-Package MicroSerializationLibrary.MessagePack

v2.1 Release Notes

You must Dispose all TcpClients/TcpServers manually. Otherwise, your application will remain open in the background.

On Application Exit call

 ThreadManager.Shutdown();

• Multi-CPU Support at Runtime (No configuration required)
• Fully Thread Safe and Concurrent
• Host Caching for Improved Connection Performance
• Standardized Type, Method, And Function Naming
• ThreadManager Class to handle all Tcp Threading

Hundreds of Bugfixes Including

• Disconnection Detection is now using Socket.Poll
• Peer to Peer reliability increased by removing the need to get external IP from web server
• Async Socket Accepting memory leak. Uses 10gb+ memory over a few hours
• High CPU Usage at ConcurrentDictionaryExtensions.ValuesForAll changed to keypairvalues instead of cloning via .Values

2.0.0.33 Release Notes

Added SerializedObject class to support all types in Tcp Transmission.

Replaced all string buffering with byte array to allow for binary serializers.

Automatic Maximum Transmission Unit adjustment via Network Interface Card

Objects over MTU are now segmented automatically.

ISerializationProtocol MUST include an empty constructor.

Peer to peer functionality built for faster latency and direct communication between clients.

P2P TcpServer is automatically port forwarded using Mono.NAT UPNP.

Connect to the main server then, anytime after the TcpClient.OnIdentified Event start a P2P server.

private async void MyTcpClient_PeerConnected(object sender, PeerIdentification RemotePeer) {
 // Make sure it's not your own client.
 if (MyTcpClient.RemoteIdentity != null && RemotePeer.ID != MyTcpClient.RemoteIdentity.ID) {
 TcpServer P2P_Server = await RemotePeer.StartServer("ExampleServer");
 P2P_Server.Logging = true;
 P2P_Server.LogReceiveEvents = true;
 P2P_Server.LogSendEvents = true;
 P2P_Server.OnReceive += P2PServer_OnReceive;
 P2P_Server.OnDisconnected += P2PServer_OnDisconnected;
 P2P_Server.OnError += P2PServer_OnError;
 }
}

Then, on the other Remote Client Accept by handling the TcpClient_PeerConnectionRequest Event.

private async void MyTcpClient_PeerConnectionRequest(object sender, P2PServer Server) {
 // CHANGE THIS - Add UI which allows the user to accept the connection.
 TcpClient P2P_Client = await Server.Accept(true, "ExampleClient");
 P2P_Client.Logging = true;
 P2P_Client.LogReceiveEvents = true;
 P2P_Client.LogSendEvents = true;
 P2P_Client.OnReceive += P2PClient_OnReceive;
 P2P_Client.OnConnected += P2PClient_OnConnected;
 P2P_Client.OnDisconnected += P2PClient_OnDisconnected;
 P2P_Client.OnError += P2PClient_OnError;
}

Features also incude TcpClient.Send(PeerIdentification, Object) for easily sending indirectly to another client from a client without having to handle it on the server.

PeerRedirect can be canceled on the server inside the TcpServer.OnReceive via e.CancelPeerRedirect to True.

Debug/Console Logging added for all network events besides Send and Receive via TcpClient.Logging = True & TcpClient.LogToOutput = True etc..

Send and Receive events can be individually enabled via TcpClient.LogReceiveEvents etc...

Async TcpClient.Connect() w/ timeout (3 seconds) & AutoReconnect Option.

Real-World Examples

• Chat servers
• Data Transfer
• Local Communication
• Unity Multiplayer Development

All Serializers will only serialize Properties within each Serializable Class.

Note

MicroSerializationLibrary exposes the ISerializationProtocol interface which can be used to add another serializer.

Preferential use of Serializers

MsgPack Serializer

MsgPack is a fast serializer, which comes at the cost of stability.

Used when Performance is key in your application.

JSON Serializer

JSON is a serializer used by many, and will not fail.

While it is very accurate, JSON does not compare to MsgPack when it comes to performance.

Client & Server are Event Driven.

The events are executed on a separate thread.

C#

Serialization.JsonSerializer Serializer = new Serialization.JsonSerializer();
MicroSerializationLibrary.Networking.Client.TcpClient TcpClient;
MicroSerializationLibrary.Networking.Server.TcpServer TcpServer;

private const string Host = "127.0.0.1";
private const int Port = 7474;

// Handle the incoming object
private void TcpServer_OnReceive(ref ReceivedEventArgs e) {
 // Send The Client an Object
 TcpServer.Send(Client, MySerializableClass);

 // Send All Clients an Object
 TcpServer.Broadcast(MySerializableClass);

}

private void TcpClient_OnConnected(ConnectedEventArgs e) {
 TcpClient.Send(new AuthorizationRequestObject());
}

public SurroundingVoid() {
 // Creating a server.
 TcpServer = new Server.TcpServer(Serializer, Port);
 TcpServer.OnReceive += TcpServer_OnReceive;

 // '9999' being the max amount of pending connections allowed.
 TcpServer.Listen(9999);


 // Creating a client.
 TcpClient = new Client.TcpClient(Serializer);
 TcpClient.OnConnected += TcpClient_OnConnected;
 TcpClient.Connect("127.0.0.1", Port);
}

Contributing

Pull requests are welcome. For major changes, please open an issue first

to discuss what you would like to change.

License

MIT