modify read me

hiram3512 · Aug 2, 2019 · 5902673 · 5902673
1 parent 89fc6b8
commit 5902673
Show file tree

Hide file tree

Showing 138 changed files with 471 additions and 439 deletions.
diff --git a/...ty/Assets/HiSocket/HiFramework.Assert.dll → HiSocket/HiFramework.Assert.dll b/...ty/Assets/HiSocket/HiFramework.Assert.dll → HiSocket/HiFramework.Assert.dll
diff --git a/...nity/Assets/HiSocket/HiFramework.Core.dll → HiSocket/HiFramework.Core.dll b/...nity/Assets/HiSocket/HiFramework.Core.dll → HiSocket/HiFramework.Core.dll
diff --git a/...ple/unity/Assets/HiSocket/HiFramework.dll → HiSocket/HiFramework.dll b/...ple/unity/Assets/HiSocket/HiFramework.dll → HiSocket/HiFramework.dll
diff --git a/HiSocket/HiSocket.Message.dll b/HiSocket/HiSocket.Message.dll
diff --git a/HiSocket/HiSocket.Message.pdb b/HiSocket/HiSocket.Message.pdb
diff --git a/HiSocket/HiSocket.dll b/HiSocket/HiSocket.dll
diff --git a/HiSocket/HiSocket.pdb b/HiSocket/HiSocket.pdb
diff --git a/...le/unity/Assets/HiSocket/protobuf-net.dll → HiSocket/protobuf-net.dll b/...le/unity/Assets/HiSocket/protobuf-net.dll → HiSocket/protobuf-net.dll
diff --git a/HiSocket_2.8.1.zip b/HiSocket_2.8.1.zip
diff --git a/README.md b/README.md
@@ -40,8 +40,8 @@ It is a lightweight client socket solution, you can used it in Unity3d or C# pro
 ```
 
 More example:
-- C# project example:[Example](/example/csharp)
-- Unity project example:[Example](/example/unity)
+- C# project example:[Example](src/HiSocket.Example)
+- Unity project example:[Example](src/HiSocket.Example_Unity)
 
 -----
 
@@ -78,11 +78,11 @@ This project contains:
 
 
 ### Advanced
-- If you are clear about socket, you also can use TcpSocket(UdpSocket) to achieve your logic, anyway the recommend is TcpConnection(UdpConnection).
+- If you are clear about socket, you also can use TcpSocket to achieve your logic, anyway the recommend is TcpConnection.
 - You can use API get socket and do extra logic, for example modify socket's out time
 - You can use API get send and receive buffer, for example when disconnect, how to handle buffer's data? just clear or resend to server. 
 - OnSocketReceive and OnReceive are diffrent, for example OnSocketReceive size is 100 byte, if user do nothing when uppack OnReceive size is 100. but when user do some zip/unzip(encription.etc) OnReceive size is not 100 anymore. 
-- You can add many different plugins based on TcpConnection(UdpConnection) to achieve different functions.
+- You can add many different plugins based on TcpConnection to achieve different functions.
 - There are a message register base class help user to quick register id and callback(based on reflection)
 - The encryption is use AES, if you want to use encryption you can use the API to encrypte your bytes.
 - .etc
@@ -138,27 +138,33 @@ There are many example in **HiSocketExample** project or in **HiSocket.unitypack
 
 Package example:
 ```csharp
