net_httpd.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_NET_HTTPD_H
#define OVE_NET_HTTPD_H
 
#include "ove/types.h"
#include "ove/net.h"
#include "ove_config.h"
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_OVE_NET_HTTPD
 
#define OVE_HTTPD_MAX_ROUTES 16
 
#define OVE_HTTPD_MAX_SEGMENTS 8
 
typedef struct ove_httpd_req ove_httpd_req_t;
 
typedef struct ove_httpd_resp ove_httpd_resp_t;
 
typedef int (*ove_httpd_handler_t)(ove_httpd_req_t *req, ove_httpd_resp_t *resp);
 
typedef struct {
    uint16_t port;     
    int max_body_size; 
} ove_httpd_config_t;
 
int ove_httpd_start(const ove_httpd_config_t *cfg);
 
void ove_httpd_stop(void);
 
int ove_httpd_route(const char *method, const char *path, ove_httpd_handler_t handler);
 
void ove_httpd_register_builtin_routes(void);
 
void ove_httpd_set_netif(ove_netif_t netif);
 
/* ── Optional module hooks ──────────────────────────────────── */
 
#ifdef CONFIG_OVE_AUDIO
struct ove_audio_graph;
void ove_httpd_set_audio_graph(struct ove_audio_graph *g);
#endif
 
#ifdef CONFIG_OVE_INFER
void ove_httpd_set_model(ove_model_t model);
#endif
 
/* ── Request accessors ───────────────────────────────────────── */
 
const char *ove_httpd_req_method(ove_httpd_req_t *req);
 
const char *ove_httpd_req_path(ove_httpd_req_t *req);
 
const char *ove_httpd_req_query(ove_httpd_req_t *req);
 
const char *ove_httpd_req_body(ove_httpd_req_t *req);
 
size_t ove_httpd_req_body_len(ove_httpd_req_t *req);
 
const char *ove_httpd_req_segment(ove_httpd_req_t *req, int idx);
 
/* ── Response helpers ────────────────────────────────────────── */
 
int ove_httpd_resp_json(ove_httpd_resp_t *resp, int status, const char *json);
 
int ove_httpd_resp_html(ove_httpd_resp_t *resp, int status, const char *html, size_t len);
 
int ove_httpd_resp_send(ove_httpd_resp_t *resp, int status, const char *content_type,
            const void *body, size_t len);
 
int ove_httpd_resp_send_gz(ove_httpd_resp_t *resp, int status, const char *content_type,
               const void *body, size_t len);
 
int ove_httpd_resp_error(ove_httpd_resp_t *resp, int status, const char *message);
 
/* ── WebSocket support ──────────────────────────────────────── */
 
#ifdef CONFIG_OVE_NET_HTTPD_WS
 
typedef struct ove_httpd_ws_conn ove_httpd_ws_conn_t;
 
typedef void (*ove_httpd_ws_handler_t)(ove_httpd_ws_conn_t *conn, const void *data, size_t len);
 
typedef void (*ove_httpd_ws_close_handler_t)(ove_httpd_ws_conn_t *conn);
 
int ove_httpd_ws_route(const char *path, ove_httpd_ws_handler_t on_message,
               ove_httpd_ws_close_handler_t on_close);
 
int ove_httpd_ws_send(ove_httpd_ws_conn_t *conn, const void *data, size_t len);
 
int ove_httpd_ws_broadcast(const char *path, const void *data, size_t len);
 
int ove_httpd_ws_active_count(void);
 
/* ── Internal — called by httpd accept loop ──────────────────────────── */
 
int ove_httpd_ws_is_upgrade(const char *headers);
 
int ove_httpd_ws_handshake(const char *headers, size_t headers_len, const char *path,
               ove_socket_t sock, ove_socket_storage_t *storage);
 
void ove_httpd_ws_poll(void);
 
#endif /* CONFIG_OVE_NET_HTTPD_WS */
 
/* ── Log hook ────────────────────────────────────────────────── */
 
void ove_httpd_log_append(const char *line);
 
#else /* !CONFIG_OVE_NET_HTTPD */
 
static inline int ove_httpd_start(const void *cfg)
{
    (void)cfg;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_httpd_stop(void)
{
}
static inline void ove_httpd_register_builtin_routes(void)
{
}
static inline void ove_httpd_log_append(const char *line)
{
    (void)line;
}
#endif /* CONFIG_OVE_NET_HTTPD */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_NET_HTTPD_H */