https://github.com/jwsung91/unilink
Unified, cross-platform async C++ library for Serial, TCP, UDP, and UDS
https://github.com/jwsung91/unilink
async communication cpp cross-platform serial tcp udp uds
Last synced: 13 days ago
JSON representation
Unified, cross-platform async C++ library for Serial, TCP, UDP, and UDS
- Host: GitHub
- URL: https://github.com/jwsung91/unilink
- Owner: jwsung91
- License: apache-2.0
- Created: 2025-09-12T12:38:12.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-05-14T13:43:44.000Z (2 months ago)
- Last Synced: 2026-05-14T15:28:05.964Z (2 months ago)
- Topics: async, communication, cpp, cross-platform, serial, tcp, udp, uds
- Language: C++
- Homepage: https://jwsung91.github.io/unilink
- Size: 181 MB
- Stars: 0
- Watchers: 0
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# unilink
**Unified async communication for modern C++20.**
Serial · TCP · UDP · UDS
[](https://jwsung91.github.io/unilink/coverage/)
## Description
Simple async C++ communication library for Serial, TCP, UDP, and Unix Domain Sockets
`unilink` provides a unified interface for asynchronous communication across different transports, allowing applications to switch between Serial, TCP, UDP, and UDS with minimal code changes. The public C++ API exposes builders and wrappers for all four transport families.
The project prioritizes **API clarity, predictable runtime behavior, and stability** over rapid feature expansion.
## Feature Highlights
* **Unified transport surface**: Consistent builders and wrappers for TCP client/server, UDP, Serial, and UDS.
* **Callback-scoped data views**: Avoid unnecessary copies during callbacks, with explicit ownership-copy helpers for stored data.
* **Fluent API with CRTP Builders**: Type-safe configuration with improved method chaining.
* **Tested runtime behavior**: Unit, integration, and end-to-end test suites are part of the repository and documented in `test/`.
## Requirements
* **C++20 compiler and standard library**: GCC 10+, recent Clang/libc++, or MSVC 2022 (required)
* CMake 3.12 or later for plain builds; CMake 3.21 or later for the repository presets
* Boost 1.83.0 or later. vcpkg is the recommended dependency supplier; OS package manager Boost versions are supported only when they meet this minimum.
## 📦 Installation
### vcpkg (recommended)
```bash
vcpkg install jwsung91-unilink
```
For CMake usage, source builds, and other installation options, see the
documentation repository:
https://github.com/unilink-lab/unilink-docs
Container images are maintained separately in [unilink-lab/unilink-containers](https://github.com/unilink-lab/unilink-containers).
### Contributor Development Setup
```bash
./scripts/setup_dev_env.sh
cmake --preset dev-linux-x64
cmake --build --preset dev-linux-x64
```
The setup script installs Boost and spdlog through an untracked, repository-local `vcpkg/` checkout by default. Delete that directory any time to reclaim space; rerun the setup script to recreate it. Set `VCPKG_ROOT` before running the script if you want to reuse an external vcpkg checkout.
CMake remains the version gate and rejects Boost versions older than 1.83.0.
The preset-based contributor workflow uses `CMakePresets.json` schema version 3, so those `cmake --preset ...` commands require CMake 3.21+.
## 📚 Documentation
Full documentation is maintained in the unilink documentation repository:
https://github.com/unilink-lab/unilink-docs
Core repository entrypoints:
- [Quick Start](https://github.com/jwsung91/unilink/blob/main/docs/quickstart.md)
- [Installation](https://github.com/jwsung91/unilink/blob/main/docs/installation.md)
- [API Stability Summary](https://github.com/jwsung91/unilink/blob/main/docs/api_stability.md)
- [Error Model](https://github.com/jwsung91/unilink/blob/main/docs/error_model.md)
- [Callback Data Lifetime](https://github.com/jwsung91/unilink/blob/main/docs/callbacks.md)
- [Performance Validation](https://github.com/jwsung91/unilink/blob/main/docs/performance_validation.md)
- [Release Checklist](https://github.com/jwsung91/unilink/blob/main/docs/release_checklist.md)
Useful external repositories:
* [Python bindings](https://github.com/unilink-lab/unilink-python)
* [Examples](https://github.com/unilink-lab/unilink-examples)
---
## 📄 License
**unilink** is released under the Apache License, Version 2.0.
Commercial use, modification, and redistribution are permitted.
For details, see the [LICENSE](./LICENSE) and [NOTICE](./NOTICE) files.
Copyright © 2025 Jinwoo Sung