Flecs v4.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
rest.h
Go to the documentation of this file.
1
11#ifdef FLECS_REST
12
21/* Used for the HTTP server */
22#ifndef FLECS_HTTP
23#define FLECS_HTTP
24#endif
25
26/* Used for building the JSON replies */
27#ifndef FLECS_JSON
28#define FLECS_JSON
29#endif
30
31/* For the REST system */
32#ifndef FLECS_PIPELINE
33#define FLECS_PIPELINE
34#endif
35
36#ifndef FLECS_REST_H
37#define FLECS_REST_H
38
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43#define ECS_REST_DEFAULT_PORT (27750)
44
46FLECS_API extern const ecs_entity_t ecs_id(EcsRest);
47
49typedef struct {
50 ecs_world_t *world;
51 ecs_http_server_t *srv;
52 int32_t rc;
53 ecs_map_t cmd_captures;
54 double last_time;
55} ecs_rest_ctx_t;
56
58typedef struct {
59 uint16_t port;
60 char *ipaddr;
61 ecs_rest_ctx_t *impl;
62} EcsRest;
63
72FLECS_API
73ecs_http_server_t* ecs_rest_server_init(
74 ecs_world_t *world,
75 const ecs_http_server_desc_t *desc);
76
80FLECS_API
81void ecs_rest_server_fini(
82 ecs_http_server_t *srv);
83
92FLECS_API
93void FlecsRestImport(
94 ecs_world_t *world);
95
96#ifdef __cplusplus
97}
98#endif
99
100#endif
101
104#endif
ecs_http_server_t
struct ecs_http_server_t ecs_http_server_t
HTTP server.
Definition http.h:48
ecs_rest_server_init
FLECS_API ecs_http_server_t * ecs_rest_server_init(ecs_world_t *world, const ecs_http_server_desc_t *desc)
Create HTTP server for REST API.
ecs_id
FLECS_API const ecs_entity_t ecs_id(EcsRest)
Component that instantiates the REST API.
ecs_rest_server_fini
FLECS_API void ecs_rest_server_fini(ecs_http_server_t *srv)
Cleanup REST HTTP server.
FlecsRestImport
FLECS_API void FlecsRestImport(ecs_world_t *world)
Rest module import function.
ecs_entity_t
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:361
ecs_world_t
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:405
EcsRest
Component that creates a REST API server when instantiated.
Definition rest.h:58
EcsRest::port
uint16_t port
Port of server (optional, default = 27750)
Definition rest.h:59
EcsRest::ipaddr
char * ipaddr
Interface address (optional, default = 0.0.0.0)
Definition rest.h:60
ecs_http_server_desc_t
Used with ecs_http_server_init().
Definition http.h:123
ecs_rest_ctx_t
Private REST data.
Definition rest.h:49