https://github.com/mylifeismyhome/websocket
Websocket Library based on mbedtls
https://github.com/mylifeismyhome/websocket
c-api cmake cpp-api cpp11 doxygen-documentation example library mbedtls mit-license open-source secured shared-library ssl static-library tls unsecured websocket websocket-client websocket-server
Last synced: 7 days ago
JSON representation
Websocket Library based on mbedtls
- Host: GitHub
- URL: https://github.com/mylifeismyhome/websocket
- Owner: Mylifeismyhome
- License: mit
- Created: 2024-10-07T15:36:42.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-03T17:47:08.000Z (6 months ago)
- Last Synced: 2024-11-03T18:19:41.383Z (6 months ago)
- Topics: c-api, cmake, cpp-api, cpp11, doxygen-documentation, example, library, mbedtls, mit-license, open-source, secured, shared-library, ssl, static-library, tls, unsecured, websocket, websocket-client, websocket-server
- Language: C
- Homepage:
- Size: 1.21 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Websocket (RFC 6455 Implementation)
This repository provides a **RFC 6455–compliant WebSocket implementation** with both C and C++ APIs, enabling effortless integration into a wide range of applications. It supports both standard (`ws://`) and secure (`wss://`) connections, utilizing [mbedTLS](https://tls.mbed.org/) for encrypted communication.
## 📦 Features
- **C and C++ Interfaces**
Flexible APIs in both C and C++ to match your project's language needs.
- **WS and WSS Support**
Full support for WebSocket (WS) and secure WebSocket (WSS) connections, secured via mbedTLS.
- **CMake-Based Build System**
Easy configuration and compilation using CMake for seamless integration.
- **Doxygen Documentation**
Auto-generate API documentation with Doxygen for better clarity and onboarding.
## 🧩 Supported Extensions
- **permessage-deflate**
Adds support for compressed messages using the permessage-deflate WebSocket extension.
## ⚠️ Limitations
- **Sec-WebSocket-Protocol**
Currently not handled.
## ⚙️ Requirements
- C++11 or later
- CMake 3.0 or later
- **Optional**: Doxygen (for documentation)
## 🚀 Building from Source
```bash
git clone https://github.com/Mylifeismyhome/Websocket.git
cd Websocket
mkdir build
cd build
cmake -DCMAKE_CXX_FLAGS="-m64" \
-DENABLE_C_API=ON \
-DENABLE_CPP_API=ON \
-DBUILD_SHARED=ON \
-DBUILD_STATIC=ON \
-DEXAMPLE_C_API=ON \
../
make
```
This will build both static and shared libraries, along with optional examples if enabled.
## 📚 Building Documentation
To generate API documentation using Doxygen:
```bash
doxygen ./DoxyFile
```
> Make sure Doxygen is installed and available in your system's PATH.
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.