MicroSerializationLibrary 2.1.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package MicroSerializationLibrary --version 2.1.0.1
                    


                    

                
NuGet\Install-Package MicroSerializationLibrary -Version 2.1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="MicroSerializationLibrary" Version="2.1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="MicroSerializationLibrary" Version="2.1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="MicroSerializationLibrary" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add MicroSerializationLibrary --version 2.1.0.1
                    


                    

                
#r "nuget: MicroSerializationLibrary, 2.1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=MicroSerializationLibrary&version=2.1.0.1
                    


                            Install MicroSerializationLibrary as a Cake Addin
                        

                    

                
#tool nuget:?package=MicroSerializationLibrary&version=2.1.0.1
                    


                            Install MicroSerializationLibrary as a Cake Tool

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

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net6.0-windows7.0 is compatible.  net6.0-windows8.0 is compatible.  net6.0-windows10.0.17763 is compatible.  net6.0-windows10.0.18362 is compatible.  net6.0-windows10.0.19041 is compatible.  net6.0-windows10.0.20348 is compatible.  net6.0-windows10.0.22621 is compatible.  net6.0-windows10.0.26100 is compatible.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net7.0-windows7.0 is compatible.  net7.0-windows8.0 is compatible.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-browser1.0 is compatible.  net8.0-ios was computed.  net8.0-ios18.0 is compatible.  net8.0-maccatalyst was computed.  net8.0-maccatalyst18.0 is compatible.  net8.0-macos was computed.  net8.0-macos15.0 is compatible.  net8.0-tvos was computed.  net8.0-tvos18.0 is compatible.  net8.0-windows was computed.  net8.0-windows7.0 is compatible.  net8.0-windows8.0 is compatible.  net8.0-windows10.0.17763 is compatible.  net8.0-windows10.0.18362 is compatible.  net8.0-windows10.0.19041 is compatible.  net8.0-windows10.0.20348 is compatible.  net8.0-windows10.0.22621 is compatible.  net8.0-windows10.0.26100 is compatible.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-browser1.0 is compatible.  net9.0-ios was computed.  net9.0-ios18.0 is compatible.  net9.0-maccatalyst was computed.  net9.0-maccatalyst18.0 is compatible.  net9.0-macos was computed.  net9.0-macos15.0 is compatible.  net9.0-tvos was computed.  net9.0-tvos18.0 is compatible.  net9.0-windows was computed.  net9.0-windows7.0 is compatible.  net9.0-windows8.0 is compatible.  net9.0-windows10.0.17763 is compatible.  net9.0-windows10.0.18362 is compatible.  net9.0-windows10.0.19041 is compatible.  net9.0-windows10.0.20348 is compatible.  net9.0-windows10.0.22621 is compatible.  net9.0-windows10.0.26100 is compatible. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on MicroSerializationLibrary:

Package Downloads
JackDebug.WPF

Debug your WPF application easily with JackDebug.
MicroSerializationLibrary.JSON

An Implenentation of Json for MicroSerializationLibrary
MicroSerializationLibrary.MessagePack

An Implenentation of MsgPack for MicroSerializationLibrary

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.0.1 38 4/3/2025
2.1.0 51 4/3/2025 2.1.0 is deprecated because it has critical bugs.
2.0.0.30 287 3/14/2025 2.0.0.30 is deprecated.
2.0.0.25 243 3/13/2025 2.0.0.25 is deprecated because it has critical bugs.
2.0.0.24 248 3/12/2025 2.0.0.24 is deprecated because it has critical bugs.
2.0.0.23 254 3/10/2025 2.0.0.23 is deprecated because it has critical bugs.
2.0.0.20 242 3/9/2025 2.0.0.20 is deprecated because it has critical bugs.
2.0.0.15 236 3/9/2025 2.0.0.15 is deprecated because it has critical bugs.
2.0.0.1 305 3/7/2025 2.0.0.1 is deprecated because it has critical bugs.
2.0.0 326 3/5/2025 2.0.0 is deprecated because it has critical bugs.
1.1.4.5 192 2/21/2025 1.1.4.5 is deprecated because it has critical bugs.
1.1.4.3 119 2/19/2025 1.1.4.3 is deprecated because it has critical bugs.
1.1.4.2 119 2/17/2025 1.1.4.2 is deprecated because it has critical bugs.
1.1.4.1 119 2/17/2025 1.1.4.1 is deprecated because it has critical bugs.
1.1.4 117 2/16/2025 1.1.4 is deprecated because it has critical bugs.
1.1.3.2 118 2/14/2025 1.1.3.2 is deprecated because it has critical bugs.
1.1.3.1 118 2/13/2025 1.1.3.1 is deprecated because it has critical bugs.
1.1.3 117 2/13/2025 1.1.3 is deprecated because it is no longer maintained and has critical bugs.
1.1.2.25 129 1/28/2025 1.1.2.25 is deprecated because it is no longer maintained and has critical bugs.
1.1.2.23 80 1/15/2025 1.1.2.23 is deprecated because it is no longer maintained and has critical bugs.
1.1.2.22 104 1/12/2025 1.1.2.22 is deprecated because it is no longer maintained and has critical bugs.
1.1.2.21 104 1/7/2025 1.1.2.21 is deprecated because it is no longer maintained and has critical bugs.
1.1.2.2 329 1/2/2025 1.1.2.2 is deprecated because it is no longer maintained and has critical bugs.

Async Socket Accepting memory leak. Uses 10gb+ memory over a few hours.
High CPU Usage at function ConcurrentDictionaryExtensions.ValuesForAll changed to enumerate keypairvalues rather than .Values