Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nauja/libws
Wrapper over libwebsockets for easy ws
https://github.com/nauja/libws
c cmake library lightweight network portable websockets
Last synced: about 1 month ago
JSON representation
Wrapper over libwebsockets for easy ws
- Host: GitHub
- URL: https://github.com/nauja/libws
- Owner: Nauja
- License: mit
- Created: 2023-01-12T14:09:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T16:41:07.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T23:01:15.095Z (about 1 month ago)
- Topics: c, cmake, library, lightweight, network, portable, websockets
- Language: C
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# libws
[](https://github.com/Nauja/libws/actions/workflows/CI.yml)
[](https://github.com/Nauja/libws/actions/workflows/CI_docs.yml)
[](https://libws.readthedocs.io/en/latest/?badge=latest)
[](https://raw.githubusercontent.com/Nauja/libws/master/LICENSE)
Wrapper over [libwebsockets](https://libwebsockets.org/) for websockets.
## Why
libwebsockets is a popular library with a generic interface for http/1, http/2, websockets, MQTT,
and while it's great to have a generic interface, it also makes it more complicated to get started
if you only want to use it for websockets. So, this library aims to provide a simpler interface
over libwebsockets to remove some of the boilerplate required to create a websockets server or
client.
## Examples
WIP
## Build Manually
Copy the files [ws.c](https://github.com/Nauja/libws/blob/main/ws.c) and [ws.h](https://github.com/Nauja/libws/blob/main/ws.h) into an existing project.
Comment or uncomment the defines at the top of `ws.h` depending on your configuration:
```c
/* Define to 1 if you have the header file. */
#ifndef HAVE_STDIO_H
#define HAVE_STDIO_H 1
#endif
/* Define to 1 if you have the header file. */
#ifndef HAVE_STDLIB_H
#define HAVE_STDLIB_H 1
#endif
/* Define to 1 if you have the header file. */
#ifndef HAVE_SYS_STAT_H
#define HAVE_SYS_STAT_H 1
#endif
...
```
You should now be able to compile this library correctly.
## Build with CMake
Tested with CMake >= 3.13.4:
```
git clone https://github.com/Nauja/libws.git
cd libws
git submodule init
git submodule update
mkdir build
cd build
cmake ..
```
CMake will correctly configure the defines at the top of [ws.h](https://github.com/Nauja/libws/blob/main/ws.h) for your system.
You can then build this library manually as described above, or by using:
```
make
```
This will generate `libws.a` if building as a static library and `liblibws.so` in the `build` directory.
You can change the build process with a list of different options that you can pass to CMake. Turn them on with `On` and off with `Off`:
* `-DLIBWS_STATIC=On`: Enable building as static library. (on by default)
* `-DLIBWS_UNIT_TESTING=On`: Enable building the tests. (on by default)
* `-DLIBWS_DOXYGEN=On`: Enable building the docs. (off by default)
## Build with Visual Studio
Generate the Visual Studio solution with:
```
mkdir build
cd build
cmake .. -G "Visual Studio 16 2019"
```
You can now open `build/libws.sln` and compile the library.
## License
Licensed under the [MIT](https://github.com/Nauja/libws/blob/main/LICENSE) License.