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: about 2 months 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 (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-03T17:47:08.000Z (2 months ago)
• Last Synced: 2024-11-03T18:19:41.383Z (2 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

        
## About

This repository implements WebSocket functionality based on RFC6455, providing both C and C++ APIs for seamless integration into diverse projects.

The library is designed to facilitate secure and unsecured WebSocket connections, utilizing [mbedTLS](https://tls.mbed.org/) for secure communication. 

## Features

- **C and C++ APIs**: Offers both C and C++ interfaces for flexibility and ease of integration.

- **Secure and Unsecured WebSocket Connections**: Supports secure WebSocket (WSS) using mbedTLS, as well as standard unsecured WebSocket (WS) connections.

- **CMake Build System**: Simplifies building and integrating the library with CMake.

## Supported Extensions

- **permessage-deflate**: Supports the permessage-deflate extension for message compression over WebSocket connections, enhancing efficiency and performance.

## Limitations

- **Sec-WebSocket-Protocol**: Not handled.

## Requirements

- C++11 or later

- CMake 3.0 or later

- **[optional]** Doxygen

## 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 ./../CMakeLists.txt

make

```

## Building documentation

```bash

doxygen ./DoxyFile

```