README.md

knet

中文版

A cross platform lock-free and timer-supported C++11 network library.

Table of Contents

• knet
  • Table of Contents
  • Highlights
  • Environment
  • How To Use
    • vcpkg
    • Build from source
  • Core Concept
  • Examples
    • Echo Server and Client
      • Protocol
      • Echo Server
      • Echo Client
  • License

---

Highlights

• Support Windows, Linux, MacOS, FreeBSD
• Support Synchronous and Asynchronous processing connections
• Support network package defragment
• Less code and no third party dependency
• Lockfree, connection work on same fixed thread
• Timer support, such as: hearbeat check etc.

Environment

• CMake 3.15 or higher
• Clang 3.8 or higher (If you build with Clang)
• Visual Studio 2015 or higher(Windows)
• G++ 5 or higher(Linux)
• Xcode 9.4 or higher(MacOS)

How To Use

vcpkg

vcpkg install knet

Build from source

# clone source code
git clone https://github.com/KibaAmor/knet.git # or https://gitee.com/kibaamor/knet.git

# enter source code root directory
cd knet

# generate project
cmake . -B build

# build Release
cmake --build build --config Release

# run tests
(cd build && ctest --output-on-failure)

# install
(cd build && sudo make install)

Core Concept

the core concept of knet is: produce socket-consume socket.

In fact, both connecting to server and accepting connection from client are creating readable and writable socket. After the socket is created, both the client and the server do the same to send and accept messages. This process can then be seen as a process of generating sockets and consuming sockets. Here's the diagram:

   producer                       consumer
┌───────────┐                  ┌──────────────┐
│ connector │    ——————————>   │    worker    │
│           │      socket      │              │
│ acceptor  │    ——————————>   │ async_worker │
└───────────┘                  └──────────────┘

• connector connect to server
• acceptor accept connection from client
• worker synchronous processing connections
• async_worker asynchronous processing connections

Examples

Echo Server and Client

example provides echo server and echo client.

Protocol

┌────────────────────┬──────┐
│ data size(4 bytes) │ data │
└───-────────────────┴──────┘

4 bytes package header and data follow.

Echo Server

The echo server sends the received data back to the client intact.

A timer is also set to check whether a client message is received within the specified time, and the connection to the client is closed if the client message is not received within the specified time.

The server provides two types:

• Synchronous Echo Serverexamples/server/sync_server.cpp
• Asynchronous Echo Serverexamples/server/async_server.cpp

Echo Client

The client actively connects to the server after starting (and automatically reconnects the server if the connection is not available), and when the connection is successful, it actively sends an incomplete network package to the server.

When the network package returned by the server is received, the data envelope is verified and disconnected if it fails.

The client provides two types:

• Synchronous Echo Clientexamples/client/sync_client.cpp
• Asynchronous Echo Clientexamples/client/async_client.cpp

License