Kurlyk
Loading...
Searching...
No Matches
kurlyk.hpp File Reference

Main header file for the Kurlyk library, providing HTTP and WebSocket support. More...

#include "kurlyk/core.hpp"
#include "kurlyk/http.hpp"
#include "kurlyk/websocket.hpp"
#include "kurlyk/startup.hpp"

Go to the source code of this file.

Namespaces

namespace  kurlyk
 Primary namespace for the Kurlyk library, encompassing initialization, request management, and utility functions.
 

Macros

#define _KURLYK_HPP_INCLUDED
 
#define KURLYK_AUTO_INIT   1
 Enables automatic registration of managers during static initialization.
 
#define KURLYK_AUTO_INIT_USE_ASYNC   1
 Determines whether the NetworkWorker runs in a background thread during automatic initialization.
 
#define KURLYK_HTTP_SUPPORT   1
 Enables HTTP request support in the Kurlyk library.
 
#define KURLYK_WEBSOCKET_SUPPORT   1
 Enables WebSocket support in the Kurlyk library.
 
#define KURLYK_ENABLE_JSON   0
 Enables JSON serialization support for enums and types.
 
#define KURLYK_USE_CURL
 Enables the use of libcurl for HTTP support on non-Emscripten platforms.
 
#define KURLYK_USE_SIMPLEWEB
 Enables the use of Simple-WebSocket-Server for WebSocket support on non-Emscripten platforms.
 

Detailed Description

Main header file for the Kurlyk library, providing HTTP and WebSocket support.

Definition in file kurlyk.hpp.

Macro Definition Documentation

◆ _KURLYK_HPP_INCLUDED

#define _KURLYK_HPP_INCLUDED

Definition at line 3 of file kurlyk.hpp.

◆ KURLYK_AUTO_INIT

#define KURLYK_AUTO_INIT   1

Enables automatic registration of managers during static initialization.

Define to 0 before including kurlyk headers to disable automatic registration.

Definition at line 12 of file kurlyk.hpp.

◆ KURLYK_AUTO_INIT_USE_ASYNC

#define KURLYK_AUTO_INIT_USE_ASYNC   1

Determines whether the NetworkWorker runs in a background thread during automatic initialization.

Set to 1 to enable asynchronous execution, or 0 to require manual processing (synchronous mode). Ignored if KURLYK_AUTO_INIT is not enabled.

Definition at line 20 of file kurlyk.hpp.

◆ KURLYK_ENABLE_JSON

#define KURLYK_ENABLE_JSON   0

Enables JSON serialization support for enums and types.

Definition at line 40 of file kurlyk.hpp.

◆ KURLYK_HTTP_SUPPORT

#define KURLYK_HTTP_SUPPORT   1

Enables HTTP request support in the Kurlyk library.

Set to 1 to enable, or 0 to disable HTTP functionality.

Definition at line 27 of file kurlyk.hpp.

◆ KURLYK_USE_CURL

#define KURLYK_USE_CURL

Enables the use of libcurl for HTTP support on non-Emscripten platforms.

Definition at line 46 of file kurlyk.hpp.

◆ KURLYK_USE_SIMPLEWEB

#define KURLYK_USE_SIMPLEWEB

Enables the use of Simple-WebSocket-Server for WebSocket support on non-Emscripten platforms.

Definition at line 47 of file kurlyk.hpp.

◆ KURLYK_WEBSOCKET_SUPPORT

#define KURLYK_WEBSOCKET_SUPPORT   1

Enables WebSocket support in the Kurlyk library.

Set to 1 to enable, or 0 to disable WebSocket functionality.

Definition at line 34 of file kurlyk.hpp.