HiSocket 2.7.3

HiSocket

It is a lightweight socket solution, you can used it in Unity3d or C# project

中文说明

How to use

You can choose use NuGet package, dll or source code, add it to your project.(The easiest way how to use HiSocket is via the HiSocket NuGet package)

• NuGet: HiSocket NuGet package
• Dll: HiSocket_xx.zip
• Source code: Source code

Quick Start:

        //tcp example
        private IPackage package = new PackageExample();
        private TcpConnection tcp;
        void Init()
        {
            tcp = new TcpConnection(package);
            tcp.OnConnected += OnConnected;
            tcp.OnReceive += OnReceive;
            //...
            //...
            tcp.Connect("127.0.0.1",999);
        }
        void OnConnected()
        {
            //connect success
            tcp.Send(new byte[10]);//send message
        }

        void OnReceive(byte[] bytes)
        {
            //get message from server
        }

More example:

• C# project example:Example
• Unity project example:Example

General

This project contains:

• Connection
  • TcpConnection
    • TcpSocket
    • Package
  • UdpConnection
    • UdpSocket
  • Plugin
• Message
  • Message register
  • Aes encryption
  • Byte message
  • Protobuf message

Features

• Support Tcp socket
• Support Udp socket
• Scalable byte Array
• High-performance byte block buffer
• Message registration and call back
• Support byte message
• Support protobuf message
• AES encryption

Details

• Tcp and Udp are all use async connection in main thread(avoid thread blocking).
• High-performance buffer avoid memory allocation every time, and reduce garbage collection.
• You can get current connect state and message by adding listener of event.
• If you use Tcp socket, you should implement IPackage interface to pack or unpack message.
• If you use Udp socket, you should declaring buffer size.
• Ping: there is a ping plugin you can used, but if you are used in unity3d because of the bug of mono, it will throw an error on .net2.0(.net 4.6 will be fine, also you can use unity's api to get ping time)

Advanced

• If you are clear about socket, you also can use TcpSocket(UdpSocket) to achieve your logic, anyway the recommend is TcpConnection(UdpConnection).
• You can use API get socket and do extra logic, for example modify time out time
• You can use API get send and receive buffer, for example when disconnect should send all send buffer's data to server? or when reconnect how to process send buffer's data
• 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.
• There are a message register base class help user to quick register id and callback(based on reflection)
• Byte block buffer reuse block when some block is free.
• .etc