MicroSerializationLibrary.Android 2.0.0.23

Micro Serialization Library

MSL NuGet Package

PM> NuGet\Install-Package MicroSerializationLibrary

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/

NuGet Package Manager

PM> NuGet\Install-Package MicroSerializationLibrary.JSON

PM> NuGet\Install-Package MicroSerializationLibrary.MessagePack 

v2.0.0.23 Notes

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.

C#

private async void MyTcpClient_PeerConnected(object sender, PeerIdentification RemotePeer) {
    if (C.RemoteIdentity != null && RemotePeer.ID != C.RemoteIdentity.ID) {
        // Make sure it's not your own client.
        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.

C#

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 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 SurroundingClass() {
        // 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