Netly

_{powered by ALEC1O}

##### About > _{Netly is a flexible socket library built on c-sharp. It is compatible with (Android, iOS, Linux,
> Windows...)}
##### Documentation > _{Netly docs ([HERE](https://netly.docs.kezero.com))}
##### Install > _{Official publisher} | _Nuget | _{Unity Asset Store} | |---------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| | _{Install on [Nuget](https://www.nuget.org/packages/Netly)} | _{Install on [Asset Store ](https://assetstore.unity.com/packages/tools/network/225473)} |
##### Sponsor and Supporter > _{Well, this project is open source and only development can be supported by suggestions for improvements, bug
> reports or the like. (for those who want to financially support this resource is not available at this time)}

##### Versions > _{Notable changes} | _{v1 (old)} | _{v2 (old)} | _{v3 (stable)} | _{v4 (nonexistent)} | |--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|-----------------------------------------------| | _{TCP (client/server)} | _{TCP/IP [Message Framing](https://web.archive.org/web/20230219220947/https://blog.stephencleary.com/2009/04/message-framing.html)} | _{TLS/SSL (client/server)} | _{Websocket (client/server)} | | _UDP | _{TCP/UDP performance improvement} | _{Include docs/sample (SSL/TLS)} | _{Include docs/sample (Websocket)} | | | | _{``Message Framing`` memory and performance improve} | | | | | _{``Message Framing`` new protocol} | | | | | _{``UDP`` impl connection with udp (ping/timeout)} | | | | | _{collaborative documentation ``docsify``} | | | | | _{Byter ``2.0``} | |
##### List of tested platforms - _{[.NET](https://dotnet.microsoft.com) (SDK)} - _{[Mono](https://mono-project.com) (SDK)} - _{[Unity](https://unity.com) (Engine)}
##### Feature > _{Below are some missing features that are planned to be added in later versions.}
- _{Websocket (v4)}
##### Dependency - _{[Byter](https://github.com/alec1o/Byter)}
##### Build > ###### Build dependencies - _{[Git](http://git-scm.com/)} - _{[.NET](http://dot.net)} > ###### Build step-by-step ```rb # 1. clone project $ git clone "https://github.com/alec1o/Netly" netly # 2. build project $ dotnet build netly/ -c Release -o netly/bin/ # NOTE: # Netly.dll require Byter.dll because is Netly dependency # Netly.dll and Byter.dll have on build folder /bin/ ```
##### Demo > _{TcpClient ``Syntax``} ```csharp using Netly; using Netly.Core; var client = new TcpClient(framing: true); // Enable SSL/TLS (onValidate delegate is optional) client.UseEncryption(enableEncryption: true, onValidate: null); client.OnOpen(() => { // client connected }); client.OnClose(() => { // client disconnected }); client.OnError((Exception exception) => { // connection close because: 1.Error on connecting, 2.Invalid framing data }); client.OnData((byte[] data) => { // raw data received }); client.OnEvent((string name, byte[] data) => { // event received (event use netly protocol) }); client.OnModify((Socket socket) => { // you can modify socket, called before open connection }); client.Open(new Host("127.0.0.1", 8080)); ``` > _{TcpServer ``Syntax``} ```csharp using Netly; using Netly.Core; var server = new TcpServer(framing: true); // Enable SSL/TLS byte[] pfxCert = ; string pfxPass = ; server.UseEncryption(pfxCert, pfxPass, SslProtocols.Tls13); // TLS v1.3 server.OnOpen(() => { // server start listen }); server.OnClose(() => { // server stop listen }); server.OnError((Exception exception) => { // error on start listen (connecting) }); server.OnData((TcpClient client, byte[] data) => { // a client receive raw data }); server.OnEvent((TcpClient client, string name, byte[] data) => { // a client receive event (event use netly protocol) }); server.OnEnter((TcpClient client) => { // a client connected on server client.OnClose(() => { // alternative of: TcpServer.OnClose }); client.OnData(() => { // alternative of: TcpServer.OnData }); client.OnEvent(() => { // alternative of: TcpServer.OnEvent }); }); server.OnExit((TcpClient client) => { // a client disconnected from server }); server.OnModify((Socket socket) => { // you can modify socket, called before listen and bind a port }); server.Open(new Host("127.0.0.1", 8080)); ```