MicroSerializationLibrary 1.1.2.21

Micro Serialization Library

MicroSerializationLibrary is a Network & Serialization library intended for ease of use.

Real-World Examples

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

No Serializer is inlcuded in this package.

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

https://www.nuget.org/packages/MicroSerializationLibrary.JSON/

https://www.nuget.org/packages/MicroSerializationLibrary.MessagePack/

CLI

dotnet add package MicroSerializationLibrary.JSON

dotnet add package MicroSerializationLibrary.MessagePack

NuGet Package Manager

PM> NuGet\Install-Package MicroSerializationLibrary.JSON

PM> NuGet\Install-Package MicroSerializationLibrary.MessagePack 

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 Client;
    MicroSerializationLibrary.Networking.Server.TcpServer Server;
    private const string Host = "127.0.0.1";
    private const int Port = 7474;

    private void Server_OnReceive(Socket sender, object obj, int BytesReceived) {
        // Handle  the incoming object
        
        // Send The Client an Object
        Server.Send(sender.RemoteEndPoint, MySerializableClass);

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

    }

    private void Client_OnConnected(Socket Sender) {
        Client.Send(new AuthorizationRequestObject());
    }


    public SurroundingClass() {
        Server = new Server.TcpServer(Serializer, Port);
        Server.OnReceive += Server_OnReceive;
        Server.Listen(9999);

        Client = new Client.TcpClient(Serializer);
        Client.OnConnected += Client_OnConnected;
        Client.Connect("127.0.0.1", Port);
    }

VB.NET

    Dim Serializer As Serialization.JsonSerializer = New Serialization.JsonSerializer()
    Dim WithEvents Client As New MicroSerializationLibrary.Networking.Client.TcpClient(Serializer)
    Dim WithEvents Server As New MicroSerializationLibrary.Networking.Server.TcpServer(Serializer)
    Private Const Host As string = "127.0.0.1"
    Private Const Port As Integer = 7474


    Private Sub Server_OnReceive(sender As Socket, obj As Object, BytesReceived As Integer) Handles Server.OnReceive
        ' Handle  the incoming object

        ' Send The Client an Object
        Server.Send(sender.RemoteEndPoint, MySerializableClass)

        ' Send All Clients an Object
        Server.Broadcast(MySerializableClass)
    End Sub

    Private Sub Client_OnConnected(Sender As Socket) Handles Client.OnConnected
        Client.Send(New AuthorizationRequestObject)
    End Sub

   Public Sub New()
    Server = New Server.TcpServer(Serializer, Port)
    Server.Listen(9999)

    Client = New Client.TcpClient(Serializer)
    client.Connect(Host, Port)
End Sub

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT