Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softmotions/iwnet
Pure C Asynchronous HTTP/IO framework with routing, websockets, SSL and reverse proxy.
https://github.com/softmotions/iwnet
c c-library c-programming cpp http http-proxy http-server http-server-library https ingress proxy reverse-proxy server ssl web web-framewok web-framework websocket websocket-server websockets
Last synced: 2 days ago
JSON representation
Pure C Asynchronous HTTP/IO framework with routing, websockets, SSL and reverse proxy.
- Host: GitHub
- URL: https://github.com/softmotions/iwnet
- Owner: Softmotions
- License: mit
- Created: 2021-08-12T04:49:21.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T10:14:26.000Z (13 days ago)
- Last Synced: 2025-01-13T02:06:22.978Z (9 days ago)
- Topics: c, c-library, c-programming, cpp, http, http-proxy, http-server, http-server-library, https, ingress, proxy, reverse-proxy, server, ssl, web, web-framewok, web-framework, websocket, websocket-server, websockets
- Language: C
- Homepage:
- Size: 2.04 MB
- Stars: 175
- Watchers: 9
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog
- License: LICENSE
Awesome Lists containing this project
README
# IWNET
**NOTE: Issues tracker is disabled. You are welcome to contribute, pull requests accepted.**
Pure `C` asynchronous HTTP framework providing websockets client/server, SSL, reverse proxy and routing.
Works on Linux, macOS, FreeBSD
* [Fast asynchronous HTTP server](./src/http) ([iwn_http_server.h](./src/http/iwn_http_server.h))
* [Web framework based on HTTP server](./src/http) ([iwn_wf.h](./src/http/iwn_wf.h))
* Ultra fast HTTP Reverse Proxy ([iwn_http_server.h](./src/http/iwn_http_server.h))
* Websocket client and server ([iwn_ws_server.h](./src/ws/iwn_ws_server.h), [iwn_ws_client.h](./src/ws/iwn_ws_client.h))
* Poller reactor ([iwn_poller.h](./src/poller/iwn_poller.h))
* SSL Layer is based on BearSSL ([iwn_brssl_poller_adapter.h](./src/ssl/iwn_brssl_poller_adapter.h))
* Manager of child processes ([iwn_proc.h](./src/poller/iwn_proc.h))
* Timer ([iwn_scheduler.h](./src/poller/iwn_scheduler.h))
* Inotify watcher wrapper [iwn_watcher](./src/poller/iwn_watcher.h)
## Build from sources
**Prerequisites**
* Linux, macOS or FreeBSD
* CMake 3.12 or greater
* gcc or clang compiler
* GNU Make or Ninja
**Building**
```sh
git clone https://github.com/Softmotions/iwnet.git
mkdir -p ./iwnet/build && cd ./iwnet/build
cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo -DBUILD_EXAMPLES=ON
make
```
## IWSTART
IWSTART is an automatic CMake initial project generator for C projects based on [iowow](https://github.com/Softmotions/iowow) / [iwnet](https://github.com/Softmotions/iwnet) / [ejdb2](https://github.com/Softmotions/ejdb) libs.
https://github.com/Softmotions/iwstart
# Used by
* [EJDB2 Embeddable JSON Database engine](https://github.com/Softmotions/ejdb)
* [Wirow Video Conferencing Platform](https://github.com/wirow-io/wirow-server)
## Asynchronous HTTP Framework
### Examples
#### Simple echo server
```sh
./echo_http_server --ssl
curl -k -XPUT -d'Hello' https://localhost:8080/echo
Hello
I'm an echo web server
```
echo_http_server.c
```c
#include "iwn_wf.h"
#include
#include
#include
#include
#include
static struct iwn_poller *poller;
static struct iwn_wf_ctx *ctx;
static void _on_signal(int signo) {
fprintf(stderr, "\nExiting...\n");
iwn_poller_shutdown_request(poller);
}
static int _handle_echo(struct iwn_wf_req *req, void *user_data) {
fprintf(stderr, "Echo handler called\n");
iwn_http_response_printf(req->http, 200, "text/plain", "%.*s\n%s\n",
(int) req->body_len, req->body, (char*) user_data);
return IWN_WF_RES_PROCESSED;
}
int main(int argc, char *argv[]) {
signal(SIGPIPE, SIG_IGN);
if ( signal(SIGTERM, _on_signal) == SIG_ERR
|| signal(SIGINT, _on_signal) == SIG_ERR) {
return EXIT_FAILURE;
}
iwrc rc = 0;
bool ssl = false;
int port = 8080;
for (int i = 1; i < argc; ++i) {
if (strcmp(argv[i], "--ssl") == 0) {
ssl = true;
} else if (strcmp(argv[i], "--port") == 0 && i + 1 < argc) {
port = iwatoi(argv[i + 1]);
}
}
RCC(rc, finish, iw_init()); // Init iowow runtime, logging, etc..
RCC(rc, finish, iwn_wf_create(0, &ctx)); // Create web server context
RCC(rc, finish, iwn_wf_route(&(struct iwn_wf_route) {
.ctx = ctx,
.pattern = "/echo",
.handler = _handle_echo,
.user_data = "I'm an echo web server",
.flags = IWN_WF_PUT | IWN_WF_POST
}, 0));
RCC(rc, finish, iwn_poller_create(0, 0, &poller));
struct iwn_wf_server_spec spec = {
.listen = "localhost",
.port = port,
.poller = poller,
};
if (ssl) {
spec.ssl.private_key = "./server-eckey.pem";
spec.ssl.private_key_len = -1;
spec.ssl.certs = "./server-ecdsacert.pem";
spec.ssl.certs_len = -1;
}
// Print out a routes configuration.
iwn_wf_route_print(ctx->root, stderr);
// Configure HTTP server.
RCC(rc, finish, iwn_wf_server(&spec, ctx));
fprintf(stderr,
"\nOpen terminal and run:\n\tcurl -k -XPUT -d'Hello' %s://%s:%d\n",
(ssl ? "https" : "http"),
spec.listen,
spec.port);
// Start fds poller reactor.
iwn_poller_poll(poller);
finish:
iwn_poller_destroy(&poller);
if (rc) {
iwlog_ecode_error3(rc);
return EXIT_FAILURE;
} else {
return EXIT_SUCCESS;
}
}
```
#### Todo list REST API server
[todolist_http_server.c](https://github.com/Softmotions/iwnet/tree/master/src/http/examples/todolist_http_server.c)
```sh
./todolist_http_server --ssl
0001 [root:*]
0002 [/todo> ALL
0003 {create:/([a-zA-z]+[a-z0-9A-Z]*)] PUT
0004 {get:/([0-9]+)] GET
0005 {remove:/([0-9]+)] DELETE
0006 [list:*] GET
0007 [done:*] POST
Create a new 'Hello' todo entry:
curl -k -XPUT -d'Say Hello' https://localhost:8080/todo/Hello
curl -k -XPUT -d'Say Hello' https://localhost:8080/todo/Hello?done=1
List all todo list items:
curl -k https://localhost:8080/todo
Get task #1 details:
curl -k https://localhost:8080/todo/1
Remove task #2 from todo list:
curl -k -XDELETE https://localhost:8080/todo/2
Update done status of task #2:
curl -k -XPOST -d'id=2&done=1' https://localhost:8080/todo
```
#### More examples
[Real life large project - Wirow video-conferencing server](https://github.com/wirow-io/wirow-server)
You may find many helpful code examples by looking into
[framework test code](https://github.com/Softmotions/iwnet/tree/master/src/http/tests)
* [server2.c](https://github.com/Softmotions/iwnet/tree/master/src/http/tests/server2.c)
* [server1.c](https://github.com/Softmotions/iwnet/tree/master/src/http/tests/server1.c)
* [HTTP Proxy: proxy1.c](https://github.com/Softmotions/iwnet/tree/master/src/http/tests/proxy1.c)
# License
```
MIT License
Copyright (c) 2012-2024 Softmotions Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```