kuma is a multi-platform support network library developed in C++. It implements interfaces for TCP/UDP/Multicast/HTTP/HTTP2/WebSocket/timer that drove by event loop. kuma supports epoll/poll/WSAPoll/IOCP/kqueue/io_uring/select on platform Linux/Windows/OSX/iOS/Android.
- Support epoll, poll/WSAPoll, IOCP, kqueue, io_uring and select
- Portable/cross platform(linux, windows, macOS, iOS and Android)
- Support OpenSSL 1.0 and 1.1
- IPv6 support
- Flexible/Scalable timer manager
- Support HTTP compression gzip and deflate
- Support secure HTTP/2 and HTTP/1.1 upgrade to HTTP/2 (rfc7540, rfc7541)
- Support WebSocket(rfc6455) and extension permessage_deflate(rfc7692)
- Support WebSocket over HTTP/2(rfc8441)
- All interface objects, except Timer, are not thread-safe, must run on their EventLoop thread, but close method is thread-safe
git clone https://github.com/Jamol/kuma.git
git submodule update --init
define macro KUMA_HAS_OPENSSL to enable openssl
build dependency libkev firstly
python ./third_party/libkev/bld/your_os/build_your_os.py
open project bld/ios/kuma with xcode and build it
open project bld/mac/kuma with xcode and build it
open bld/windows/kuma.sln with VS2017 and build it
$ cd src
$ make
[deprecated]
$ cd src/jni
$ ndk-build
kuma .aar:
open android/kuam in Android Studio
or
python bld/android/build_android_aar.py
kuma .so:
python bld/android/build_android_so.py
demo:
open test/android/kmtest in Android Studio
CMake is also supported:
python ./bld/your_os/build_your_os.py --msvc vs2017/vs2019/vs2022
certificates location is by default in /path-to-your-excutable/cert.
copy all CA certificates used to cert/ca.pem
copy your server certificate to cert/server.pem
copy your server private key to cert/server.key
Please refer to test for more examples
#include "kmapi.h"
#include "libkev/src/utils/defer.h"
using namespace kuma;
int main(int argc, char *argv[])
{
kuma::init();
DEFER(kuma::fini());
EventLoop main_loop(PollType::NONE);
if (!main_loop.init()) {
printf("failed to init EventLoop\n");
return -1;
}
// WebSocket example
WebSocket ws(&main_loop, "HTTP/1.1");
// setup callbacks
ws.setOpenCallback([] (KMError err) {
printf("ws.onOpen, err=%d\n", err);
});
ws.setDataCallback([] (KMBuffer &data, bool is_text, bool is_fin) {
printf("ws.onData, len=%lu\n", data.chainLength());
});
ws.setWriteCallback([] (KMError err) {
printf("ws.onWrite, write available\n");
});
ws.setErrorCallback([] (KMError err) {
printf("ws.onError, err=%d\n", err);
});
ws.setSubprotocol("jws");
ws.setOrigin("www.jamol.cn");
ws.connect("wss://127.0.0.1:8443/");
// HTTP client example
HttpRequest http(&main_loop);
// setup callbacks
http.setDataCallback([] (KMBuffer &buf) {
printf("http.onData, len=%lu\n", buf.chainLength());
});
http.setWriteCallback([] (KMError err) {
printf("http.onWrite, write available\n");
});
http.setErrorCallback([] (KMError err) {
printf("http.onError, err=%d\n", err);
});
http.setHeaderCompleteCallback([&] {
printf("http.onHeader, status=%d\n", http.getStatusCode());
http.forEachHeader([] (const std::string &name, const std::string &value) {
printf("http.onHeader, name=%s, value=%s\n",
name.c_str(), value.c_str());
return true;
});
});
http.setResponseCompleteCallback([&] {
printf("http.onResponseComplete\n");
});
// send HTTP request
http.sendRequest("GET", "http://www.baidu.com");
Timer timer(&main_loop);
timer.schedule(1000, Timer::Mode::ONE_SHOT, [] {
printf("onTimer\n");
});
main_loop.loop();
return 0;
}
#include "kmapi.h"
#include "libkev/src/utils/defer.h"
using namespace kuma;
int main(int argc, char *argv[])
{
kuma::init();
DEFER(kuma::fini());
EventLoop main_loop(PollType::NONE);
if (!main_loop.init()) {
printf("failed to init EventLoop\n");
return -1;
}
WebSocket ws(&main_loop);
ws.setOpenCallback([] (KMError err) {
printf("ws.onOpen, err=%d\n", err);
});
ws.setDataCallback([] (KMBuffer &data, bool is_text, bool is_fin) {
printf("ws.onData, len=%lu\n", data.chainLength());
});
ws.setWriteCallback([] (KMError err) {
printf("ws.onWrite, write available\n");
});
ws.setErrorCallback([] (KMError err) {
printf("ws.onError, err=%d\n", err);
});
TcpListener server(&main_loop);
server.setAcceptCallback([&ws] (SOCKET_FD fd, const char* ip, uint16_t port) -> bool {
printf("server.onAccept, ip=%s\n", ip);
ws.setSslFlags(SSL_ENABLE);
ws.attachFd(fd, nullptr, [] (KMError err) {
printf("ws.onHandshake, err=%d\n", err);
return true;
});
return true;
});
server.setErrorCallback([] (KMError err) {
printf("server.onError, err=%d\n", err);
});
auto ret = server.startListen("0.0.0.0", 8443);
if (ret != KMError::NOERR) {
printf("failed to listen on 8443\n");
}
main_loop.loop();
return 0;
}