https://github.com/kibaamor/knet
A cross platform lock-free and timer-supported C++11 network library.一个跨平台的无锁且支持定时器的C++11网络库。
https://github.com/kibaamor/knet
clang concept echo echo-client echo-server epoll freebsd heartbeat highlights iocp knet kqueue linux macos network openbsd quality timer-support windows
Last synced: about 1 month ago
JSON representation
A cross platform lock-free and timer-supported C++11 network library.一个跨平台的无锁且支持定时器的C++11网络库。
- Host: GitHub
- URL: https://github.com/kibaamor/knet
- Owner: kibaamor
- License: mit
- Created: 2020-02-22T03:13:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-10T09:32:14.000Z (over 4 years ago)
- Last Synced: 2023-08-08T20:01:48.673Z (over 2 years ago)
- Topics: clang, concept, echo, echo-client, echo-server, epoll, freebsd, heartbeat, highlights, iocp, knet, kqueue, linux, macos, network, openbsd, quality, timer-support, windows
- Language: C++
- Homepage:
- Size: 575 KB
- Stars: 28
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# **knet**
[中文版](./README_zh.md)
A cross platform lock-free and timer-supported C++11 network library.
[](https://ci.appveyor.com/project/KibaAmor/knet)
[](./LICENSE)
[](https://github.com/kibaamor/knet)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FKibaAmor%2Fknet?ref=badge_shield)
## Table of Contents
- [**knet**](#knet)
- [Table of Contents](#table-of-contents)
- [Highlights](#highlights)
- [Environment](#environment)
- [How To Use](#how-to-use)
- [vcpkg](#vcpkg)
- [Build from source](#build-from-source)
- [Core Concept](#core-concept)
- [Examples](#examples)
- [Echo Server and Client](#echo-server-and-client)
- [Protocol](#protocol)
- [Echo Server](#echo-server)
- [Echo Client](#echo-client)
- [License](#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](http://clang.llvm.org/cxx_status.html) or higher (If you build with Clang)
- Visual Studio 2015 or higher(Windows)
- [G++ 5](https://gcc.gnu.org/gcc-5/changes.html#libstdcxx) or higher(Linux)
- [Xcode 9.4](https://stackoverflow.com/questions/28094794/why-does-apple-clang-disallow-c11-thread-local-when-official-clang-supports) or higher(MacOS)
## How To Use
### [vcpkg](https://github.com/microsoft/vcpkg)
```bash
vcpkg install knet
```
### Build from source
```bash
# 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:
```text
producer consumer
┌───────────┐ ┌──────────────┐
│ connector │ ——————————> │ worker │
│ │ socket │ │
│ acceptor │ ——————————> │ async_worker │
└───────────┘ └──────────────┘
```
- [connector](./src/kconnector.cpp) connect to server
- [acceptor](./src/kacceptor.cpp) accept connection from client
- [worker](./src/kworker.cpp) synchronous processing connections
- [async_worker](./src/kworker.cpp) asynchronous processing connections
## Examples
### Echo Server and Client
[example](./examples/) provides [echo server](./examples/server) and [echo client](./examples/client).
#### Protocol
```txt
┌────────────────────┬──────┐
│ 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 Server[examples/server/sync_server.cpp](./examples/server/sync_server.cpp)
- Asynchronous Echo Server[examples/server/async_server.cpp](./examples/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 Client[examples/client/sync_client.cpp](./examples/client/sync_client.cpp)
- Asynchronous Echo Client[examples/client/async_client.cpp](./examples/client/async_client.cpp)
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2FKibaAmor%2Fknet?ref=badge_large)