app.h

Go to the documentation of this file.

 
#ifndef CSILK_APP_H
#define CSILK_APP_H
 
#include "csilk/csilk.h"
 
typedef struct csilk_app_s csilk_app_t;
 
/* ---- Lifecycle ---- */
 
csilk_app_t* csilk_app_new(const char* config_path);
 
void csilk_app_free(csilk_app_t* app);
 
/* ---- Logger ---- */
 
void csilk_app_log_level(csilk_app_t* app, csilk_log_level_t level);
 
void csilk_app_log_file(csilk_app_t* app, const char* path, size_t max_sz);
 
void csilk_app_log_json(csilk_app_t* app, int enable);
 
/* ---- Middleware ---- */
 
void csilk_app_use(csilk_app_t* app, csilk_handler_t h);
 
void csilk_app_use_group(csilk_app_t* app, const char* prefix, csilk_handler_t h);
 
void csilk_app_apply_config(csilk_app_t* app);
 
/* ---- Routes ---- */
 
void csilk_app_add_route(csilk_app_t* app,
             const char* method,
             const char* path,
             csilk_handler_t handler);
 
void csilk_app_add_handlers(
    csilk_app_t* app, const char* method, const char* path, csilk_handler_t* handlers, size_t n);
 
void csilk_app_add_route_extended(csilk_app_t* app,
                  const char* method,
                  const char* path,
                  csilk_handler_t handler,
                  const char* input_type,
                  const char* output_type,
                  const char* summary,
                  const char* description);
 
void csilk_app_add_route_perm(csilk_app_t* app,
                  const char* method,
                  const char* path,
                  csilk_handler_t handler,
                  const char* perm_required,
                  const char* perm_resource);
 
void csilk_app_add_route_extended_perm(csilk_app_t* app,
                       const char* method,
                       const char* path,
                       csilk_handler_t handler,
                       const char* input_type,
                       const char* output_type,
                       const char* summary,
                       const char* description,
                       const char* perm_required,
                       const char* perm_resource);
 
#define csilk_app_get(app, path, handler) csilk_app_add_route(app, "GET", path, handler)
#define csilk_app_get_ext(app, path, handler, in, out, summary, desc)                              \
    csilk_app_add_route_extended(app, "GET", path, handler, in, out, summary, desc)
#define csilk_app_get_perm(app, path, handler, perm, res)                                          \
    csilk_app_add_route_perm(app, "GET", path, handler, perm, res)
#define csilk_app_post(app, path, handler) csilk_app_add_route(app, "POST", path, handler)
#define csilk_app_post_ext(app, path, handler, in, out, summary, desc)                             \
    csilk_app_add_route_extended(app, "POST", path, handler, in, out, summary, desc)
#define csilk_app_post_perm(app, path, handler, perm, res)                                         \
    csilk_app_add_route_perm(app, "POST", path, handler, perm, res)
#define csilk_app_put(app, path, handler) csilk_app_add_route(app, "PUT", path, handler)
#define csilk_app_put_ext(app, path, handler, in, out, summary, desc)                              \
    csilk_app_add_route_extended(app, "PUT", path, handler, in, out, summary, desc)
#define csilk_app_put_perm(app, path, handler, perm, res)                                          \
    csilk_app_add_route_perm(app, "PUT", path, handler, perm, res)
#define csilk_app_delete(app, path, handler) csilk_app_add_route(app, "DELETE", path, handler)
#define csilk_app_delete_ext(app, path, handler, in, out, summary, desc)                           \
    csilk_app_add_route_extended(app, "DELETE", path, handler, in, out, summary, desc)
#define csilk_app_delete_perm(app, path, handler, perm, res)                                       \
    csilk_app_add_route_perm(app, "DELETE", path, handler, perm, res)
#define csilk_app_patch(app, path, handler) csilk_app_add_route(app, "PATCH", path, handler)
#define csilk_app_patch_ext(app, path, handler, in, out, summary, desc)                            \
    csilk_app_add_route_extended(app, "PATCH", path, handler, in, out, summary, desc)
#define csilk_app_patch_perm(app, path, handler, perm, res)                                        \
    csilk_app_add_route_perm(app, "PATCH", path, handler, perm, res)
#define csilk_app_options(app, path, handler) csilk_app_add_route(app, "OPTIONS", path, handler)
#define csilk_app_options_ext(app, path, handler, in, out, summary, desc)                          \
    csilk_app_add_route_extended(app, "OPTIONS", path, handler, in, out, summary, desc)
#define csilk_app_options_perm(app, path, handler, perm, res)                                      \
    csilk_app_add_route_perm(app, "OPTIONS", path, handler, perm, res)
#define csilk_app_head(app, path, handler) csilk_app_add_route(app, "HEAD", path, handler)
#define csilk_app_head_ext(app, path, handler, in, out, summary, desc)                             \
    csilk_app_add_route_extended(app, "HEAD", path, handler, in, out, summary, desc)
#define csilk_app_head_perm(app, path, handler, perm, res)                                         \
    csilk_app_add_route_perm(app, "HEAD", path, handler, perm, res)
 
/* ---- Static Files ---- */
 
void csilk_app_static(csilk_app_t* app, const char* prefix, const char* root_dir);
 
/* ---- Configuration ---- */
 
void csilk_app_set_server_config(csilk_app_t* app, csilk_server_config_t c);
 
csilk_config_t* csilk_app_config(csilk_app_t* app);
 
/* ---- OpenAPI / Swagger ---- */
 
void csilk_app_enable_openapi(csilk_app_t* app, int enable);
 
/* ---- Run ---- */
 
int csilk_app_run(csilk_app_t* app, int port);
 
/* ---- Access underlying objects (advanced use) ---- */
 
csilk_router_t* csilk_app_router(csilk_app_t* app);
 
csilk_server_t* csilk_app_server(csilk_app_t* app);
 
#endif /* CSILK_APP_H */