-public class Package : PackageBase
+public class PackageExample:PackageBase
     {
         protected override void Pack(BlockBuffer<byte> bytes, Action<byte[]> onPacked)
         {
+            //Use int as header
             int length = bytes.WritePosition;
             var header = BitConverter.GetBytes(length);
-            var newBytes = new byte[length + header.Length];
-            Buffer.BlockCopy(header, 0, newBytes, 0, header.Length);
-            Buffer.BlockCopy(bytes.Buffer, 0, newBytes, header.Length, length);
-            onPacked(newBytes);
+            var newBytes = new BlockBuffer<byte>(length + header.Length);
+            //Write header and body to buffer
+            newBytes.Write(header);
+            newBytes.Write(bytes.Buffer);
+            //Notice pack funished
+            onPacked(newBytes.Buffer);
         }
 
         protected override void Unpack(BlockBuffer<byte> bytes, Action<byte[]> onUnpacked)
         {
+            //Because header is int and cost 4 byte
             while (bytes.WritePosition > 4)
             {
                 int length = BitConverter.ToInt32(bytes.Buffer, 0);
+                //If receive body
                 if (bytes.WritePosition >= 4 + length)
                 {
                     bytes.MoveReadPostion(4);
                     var data = bytes.Read(length);
+                    //Notice unpack finished
                     onUnpacked(data);
                     bytes.ResetIndex();
                 }
@@ -168,40 +174,53 @@ public class Package : PackageBase
 ```
 
 ```csharp
-private IPackage package = new PackageExample();
-        private TcpConnection _tcp;
-        static void Main(string[] args)
+TcpConnection tcp;
+        void Connect()
         {
+            tcp = new TcpConnection(new PackageExample());
+            tcp.OnDisconnected += OnDisconnect;
+            tcp.Connect("127.0.0.1", 999);
+            tcp.Socket.NoDelay = true;
+            tcp.Socket.SendTimeout = 100;
+            tcp.Socket.ReceiveTimeout = 200;
+            //...
 
-        }
-        void Init()
-        {
-            tcp = new TcpConnection(package);
-            tcp.OnConnected += OnConnected;
-            tcp.OnReceive += Receive;
-            //_tcp.OnError
-            //_tcp.OnDisconnected
-        }
-        void OnConnected()
-        {
-            //connect success
-            tcp.Send(new byte[10]);//send message
-            tcp.DisConnect();//disconnect
+
+            // you can add plugin sub from IPlugins
+            tcp.AddPlugin(new StatisticalPlugin("Statistical"));//this plugin calculate how many send
         }
 
-        void Receive(byte[] bytes)
+        void OnDisconnect()
         {
-            //get message from server
+            var length = tcp.SendBuffer.WritePosition;
+            Console.WriteLine("Still have {0} not send to server when abnormal shutdown");
+            var data = tcp.SendBuffer.Read(length);
+            tcp.SendBuffer.ResetIndex();
+
+            //use can handle these data, for example maybe can send next time when connect again
+            //tcp.Send(data);
         }
 ```
 
 ```csharp
- void Init()
+ /// <summary>
+    /// The recommend is use TcpConnection 
+    /// </summary>
+    class Example3
+    {
+        TcpSocket tcp; //The recommend is use TcpConnection 
+        void Connect()
         {
-            var tcp = new TcpConnection(new PackageExample());
-            tcp.AddPlugin(new PingPlugin("ping", tcp));
-            //tcp.GetPlugin("ping");
+            tcp = new TcpSocket(1024);//set buffer size
+            tcp.OnReceiveBytes += OnReceive;
+            tcp.Connect("127.0.0.1", 999);
         }
+
+        void OnReceive(byte[] bytes)
+        {
+            //split bytes here
+        }
+    }
 ```
 
 

diff --git a/README_zh.md b/README_zh.md
@@ -39,8 +39,8 @@
         }
 ```
 更多示例:
-- C#项目示例:[示例](/example/csharp)
-- Unity项目示例:[示例](/example/unity)
+- C#项目示例:[示例](src/HiSocket.Example)
+- Unity项目示例:[示例](src/HiSocket.Example_Unity)
 
 -----
 
@@ -75,11 +75,11 @@
 - Ping: 源码包含一个Ping插件可以使用,但是如果用在unity3d工程中会报错(因为mono的问题,在.net2.0会报错.net4.6可以正常使用)
 
 ### 高级功能
-- 如果对Socket很熟悉,也可以使用TcpSocket(UdpSocket)来实现功能,但是还是推荐使用TcpConnection(UdpConnection)的方式.
+- 如果对Socket很熟悉,也可以使用TcpSocket来实现功能,但是还是推荐使用TcpConnection的方式.
 - 通过接口可以访问底层Socket对象扩展逻辑,比如修改超时时间.
 - 通过接口可以获得发送接收缓冲区,比如断开连接时用户如何处理缓冲区数据?直接清空还是重连后继续发送.n
 - OnSocketReceive和OnReceive是不同的,比如当OnSocketReceive接受大小是100字节,当用户解包时不做操作,OnReceive大小是100字节,当用户解包时做解压缩(解密等)操作后,OnReceive大小不再是100.
-- 可以向TcpConnection(UdpConnection)添加不同的插件完成所需的功能,
+- 可以向TcpConnection添加不同的插件完成所需的功能,
 - 注册基类可以方便快速注册消息(基于反射)
 - 加密采用AES的方式,如果想使用加密可以调用这部分的接口加密字节数据.
 - .etc
@@ -138,27 +138,33 @@ Udp协议提供不可靠的报文消息,用户无法知道当前连接状态,但
 
 Package example:
 ```csharp
-public class Package : PackageBase
+public class PackageExample:PackageBase
     {
         protected override void Pack(BlockBuffer<byte> bytes, Action<byte[]> onPacked)
         {
+            //Use int as header
             int length = bytes.WritePosition;
             var header = BitConverter.GetBytes(length);
-            var newBytes = new byte[length + header.Length];
-            Buffer.BlockCopy(header, 0, newBytes, 0, header.Length);
-            Buffer.BlockCopy(bytes.Buffer, 0, newBytes, header.Length, length);
-            onPacked(newBytes);
+            var newBytes = new BlockBuffer<byte>(length + header.Length);
+            //Write header and body to buffer
+            newBytes.Write(header);
+            newBytes.Write(bytes.Buffer);
+            //Notice pack funished
+            onPacked(newBytes.Buffer);
         }
 
         protected override void Unpack(BlockBuffer<byte> bytes, Action<byte[]> onUnpacked)
         {
+            //Because header is int and cost 4 byte
             while (bytes.WritePosition > 4)
             {
                 int length = BitConverter.ToInt32(bytes.Buffer, 0);
+                //If receive body
                 if (bytes.WritePosition >= 4 + length)
                 {
                     bytes.MoveReadPostion(4);
                     var data = bytes.Read(length);
+                    //Notice unpack finished
                     onUnpacked(data);
                     bytes.ResetIndex();
                 }
@@ -168,40 +174,53 @@ public class Package : PackageBase
 ```
 
 ```csharp
-private IPackage package = new PackageExample();
-        private TcpConnection tcp;
-        static void Main(string[] args)
+TcpConnection tcp;
+        void Connect()
         {
+            tcp = new TcpConnection(new PackageExample());
+            tcp.OnDisconnected += OnDisconnect;
+            tcp.Connect("127.0.0.1", 999);
+            tcp.Socket.NoDelay = true;
+            tcp.Socket.SendTimeout = 100;
+            tcp.Socket.ReceiveTimeout = 200;
+            //...
 
-        }
-        void Init()
-        {
-            tcp = new TcpConnection(package);
-            tcp.OnConnected += OnConnected;
-            tcp.OnReceive += Receive;
-            //_tcp.OnError
-            //_tcp.OnDisconnected
-        }
-        void OnConnected()
-        {
-            //connect success
-            tcp.Send(new byte[10]);//send message
-            tcp.DisConnect();//disconnect
+
+            // you can add plugin sub from IPlugins
+            tcp.AddPlugin(new StatisticalPlugin("Statistical"));//this plugin calculate how many send
         }
 
-        void Receive(byte[] bytes)
+        void OnDisconnect()
         {
-            //get message from server
+            var length = tcp.SendBuffer.WritePosition;
+            Console.WriteLine("Still have {0} not send to server when abnormal shutdown");
+            var data = tcp.SendBuffer.Read(length);
+            tcp.SendBuffer.ResetIndex();
+
+            //use can handle these data, for example maybe can send next time when connect again
+            //tcp.Send(data);
         }
 ```
 
 ```csharp
- void Init()
+/// <summary>
+    /// The recommend is use TcpConnection 
+    /// </summary>
+    class Example3
+    {
+        TcpSocket tcp; //The recommend is use TcpConnection 
+        void Connect()
         {
-            var tcp = new TcpConnection(new PackageExample());
-            tcp.AddPlugin(new PingPlugin("ping", tcp));
-            //tcp.GetPlugin("ping");
+            tcp = new TcpSocket(1024);//set buffer size
+            tcp.OnReceiveBytes += OnReceive;
+            tcp.Connect("127.0.0.1", 999);
         }
+
+        void OnReceive(byte[] bytes)
+        {
+            //split bytes here
+        }
+    }
 ```
 
 

diff --git a/example/csharp/HiSocket.Example/HiSocket.Example.sln b/example/csharp/HiSocket.Example/HiSocket.Example.sln
diff --git a/example/csharp/HiSocket.Example/HiSocket.Example/BinaryMsg.cs b/example/csharp/HiSocket.Example/HiSocket.Example/BinaryMsg.cs
diff --git a/example/csharp/HiSocket.Example/HiSocket.Example/Package.cs b/example/csharp/HiSocket.Example/HiSocket.Example/Package.cs
diff --git a/example/csharp/HiSocket.Example/HiSocket.Example/Program.cs b/example/csharp/HiSocket.Example/HiSocket.Example/Program.cs