Ulfius: include/ulfius.h Source File

Ulfius HTTP Framework for REST Applications in C

ulfius.h
Go to the documentation of this file.
1
27 #ifndef __ULFIUS_H__
28 #define __ULFIUS_H__
29
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34
35 #include "ulfius-cfg.h"
36
39 #ifndef U_DISABLE_GNUTLS
40 #ifndef _GNU_SOURCE
41 #define _GNU_SOURCE
42 #endif
43 #include <gnutls/gnutls.h>
44 #include <gnutls/x509.h>
45 #endif
46
47 #ifndef U_DISABLE_WEBSOCKET
48 #include <poll.h>
49 #include <zlib.h>
50 #ifndef POLLRDHUP
51 #define POLLRDHUP 0x2000
52 #endif
53 #endif
54
55 #include <pthread.h>
56 #include <microhttpd.h>
57
58 #if defined(_WIN32) && !defined(U_DISABLE_WEBSOCKET)
59 #define U_DISABLE_WEBSOCKET
60 #endif
61
62 #if (MHD_VERSION < 0x00095300) && !defined(U_DISABLE_WEBSOCKET)
63 #define U_DISABLE_WEBSOCKET
64 #endif
65
67 #include <orcania.h>
68
70 #ifndef U_DISABLE_YDER
71 #include <yder.h>
72 #else
73
74 #define Y_LOG_MODE_NONE 0
75 #define Y_LOG_MODE_CONSOLE 0
76 #define Y_LOG_MODE_SYSLOG 0
77 #define Y_LOG_MODE_FILE 0
78 #define Y_LOG_MODE_JOURNALD 0
79 #define Y_LOG_MODE_CALLBACK 0
80 #define Y_LOG_MODE_CURRENT 0
81
82 #define Y_LOG_LEVEL_NONE 0
83 #define Y_LOG_LEVEL_DEBUG 0
84 #define Y_LOG_LEVEL_INFO 0
85 #define Y_LOG_LEVEL_WARNING 0
86 #define Y_LOG_LEVEL_ERROR 0
87 #define Y_LOG_LEVEL_CURRENT 0
88
89 int y_init_logs(const char * app, const unsigned long init_mode, const unsigned long init_level, const char * init_log_file, const char * message);
90 int y_set_logs_callback(void (* y_callback_log_message) (void * cls, const char * app_name, const time_t date, const unsigned long level, const char * message), void * cls, const char * message);
91 void y_log_message(const unsigned long type, const char * message, ...);
92 int y_close_logs();
93 #endif
94
95 #ifndef U_DISABLE_JANSSON
96 #include <jansson.h>
97 #endif
98
104 #define ULFIUS_STREAM_BLOCK_SIZE_DEFAULT 1024
105 #define U_STREAM_END MHD_CONTENT_READER_END_OF_STREAM
106 #define U_STREAM_ERROR MHD_CONTENT_READER_END_WITH_ERROR
107 #define U_STREAM_SIZE_UNKNOWN MHD_SIZE_UNKNOWN
108 #define U_STREAM_SIZE_UNKOWN U_STREAM_SIZE_UNKNOWN // Backward compatibility
109
110 #define U_OK 0
111 #define U_ERROR 1
112 #define U_ERROR_MEMORY 2
113 #define U_ERROR_PARAMS 3
114 #define U_ERROR_LIBMHD 4
115 #define U_ERROR_LIBCURL 5
116 #define U_ERROR_NOT_FOUND 6
117 #define U_ERROR_DISCONNECTED 7
118
119 #define U_CALLBACK_CONTINUE 0
120 #define U_CALLBACK_IGNORE 1
121 #define U_CALLBACK_COMPLETE 2
122 #define U_CALLBACK_UNAUTHORIZED 3
123 #define U_CALLBACK_ERROR 4
124
125 #define U_COOKIE_SAME_SITE_NONE 0
126 #define U_COOKIE_SAME_SITE_STRICT 1
127 #define U_COOKIE_SAME_SITE_LAX 2
128
129 #define U_USE_IPV4 0x0001
130 #define U_USE_IPV6 0x0010
131 #define U_USE_ALL (U_USE_IPV4|U_USE_IPV6)
132
133 #define U_SSL_VERIFY_PEER 0x0001
134 #define U_SSL_VERIFY_HOSTNAME 0x0010
135
140 typedef enum {
141 U_OPT_NONE = 0,
142 U_OPT_HTTP_VERB = 1,
143 U_OPT_HTTP_URL = 2,
144 U_OPT_HTTP_PROXY = 3,
145 #if MHD_VERSION >= 0x00095208
146 U_OPT_NETWORK_TYPE = 4,
147 #endif
148 U_OPT_CHECK_SERVER_CERTIFICATE = 5,
149 U_OPT_CHECK_SERVER_CERTIFICATE_FLAG = 6,
150 U_OPT_CHECK_PROXY_CERTIFICATE = 7,
151 U_OPT_CHECK_PROXY_CERTIFICATE_FLAG = 8,
152 U_OPT_FOLLOW_REDIRECT = 9,
153 U_OPT_CA_PATH = 10,
154 U_OPT_TIMEOUT = 11,
155 U_OPT_AUTH_BASIC_USER = 12,
156 U_OPT_AUTH_BASIC_PASSWORD = 13,
157 U_OPT_URL_PARAMETER = 14,
158 U_OPT_HEADER_PARAMETER = 15,
159 U_OPT_COOKIE_PARAMETER = 16,
160 U_OPT_POST_BODY_PARAMETER = 17,
161 U_OPT_URL_PARAMETER_REMOVE = 18,
162 U_OPT_HEADER_PARAMETER_REMOVE = 19,
163 U_OPT_COOKIE_PARAMETER_REMOVE = 20,
164 U_OPT_POST_BODY_PARAMETER_REMOVE = 21,
165 U_OPT_BINARY_BODY = 22,
166 U_OPT_STRING_BODY = 23,
167 #ifndef U_DISABLE_JANSSON
168 U_OPT_JSON_BODY = 24,
169 #endif
170 #ifndef U_DISABLE_GNUTLS
171 U_OPT_CLIENT_CERT_FILE = 25,
172 U_OPT_CLIENT_KEY_FILE = 26,
173 U_OPT_CLIENT_KEY_PASSWORD = 27,
174 #endif
175 U_OPT_STATUS = 28,
176 U_OPT_AUTH_REALM = 29,
177 U_OPT_SHARED_DATA = 30,
178 U_OPT_HTTP_URL_APPEND = 31
179 } u_option;
180
185 /*************
186 * Structures
187 *************/
188
198 struct _u_map {
199 int nb_values; /* !< Values count */
200 char ** keys; /* !< Array of keys */
201 char ** values; /* !< Array of values */
202 size_t * lengths; /* !< Lengths of each values */
203 };
204
209 struct _u_cookie {
210 char * key; /* !< key if the cookie */
211 char * value; /* !< value of the cookie */
212 char * expires; /* !< expiration date of the cookie */
213 unsigned int max_age; /* !< duration of the cookie in seconds */
214 char * domain; /* !< domain for the cookie */
215 char * path; /* !< url path for the cookie */
216 int secure; /* !< flag to set cookie secure or not */
217 int http_only; /* !< flag to set cookie for HTTP connections only or not */
218 int same_site; /* !< flag to set same_site option to the cookie */
219 };
220
227 struct _u_request {
228 char * http_protocol; /* !< http protocol used (1.0 or 1.1) */
229 char * http_verb; /* !< http method (GET, POST, PUT, DELETE, etc.) */
230 char * http_url; /* !< full url used to call this callback function or full url to call when used in a ulfius_send_http_request */
231 char * url_path; /* !< url path only used to call this callback function (ex, if http_url is /path/?param=1, url_path is /path/) */
232 char * proxy; /* !<proxy address to use for outgoing connections, used by ulfius_send_http_request */
233 #if MHD_VERSION >= 0x00095208
234 unsigned short network_type; /* !< Force connect to ipv4, ipv6 addresses or both, values available are U_USE_ALL, U_USE_IPV4 or U_USE_IPV6 */
235 #endif
236 int check_server_certificate; /* !< check server certificate and hostname, default true, used by ulfius_send_http_request */
237 int check_server_certificate_flag; /* !< check certificate peer and or server hostname if check_server_certificate is enabled, values available are U_SSL_VERIFY_PEER, U_SSL_VERIFY_HOSTNAME or both, default value is both (U_SSL_VERIFY_PEER|U_SSL_VERIFY_HOSTNAME), used by ulfius_send_http_request */
238 int check_proxy_certificate; /* !< check proxy certificate and hostname, default true, used by ulfius_send_http_request, requires libcurl >= 7.52 */
239 int check_proxy_certificate_flag; /* !< check certificate peer and or proxy hostname if check_proxy_certificate is enabled, values available are U_SSL_VERIFY_PEER, U_SSL_VERIFY_HOSTNAME or both, default value is both (U_SSL_VERIFY_PEER|U_SSL_VERIFY_HOSTNAME), used by ulfius_send_http_request, requires libcurl >= 7.52 */
240 int follow_redirect; /* !< follow url redirections, used by ulfius_send_http_request */
241 char * ca_path; /* !< specify a path to CA certificates instead of system path, used by ulfius_send_http_request */
242 unsigned long timeout; /* !< connection timeout used by ulfius_send_http_request, default is 0 */
243 struct sockaddr * client_address; /* !< IP address of the client */
244 char * auth_basic_user; /* !< basic authentication username */
245 char * auth_basic_password; /* !< basic authentication password */
246 struct _u_map * map_url; /* !< map containing the url variables, both from the route and the ?key=value variables */
247 struct _u_map * map_header; /* !< map containing the header variables */
248 struct _u_map * map_cookie; /* !< map containing the cookie variables */
249 struct _u_map * map_post_body; /* !< map containing the post body variables (if available) */
250 void * binary_body; /* !< raw body */
251 size_t binary_body_length; /* !< length of raw body */
252 unsigned int callback_position; /* !< position of the current callback function in the callback list, starts at 0 */
253 #ifndef U_DISABLE_GNUTLS
254 gnutls_x509_crt_t client_cert; /* !< x509 certificate of the client if the instance uses client certificate authentication and the client is authenticated, available only if GnuTLS support is enabled */
255 char * client_cert_file; /* !< path to client certificate file for sending http requests with certificate authentication, available only if GnuTLS support is enabled */
256 char * client_key_file; /* !< path to client key file for sending http requests with certificate authentication, available only if GnuTLS support is enabled */
257 char * client_key_password; /* !< password to unlock client key file, available only if GnuTLS support is enabled */
258 #endif
259 };
260
267 struct _u_response {
268 long status; /* !< HTTP status code (200, 404, 500, etc) */
269 char * protocol; /* !< HTTP Protocol sent */
270 struct _u_map * map_header; /* !< map containing the header variables */
271 unsigned int nb_cookies; /* !< number of cookies sent */
272 struct _u_cookie * map_cookie; /* !< array of cookies sent */
273 char * auth_realm; /* !< realm to send to the client on authenticationb failed */
274 void * binary_body; /* !< raw binary content */
275 size_t binary_body_length; /* !< length of the binary_body */
276 ssize_t (* stream_callback) (void * stream_user_data, uint64_t offset, char * out_buf, size_t max); /* !< callback function to stream data in response body */
277 void (* stream_callback_free) (void * stream_user_data); /* !< callback function to free data allocated for streaming */
278 uint64_t stream_size; /* !< size of the streamed data (U_STREAM_SIZE_UNKNOWN if unknown) */
279 size_t stream_block_size; /* !< size of each block to be streamed, set according to your system */
280 void * stream_user_data; /* !< user defined data that will be available in your callback stream functions */
281 void * websocket_handle; /* !< handle for websocket extension */
282 void * shared_data; /* !< any data shared between callback functions, must be allocated and freed by the callback functions */
283 void (* free_shared_data)(void * shared_data); /* !< pointer to a function that will free shared_data */
284 unsigned int timeout; /* !< Timeout in seconds to close the connection because of inactivity between the client and the server */
285 };
286
293 struct _u_endpoint {
294 char * http_method; /* !< http verb (GET, POST, PUT, etc.) in upper case */
295 char * url_prefix; /* !< prefix for the url (optional) */
296 char * url_format; /* !< string used to define the endpoint format, separate words with / to define a variable in the url, prefix it with @ or :, example: /test/resource/:name/elements, on an url_format that ends with '*', the rest of the url will not be tested */
297 unsigned int priority; /* !< endpoint priority in descending order (0 is the higher priority) */
298 int (* callback_function)(const struct _u_request * request, /* !< pointer to a function that will be executed each time the endpoint is called, you must declare the function as described. */
299 struct _u_response * response,
300 void * user_data);
301 void * user_data; /* !< pointer to a data or a structure that will be available in callback_function */
302 };
303
310 struct _u_instance {
311 struct MHD_Daemon * mhd_daemon; /* !< pointer to the libmicrohttpd daemon */
312 int status; /* !< status of the current instance, status are U_STATUS_STOP, U_STATUS_RUNNING or U_STATUS_ERROR */
313 unsigned int port; /* !< port number to listen to */
314 #if MHD_VERSION >= 0x00095208
315 unsigned short network_type; /* !< Listen to ipv4 and or ipv6 connections, values available are U_USE_ALL, U_USE_IPV4 or U_USE_IPV6 */
316 #endif
317 struct sockaddr_in * bind_address; /* !< ipv4 address to listen to (optional) */
318 struct sockaddr_in6 * bind_address6; /* !< ipv6 address to listen to (optional) */
319 unsigned int timeout; /* !< Timeout to close the connection because of inactivity between the client and the server */
320 int nb_endpoints; /* !< Number of available endpoints */
321 char * default_auth_realm; /* !< Default realm on authentication error */
322 struct _u_endpoint * endpoint_list; /* !< List of available endpoints */
323 struct _u_endpoint * default_endpoint; /* !< Default endpoint if no other endpoint match the current url */
324 struct _u_map * default_headers; /* !< Default headers that will be added to all response->map_header */
325 size_t max_post_param_size; /* !< maximum size for a post parameter, 0 means no limit, default 0 */
326 size_t max_post_body_size; /* !< maximum size for the entire post body, 0 means no limit, default 0 */
327 void * websocket_handler; /* !< handler for the websocket structure */
328 int (* file_upload_callback) (const struct _u_request * request, /* !< callback function to manage file upload by blocks */
329 const char * key,
330 const char * filename,
331 const char * content_type,
332 const char * transfer_encoding,
333 const char * data,
334 uint64_t off,
335 size_t size,
336 void * cls);
337 void * file_upload_cls; /* !< any pointer to pass to the file_upload_callback function */
338 int mhd_response_copy_data; /* !< to choose between MHD_RESPMEM_MUST_COPY and MHD_RESPMEM_MUST_FREE, only if you use MHD < 0.9.61, otherwise this option is skipped because it's useless */
339 int check_utf8; /* !< check that all parameters values in the request (url, header and post_body), are valid utf8 strings, if a parameter value has non utf8 character, the value, will be ignored, default 1 */
340 #ifndef U_DISABLE_GNUTLS
341 int use_client_cert_auth; /* !< Internal variable use to indicate if the instance uses client certificate authentication, Do not change this value, available only if websocket support is enabled */
342 #endif
343 };
344
352 struct connection_info_struct {
353 struct _u_instance * u_instance;
354 struct MHD_PostProcessor * post_processor;
355 int has_post_processor;
356 int callback_first_iteration;
357 struct _u_request * request;
358 size_t max_post_param_size;
359 struct _u_map map_url_initial;
360 };
361
362 /**********************************
363 * Instance functions declarations
364 **********************************/
365
376 void u_free(void * data);
377
385 int ulfius_global_init();
386
390 void ulfius_global_close();
391
413 int ulfius_init_instance(struct _u_instance * u_instance, unsigned int port, struct sockaddr_in * bind_address, const char * default_auth_realm);
414
415 #if MHD_VERSION >= 0x00095208
427 int ulfius_init_instance_ipv6(struct _u_instance * u_instance, unsigned int port, struct sockaddr_in6 * bind_address, unsigned short network_type, const char * default_auth_realm);
428 #endif
429
436 void ulfius_clean_instance(struct _u_instance * u_instance);
437
445 int ulfius_start_framework(struct _u_instance * u_instance);
446
456 int ulfius_start_secure_framework(struct _u_instance * u_instance, const char * key_pem, const char * cert_pem);
457
458 #ifndef U_DISABLE_GNUTLS
470 int ulfius_start_secure_ca_trust_framework(struct _u_instance * u_instance, const char * key_pem, const char * cert_pem, const char * root_ca_pem);
471 #endif
472
491 int ulfius_start_framework_with_mhd_options(struct _u_instance * u_instance, unsigned int mhd_flags, struct MHD_OptionItem * options);
492
496 void mhd_request_completed (void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe);
497 void * ulfius_uri_logger (void * cls, const char * uri);
498
506 int ulfius_stop_framework(struct _u_instance * u_instance);
507
528 int ulfius_set_upload_file_callback_function(struct _u_instance * u_instance,
529 int (* file_upload_callback) (const struct _u_request * request,
530 const char * key,
531 const char * filename,
532 const char * content_type,
533 const char * transfer_encoding,
534 const char * data,
535 uint64_t off,
536 size_t size,
537 void * cls),
538 void * cls);
539
550 /***********************************
551 * Endpoints functions declarations
552 ***********************************/
553
561 int ulfius_add_endpoint(struct _u_instance * u_instance, const struct _u_endpoint * u_endpoint);
562
580 int ulfius_add_endpoint_by_val(struct _u_instance * u_instance,
581 const char * http_method,
582 const char * url_prefix,
583 const char * url_format,
584 unsigned int priority,
585 int (* callback_function)(const struct _u_request * request, // Input parameters (set by the framework)
586 struct _u_response * response, // Output parameters (set by the user)
587 void * user_data),
588 void * user_data);
589
597 int ulfius_add_endpoint_list(struct _u_instance * u_instance, const struct _u_endpoint ** u_endpoint_list);
598
608 int ulfius_remove_endpoint(struct _u_instance * u_instance, const struct _u_endpoint * u_endpoint);
609
621 int ulfius_set_default_endpoint(struct _u_instance * u_instance,
622 int (* callback_function)(const struct _u_request * request, struct _u_response * response, void * user_data),
623 void * user_data);
624
637 int ulfius_remove_endpoint_by_val(struct _u_instance * u_instance, const char * http_method, const char * url_prefix, const char * url_format);
638
643 const struct _u_endpoint * ulfius_empty_endpoint();
644
652 int ulfius_copy_endpoint(struct _u_endpoint * dest, const struct _u_endpoint * source);
653
661 struct _u_endpoint * ulfius_duplicate_endpoint_list(const struct _u_endpoint * endpoint_list);
662
668 void ulfius_clean_endpoint(struct _u_endpoint * endpoint);
669
675 void ulfius_clean_endpoint_list(struct _u_endpoint * endpoint_list);
676
684 int ulfius_equals_endpoints(const struct _u_endpoint * endpoint1, const struct _u_endpoint * endpoint2);
685
696 #ifndef U_DISABLE_CURL
697 /********************************************
698 * Requests/Responses functions declarations
699 ********************************************/
700
708 int ulfius_send_http_request(const struct _u_request * request, struct _u_response * response);
709
720 int ulfius_send_http_streaming_request(const struct _u_request * request, struct _u_response * response, size_t (* write_body_function)(void * contents, size_t size, size_t nmemb, void * user_data), void * write_body_data);
721
740 int ulfius_send_smtp_email(const char * host,
741 const int port,
742 const int use_tls,
743 const int verify_certificate,
744 const char * user,
745 const char * password,
746 const char * from,
747 const char * to,
748 const char * cc,
749 const char * bcc,
750 const char * subject,
751 const char * mail_body);
752
772 int ulfius_send_smtp_rich_email(const char * host,
773 const int port,
774 const int use_tls,
775 const int verify_certificate,
776 const char * user,
777 const char * password,
778 const char * from,
779 const char * to,
780 const char * cc,
781 const char * bcc,
782 const char * content_type,
783 const char * subject,
784 const char * mail_body);
785 #endif
786
811 int ulfius_add_cookie_to_response(struct _u_response * response, const char * key, const char * value, const char * expires, const unsigned int max_age,
812 const char * domain, const char * path, const int secure, const int http_only);
813
832 int ulfius_add_same_site_cookie_to_response(struct _u_response * response, const char * key, const char * value, const char * expires, const unsigned int max_age,
833 const char * domain, const char * path, const int secure, const int http_only, const int same_site);
834
853 int ulfius_add_header_to_response(struct _u_response * response, const char * key, const char * value);
854
862 int ulfius_set_string_body_request(struct _u_request * request, const char * string_body);
863
872 int ulfius_set_binary_body_request(struct _u_request * request, const char * binary_body, const size_t length);
873
880 int ulfius_set_empty_body_request(struct _u_request * request);
881
890 int ulfius_set_string_body_response(struct _u_response * response, const unsigned int status, const char * body);
891
901 int ulfius_set_binary_body_response(struct _u_response * response, const unsigned int status, const char * body, const size_t length);
902
910 int ulfius_set_empty_body_response(struct _u_response * response, const unsigned int status);
911
934 int ulfius_set_stream_response(struct _u_response * response,
935 const unsigned int status,
936 ssize_t (* stream_callback) (void * stream_user_data, uint64_t offset, char * out_buf, size_t max),
937 void (* stream_callback_free) (void * stream_user_data),
938 uint64_t stream_size,
939 size_t stream_block_size,
940 void * stream_user_data);
941
958 int ulfius_init_request(struct _u_request * request);
959
968 int ulfius_clean_request(struct _u_request * request);
969
976 int ulfius_clean_request_full(struct _u_request * request);
977
985 int ulfius_copy_request(struct _u_request * dest, const struct _u_request * source);
986
992 int ulfius_set_request_properties(struct _u_request * request, ...);
993
999 int ulfius_init_response(struct _u_response * response);
1000
1009 int ulfius_clean_response(struct _u_response * response);
1010
1016 int ulfius_clean_response_full(struct _u_response * response);
1017
1024 int ulfius_copy_response(struct _u_response * dest, const struct _u_response * source);
1025
1032 int ulfius_clean_cookie(struct _u_cookie * cookie);
1033
1040 int ulfius_copy_cookie(struct _u_cookie * dest, const struct _u_cookie * source);
1041
1048 struct _u_request * ulfius_duplicate_request(const struct _u_request * request);
1049
1056 struct _u_response * ulfius_duplicate_response(const struct _u_response * response);
1057
1063 int ulfius_set_response_properties(struct _u_response * response, ...);
1064
1073 int ulfius_set_response_shared_data(struct _u_response * response, void * shared_data, void (* free_shared_data) (void * shared_data));
1074
1093 char * ulfius_url_decode(const char * str);
1094
1103 char * ulfius_url_encode(const char * str);
1104
1115 #ifndef U_DISABLE_JANSSON
1126 json_t * ulfius_get_json_body_request(const struct _u_request * request, json_error_t * json_error);
1127
1135 int ulfius_set_json_body_request(struct _u_request * request, json_t * j_body);
1136
1147 json_t * ulfius_get_json_body_response(struct _u_response * response, json_error_t * json_error);
1148
1157 int ulfius_set_json_body_response(struct _u_response * response, const unsigned int status, const json_t * j_body);
1158 #endif
1159
1170 /************************************************************************
1171 * _u_map declarations *
1172 * _u_map is a simple map structure that handles sets of key/value maps *
1173 ************************************************************************/
1174
1181 int u_map_init(struct _u_map * u_map);
1182
1188 int u_map_clean(struct _u_map * u_map);
1189
1195 int u_map_clean_full(struct _u_map * u_map);
1196
1202 int u_map_clean_enum(char ** array);
1203
1209 const char ** u_map_enum_keys(const struct _u_map * u_map);
1210
1216 const char ** u_map_enum_values(const struct _u_map * u_map);
1217
1226 int u_map_has_key(const struct _u_map * u_map, const char * key);
1227
1236 int u_map_has_value(const struct _u_map * u_map, const char * value);
1237
1247 int u_map_has_value_binary(const struct _u_map * u_map, const char * value, size_t length);
1248
1257 int u_map_has_key_case(const struct _u_map * u_map, const char * key);
1258
1267 int u_map_has_value_case(const struct _u_map * u_map, const char * value);
1268
1277 int u_map_put(struct _u_map * u_map, const char * key, const char * value);
1278
1290 int u_map_put_binary(struct _u_map * u_map, const char * key, const char * value, uint64_t offset, size_t length);
1291
1299 ssize_t u_map_get_length(const struct _u_map * u_map, const char * key);
1300
1308 ssize_t u_map_get_case_length(const struct _u_map * u_map, const char * key);
1309
1317 const char * u_map_get(const struct _u_map * u_map, const char * key);
1318
1326 const char * u_map_get_case(const struct _u_map * u_map, const char * key);
1327
1335 int u_map_remove_from_key(struct _u_map * u_map, const char * key);
1336
1344 int u_map_remove_from_key_case(struct _u_map * u_map, const char * key);
1345
1353 int u_map_remove_from_value(struct _u_map * u_map, const char * value);
1354
1362 int u_map_remove_from_value_case(struct _u_map * u_map, const char * value);
1363
1371 int u_map_remove_from_value_binary(struct _u_map * u_map, const char * key, size_t length);
1372
1379 int u_map_remove_at(struct _u_map * u_map, const int index);
1380
1387 struct _u_map * u_map_copy(const struct _u_map * source);
1388
1396 int u_map_copy_into(struct _u_map * dest, const struct _u_map * source);
1397
1404 int u_map_count(const struct _u_map * source);
1405
1411 int u_map_empty(struct _u_map * u_map);
1412
1423 #ifndef U_DISABLE_WEBSOCKET
1424
1425 /**********************************
1426 * Websocket functions declarations
1427 **********************************/
1428
1429 #define U_WEBSOCKET_USER_AGENT "Ulfius Websocket Client Framework"
1430
1431 #define U_WEBSOCKET_MAGIC_STRING "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
1432 #define U_WEBSOCKET_UPGRADE_VALUE "websocket"
1433 #define U_WEBSOCKET_BAD_REQUEST_BODY "Error in websocket handshake, wrong parameters"
1434 #define U_WEBSOCKET_USEC_WAIT 50
1435 #define WEBSOCKET_MAX_CLOSE_TRY 10
1436
1437 #define U_WEBSOCKET_BIT_FIN 0x80
1438 #define U_WEBSOCKET_MASK 0x80
1439 #define U_WEBSOCKET_LEN_MASK 0x7F
1440 #define U_WEBSOCKET_OPCODE_CONTINUE 0x00
1441 #define U_WEBSOCKET_OPCODE_TEXT 0x01
1442 #define U_WEBSOCKET_OPCODE_BINARY 0x02
1443 #define U_WEBSOCKET_OPCODE_CLOSE 0x08
1444 #define U_WEBSOCKET_OPCODE_PING 0x09
1445 #define U_WEBSOCKET_OPCODE_PONG 0x0A
1446 #define U_WEBSOCKET_OPCODE_CLOSED 0xFD
1447 #define U_WEBSOCKET_OPCODE_ERROR 0xFE
1448 #define U_WEBSOCKET_OPCODE_NONE 0xFF
1449
1450 #define U_WEBSOCKET_NONE 0
1451 #define U_WEBSOCKET_SERVER 1
1452 #define U_WEBSOCKET_CLIENT 2
1453
1454 #define U_WEBSOCKET_STATUS_OPEN 0
1455 #define U_WEBSOCKET_STATUS_CLOSE 1
1456 #define U_WEBSOCKET_STATUS_ERROR 2
1457
1458 #define U_WEBSOCKET_RSV1 0x40
1459 #define U_WEBSOCKET_RSV2 0x20
1460 #define U_WEBSOCKET_RSV3 0x10
1461
1462 #define WEBSOCKET_RESPONSE_HTTP 0x0001
1463 #define WEBSOCKET_RESPONSE_UPGRADE 0x0002
1464 #define WEBSOCKET_RESPONSE_CONNECTION 0x0004
1465 #define WEBSOCKET_RESPONSE_ACCEPT 0x0008
1466 #define WEBSOCKET_RESPONSE_PROTCOL 0x0010
1467 #define WEBSOCKET_RESPONSE_EXTENSION 0x0020
1468
1469 #define WEBSOCKET_DEFLATE_CHUNK_SIZE 32768
1470 #define WEBSOCKET_DEFLATE_WINDOWS_BITS 15
1471
1472 #define U_WEBSOCKET_KEEP_NONE 0x00
1473 #define U_WEBSOCKET_KEEP_INCOMING 0x01
1474 #define U_WEBSOCKET_KEEP_OUTCOMING 0x10
1475
1479 struct _websocket_deflate_context {
1480 z_stream infstream;
1481 z_stream defstream;
1482 int deflate_mask;
1483 int inflate_mask;
1484 uint server_no_context_takeover;
1485 uint client_no_context_takeover;
1486 uint server_max_window_bits;
1487 uint client_max_window_bits;
1488 };
1489
1494 struct _websocket_extension {
1495 char * extension_server;
1496 char * extension_client;
1497 uint8_t rsv;
1498 int (* websocket_extension_message_out_perform)(const uint8_t opcode,
1499 const uint64_t data_len_in,
1500 const char * data_in,
1501 uint64_t * data_len_out,
1502 char ** data_out,
1503 const uint64_t fragment_len,
1504 void * user_data,
1505 void * context);
1506 void * websocket_extension_message_out_perform_user_data;
1507 int (* websocket_extension_message_in_perform)(const uint8_t opcode,
1508 const uint64_t data_len_in,
1509 const char * data_in,
1510 uint64_t * data_len_out,
1511 char ** data_out,
1512 const uint64_t fragment_len,
1513 void * user_data,
1514 void * context);
1515 void * websocket_extension_message_in_perform_user_data;
1516 int (* websocket_extension_server_match)(const char * extension_client,
1517 const char ** extension_client_list,
1518 char ** extension_server,
1519 void * user_data,
1520 void ** context);
1521 void * websocket_extension_server_match_user_data;
1522 int (* websocket_extension_client_match)(const char * extension_server,
1523 void * user_data,
1524 void ** context);
1525 void * websocket_extension_client_match_user_data;
1526 void (* websocket_extension_free_context)(void * user_data,
1527 void * context);
1528 void * websocket_extension_free_context_user_data;
1529 int enabled;
1530 void * context;
1531 };
1532
1539 struct _websocket_manager {
1540 struct _websocket_message_list * message_list_incoming; /* !< list of incoming messages */
1541 struct _websocket_message_list * message_list_outcoming; /* !< list of outcoming messages */
1542 int keep_messages; /* !< keep incoming and/or outcoming messages, flags available are U_WEBSOCKET_KEEP_INCOMING, U_WEBSOCKET_KEEP_OUTCOMING, U_WEBSOCKET_KEEP_NONE, default is U_WEBSOCKET_KEEP_INCOMING|U_WEBSOCKET_KEEP_OUTCOMING */
1543 int connected; /* !< flag to know if the websocket is connected or not */
1544 int ping_sent; /* !< flag to know if the websocket has sent a ping frame or not, before receiving a pong */
1545 int close_flag; /* !< flag to set before closing a websocket */
1546 MHD_socket mhd_sock; /* !< reference to libmicrohttpd's socket for websocket server */
1547 int tcp_sock; /* !< tcp socket for websocket client */
1548 int tls; /* !< set to 1 if the websocket is in a TLS socket */
1549 gnutls_session_t gnutls_session; /* !< GnuTLS session for websocket client */
1550 gnutls_certificate_credentials_t xcred; /* !< certificate credential used by GnuTLS */
1551 char * protocol; /* !< websocket protocol */
1552 char * extensions; /* !< websocket extension */
1553 pthread_mutex_t read_lock; /* !< mutex to read data in the socket */
1554 pthread_mutex_t write_lock; /* !< mutex to write data in the socket */
1555 pthread_mutex_t status_lock; /* !< mutex to broadcast new status */
1556 pthread_cond_t status_cond; /* !< condition to broadcast new status */
1557 struct pollfd fds_in;
1558 struct pollfd fds_out;
1559 int type;
1560 int rsv_expected;
1561 struct _pointer_list * websocket_extension_list;
1562 };
1563
1569 struct _websocket_message {
1570 time_t datestamp; /* !< date stamp of the message */
1571 uint8_t rsv; /* !< flags RSV1-3 of the message */
1572 uint8_t opcode; /* !< opcode for the message (string or binary) */
1573 uint8_t has_mask; /* !< does the message contain a mask? */
1574 uint8_t mask[4]; /* !< mask used if any */
1575 size_t data_len; /* !< length of the data */
1576 char * data; /* !< message data */
1577 size_t fragment_len; /* !< length of the fragment, 0 if not fragmented */
1578 uint8_t fin; /* !< flag fin (end of fragmented message) */
1579 };
1580
1584 struct _websocket_message_list {
1585 struct _websocket_message ** list; /* !< messages list */
1586 size_t len; /* !< message list length */
1587 };
1588
1593 struct _websocket {
1594 struct _u_instance * instance; /* !< reference to the ulfius instance if any */
1595 struct _u_request * request; /* !< refrence to the ulfius request of any */
1596 void (* websocket_manager_callback) (const struct _u_request * request, /* !< reference to a function called after the websocket handshake */
1597 struct _websocket_manager * websocket_manager,
1598 void * websocket_manager_user_data);
1599 void * websocket_manager_user_data; /* !< a user-defined reference that will be available in websocket_manager_callback */
1600 void (* websocket_incoming_message_callback) (const struct _u_request * request, /* !< reference to a function called each time a message arrives */
1601 struct _websocket_manager * websocket_manager,
1602 const struct _websocket_message * message,
1603 void * websocket_incoming_user_data);
1604 void * websocket_incoming_user_data; /* !< a user-defined reference that will be available in websocket_incoming_message_callback */
1605 void (* websocket_onclose_callback) (const struct _u_request * request, /* !< reference to a function called after the websocket connection ends */
1606 struct _websocket_manager * websocket_manager,
1607 void * websocket_onclose_user_data);
1608 void * websocket_onclose_user_data; /* !< a user-defined reference that will be available in websocket_onclose_callback */
1609 struct _websocket_manager * websocket_manager; /* !< refrence to the websocket manager if any */
1610 struct MHD_UpgradeResponseHandle * urh; /* !< reference used by libmicrohttpd to upgrade the connection */
1611 };
1612
1616 struct _websocket_client_handler {
1617 struct _websocket * websocket; /* !< the websocket to use */
1618 struct _u_response * response; /* !< the response attached to the websocket */
1619 };
1620
1621 /********************************/
1623 /********************************/
1624
1634 int ulfius_websocket_send_message(struct _websocket_manager * websocket_manager,
1635 const uint8_t opcode,
1636 const uint64_t data_len,
1637 const char * data);
1638
1650 int ulfius_websocket_send_fragmented_message(struct _websocket_manager * websocket_manager,
1651 const uint8_t opcode,
1652 const uint64_t data_len,
1653 const char * data,
1654 const uint64_t fragment_len);
1655
1662 #ifndef U_DISABLE_JANSSON
1663 int ulfius_websocket_send_json_message(struct _websocket_manager * websocket_manager,
1664 json_t * message);
1665 #endif
1666
1676 struct _websocket_message * ulfius_websocket_pop_first_message(struct _websocket_message_list * message_list);
1677
1682 void ulfius_clear_websocket_message(struct _websocket_message * message);
1683
1684 /********************************/
1686 /********************************/
1687
1702 int ulfius_set_websocket_response(struct _u_response * response,
1703 const char * websocket_protocol,
1704 const char * websocket_extensions,
1705 void (* websocket_manager_callback) (const struct _u_request * request,
1706 struct _websocket_manager * websocket_manager,
1707 void * websocket_manager_user_data),
1708 void * websocket_manager_user_data,
1709 void (* websocket_incoming_message_callback) (const struct _u_request * request,
1710 struct _websocket_manager * websocket_manager,
1711 const struct _websocket_message * message,
1712 void * websocket_incoming_user_data),
1713 void * websocket_incoming_user_data,
1714 void (* websocket_onclose_callback) (const struct _u_request * request,
1715 struct _websocket_manager * websocket_manager,
1716 void * websocket_onclose_user_data),
1717 void * websocket_onclose_user_data);
1718
1735 int ulfius_add_websocket_extension_message_perform(struct _u_response * response,
1736 const char * extension_server,
1737 uint8_t rsv,
1738 int (* websocket_extension_message_out_perform)(const uint8_t opcode,
1739 const uint64_t data_len_in,
1740 const char * data_in,
1741 uint64_t * data_len_out,
1742 char ** data_out,
1743 const uint64_t fragment_len,
1744 void * user_data,
1745 void * context),
1746 void * websocket_extension_message_out_perform_user_data,
1747 int (* websocket_extension_message_in_perform)(const uint8_t opcode,
1748 const uint64_t data_len_in,
1749 const char * data_in,
1750 uint64_t * data_len_out,
1751 char ** data_out,
1752 const uint64_t fragment_len,
1753 void * user_data,
1754 void * context),
1755 void * websocket_extension_message_in_perform_user_data,
1756 int (* websocket_extension_server_match)(const char * extension_client,
1757 const char ** extension_client_list,
1758 char ** extension_server,
1759 void * user_data,
1760 void ** context),
1761 void * websocket_extension_server_match_user_data,
1762 void (* websocket_extension_free_context)(void * user_data,
1763 void * context),
1764 void * websocket_extension_free_context_user_data);
1765
1780 int websocket_extension_message_out_deflate(const uint8_t opcode,
1781 const uint64_t data_len_in,
1782 const char * data_in,
1783 uint64_t * data_len_out,
1784 char ** data_out,
1785 const uint64_t fragment_len,
1786 void * user_data,
1787 void * context);
1788
1802 int websocket_extension_message_in_inflate(const uint8_t opcode,
1803 const uint64_t data_len_in,
1804 const char * data_in,
1805 uint64_t * data_len_out,
1806 char ** data_out,
1807 const uint64_t fragment_len,
1808 void * user_data,
1809 void * context);
1810
1817 void websocket_extension_deflate_free_context(void * user_data, void * context);
1818
1828 int websocket_extension_server_match_deflate(const char * extension_client, const char ** extension_client_list, char ** extension_server, void * user_data, void ** context);
1829
1838 int ulfius_add_websocket_deflate_extension(struct _u_response * response);
1839
1849 int ulfius_websocket_send_close_signal(struct _websocket_manager * websocket_manager);
1850
1858 int ulfius_websocket_status(struct _websocket_manager * websocket_manager);
1859
1868 int ulfius_websocket_wait_close(struct _websocket_manager * websocket_manager, unsigned int timeout);
1869
1870 /********************************/
1872 /********************************/
1873
1887 int ulfius_open_websocket_client_connection(struct _u_request * request,
1888 void (* websocket_manager_callback) (const struct _u_request * request,
1889 struct _websocket_manager * websocket_manager,
1890 void * websocket_manager_user_data),
1891 void * websocket_manager_user_data,
1892 void (* websocket_incoming_message_callback) (const struct _u_request * request,
1893 struct _websocket_manager * websocket_manager,
1894 const struct _websocket_message * message,
1895 void * websocket_incoming_user_data),
1896 void * websocket_incoming_user_data,
1897 void (* websocket_onclose_callback) (const struct _u_request * request,
1898 struct _websocket_manager * websocket_manager,
1899 void * websocket_onclose_user_data),
1900 void * websocket_onclose_user_data,
1901 struct _websocket_client_handler * websocket_client_handler,
1902 struct _u_response * response);
1903
1919 int ulfius_add_websocket_client_extension_message_perform(struct _websocket_client_handler * websocket_client_handler,
1920 const char * extension,
1921 uint8_t rsv,
1922 int (* websocket_extension_message_out_perform)(const uint8_t opcode,
1923 const uint64_t data_len_in,
1924 const char * data_in,
1925 uint64_t * data_len_out,
1926 char ** data_out,
1927 const uint64_t fragment_len,
1928 void * user_data,
1929 void * context),
1930 void * websocket_extension_message_out_perform_user_data,
1931 int (* websocket_extension_message_in_perform)(const uint8_t opcode,
1932 const uint64_t data_len_in,
1933 const char * data_in,
1934 uint64_t * data_len_out,
1935 char ** data_out,
1936 const uint64_t fragment_len,
1937 void * user_data,
1938 void * context),
1939 void * websocket_extension_message_in_perform_user_data,
1940 int (* websocket_extension_client_match)(const char * extension_server,
1941 void * user_data,
1942 void ** context),
1943 void * websocket_extension_client_match_user_data,
1944 void (* websocket_extension_free_context)(void * user_data,
1945 void * context),
1946 void * websocket_extension_free_context_user_data);
1947
1955 int websocket_extension_client_match_deflate(const char * extension_server, void * user_data, void ** context);
1956
1964 int ulfius_add_websocket_client_deflate_extension(struct _websocket_client_handler * websocket_client_handler);
1965
1971 int ulfius_websocket_client_connection_send_close_signal(struct _websocket_client_handler * websocket_client_handler);
1972
1978 int ulfius_websocket_client_connection_close(struct _websocket_client_handler * websocket_client_handler);
1979
1986 int ulfius_websocket_client_connection_status(struct _websocket_client_handler * websocket_client_handler);
1987
1996 int ulfius_websocket_client_connection_wait_close(struct _websocket_client_handler * websocket_client_handler, unsigned int timeout);
1997
2007 int ulfius_set_websocket_request(struct _u_request * request,
2008 const char * url,
2009 const char * websocket_protocol,
2010 const char * websocket_extensions);
2011
2012 #endif
2013
2015 #define ULFIUS_URL_SEPARATOR "/"
2016 #define ULFIUS_HTTP_ENCODING_JSON "application/json"
2017 #define ULFIUS_HTTP_HEADER_CONTENT "Content-Type"
2018 #define ULFIUS_HTTP_NOT_FOUND_BODY "Resource not found"
2019 #define ULFIUS_HTTP_ERROR_BODY "Server Error"
2020
2021 #define ULFIUS_COOKIE_ATTRIBUTE_EXPIRES "Expires"
2022 #define ULFIUS_COOKIE_ATTRIBUTE_MAX_AGE "Max-Age"
2023 #define ULFIUS_COOKIE_ATTRIBUTE_DOMAIN "Domain"
2024 #define ULFIUS_COOKIE_ATTRIBUTE_PATH "Path"
2025 #define ULFIUS_COOKIE_ATTRIBUTE_SECURE "Secure"
2026 #define ULFIUS_COOKIE_ATTRIBUTE_HTTPONLY "HttpOnly"
2027
2028 #define ULFIUS_POSTBUFFERSIZE 65536
2029
2030 #define U_STATUS_STOP 0
2031 #define U_STATUS_RUNNING 1
2032 #define U_STATUS_ERROR 2
2033
2034 #ifndef U_DISABLE_WEBSOCKET
2035
2039 struct _websocket_handle {
2040 char * websocket_protocol; /* !< protocol for the websocket */
2041 char * websocket_extensions; /* !< extensions for the websocket */
2042 void (* websocket_manager_callback) (const struct _u_request * request, /* !< callback function for working with the websocket */
2043 struct _websocket_manager * websocket_manager,
2044 void * websocket_manager_user_data);
2045 void * websocket_manager_user_data; /* !< user-defined data that will be handled to websocket_manager_callback */
2046 void (* websocket_incoming_message_callback) (const struct _u_request * request, /* !< callback function that will be called every time a message arrives from the client in the websocket */
2047 struct _websocket_manager * websocket_manager,
2048 const struct _websocket_message * message,
2049 void * websocket_incoming_user_data);
2050 void * websocket_incoming_user_data; /* !< user-defined data that will be handled to websocket_incoming_message_callback */
2051 void (* websocket_onclose_callback) (const struct _u_request * request, /* !< callback function that will be called if the websocket is open while the program calls ulfius_stop_framework */
2052 struct _websocket_manager * websocket_manager,
2053 void * websocket_onclose_user_data);
2054 void * websocket_onclose_user_data; /* !< user-defined data that will be handled to websocket_onclose_callback */
2055 int rsv_expected;
2056 struct _pointer_list * websocket_extension_list;
2057 };
2058
2062 struct _websocket_handler {
2063 pthread_mutex_t websocket_active_lock; /* !< mutex to change nb_websocket_active value */
2064 size_t nb_websocket_active; /* !< number of active websocket */
2065 struct _websocket ** websocket_active; /* !< array of active websocket */
2066 pthread_mutex_t websocket_close_lock; /* !< mutex to broadcast close signal */
2067 pthread_cond_t websocket_close_cond; /* !< condition to broadcast close signal */
2068 int pthread_init;
2069 };
2070
2071 #endif // U_DISABLE_WEBSOCKET
2072
2083 #ifndef U_DISABLE_GNUTLS
2084 /*
2085 * ulfius_export_client_certificate_pem
2086 * Exports the client certificate using PEM format
2087 * @param request struct _u_request used
2088 * @return the certificate in PEM format
2089 * returned value must be u_free'd after use
2090 */
2091 char * ulfius_export_client_certificate_pem(const struct _u_request * request);
2092
2093 /*
2094 * ulfius_import_client_certificate_pem
2095 * Imports the client certificate using PEM format
2096 * @param request struct _u_request used
2097 * @param str_cert client certificate in PEM format
2098 * @return U_OK on success
2099 */
2100 int ulfius_import_client_certificate_pem(struct _u_request * request, const char * str_cert);
2101
2102 #endif // U_DISABLE_GNUTLS
2103
2108 #ifdef __cplusplus
2109 }
2110 #endif
2111
2112 #endif // __ULFIUS_H__
ulfius_export_client_certificate_pem
char * ulfius_export_client_certificate_pem(const struct _u_request *request)
Definition: u_request.c:872
ulfius_import_client_certificate_pem
int ulfius_import_client_certificate_pem(struct _u_request *request, const char *str_cert)
Definition: u_request.c:896
u_option
u_option
Definition: ulfius.h:140
U_OPT_POST_BODY_PARAMETER_REMOVE
@ U_OPT_POST_BODY_PARAMETER_REMOVE
Remove from map containing the post body variables (if available), expected option value type: const ...
Definition: ulfius.h:164
U_OPT_CHECK_PROXY_CERTIFICATE
@ U_OPT_CHECK_PROXY_CERTIFICATE
check proxy certificate and hostname, default true, used by ulfius_send_http_request,...
Definition: ulfius.h:150
U_OPT_CLIENT_KEY_PASSWORD
@ U_OPT_CLIENT_KEY_PASSWORD
password to unlock client key file, available only if GnuTLS support is enabled, expected option valu...
Definition: ulfius.h:173
U_OPT_STATUS
@ U_OPT_STATUS
HTTP response status code (200, 404, 500, etc), expected option value type: long.
Definition: ulfius.h:175
U_OPT_FOLLOW_REDIRECT
@ U_OPT_FOLLOW_REDIRECT
follow url redirections, used by ulfius_send_http_request, expected option value type: int
Definition: ulfius.h:152
U_OPT_COOKIE_PARAMETER
@ U_OPT_COOKIE_PARAMETER
Add to the map containing the cookie variables, expected option value type: const char *,...
Definition: ulfius.h:159
U_OPT_TIMEOUT
@ U_OPT_TIMEOUT
connection timeout used by ulfius_send_http_request, default is 0 or Timeout in seconds to close the ...
Definition: ulfius.h:154
U_OPT_AUTH_BASIC_USER
@ U_OPT_AUTH_BASIC_USER
basic authentication username, expected option value type: const char *
Definition: ulfius.h:155
U_OPT_CA_PATH
@ U_OPT_CA_PATH
specify a path to CA certificates instead of system path, used by ulfius_send_http_request,...
Definition: ulfius.h:153
U_OPT_AUTH_REALM
@ U_OPT_AUTH_REALM
realm to send to the client response on authenticationb failed, expected option value type: const cha...
Definition: ulfius.h:176
U_OPT_HTTP_URL
@ U_OPT_HTTP_URL
full url used to call this callback function or full url to call when used in a ulfius_send_http_requ...
Definition: ulfius.h:143
U_OPT_HEADER_PARAMETER_REMOVE
@ U_OPT_HEADER_PARAMETER_REMOVE
Remove from map containing the header variables, expected option value type: const char *.
Definition: ulfius.h:162
U_OPT_CLIENT_CERT_FILE
@ U_OPT_CLIENT_CERT_FILE
path to client certificate file for sending http requests with certificate authentication,...
Definition: ulfius.h:171
U_OPT_CLIENT_KEY_FILE
@ U_OPT_CLIENT_KEY_FILE
path to client key file for sending http requests with certificate authentication,...
Definition: ulfius.h:172
U_OPT_JSON_BODY
@ U_OPT_JSON_BODY
Set a stringified json_t * body to the request or the reponse, expected option value type: json_t *.
Definition: ulfius.h:168
U_OPT_HTTP_PROXY
@ U_OPT_HTTP_PROXY
proxy address to use for outgoing connections, used by ulfius_send_http_request, expected option valu...
Definition: ulfius.h:144
U_OPT_COOKIE_PARAMETER_REMOVE
@ U_OPT_COOKIE_PARAMETER_REMOVE
Remove from map containing the cookie variables, expected option value type: const char *.
Definition: ulfius.h:163
U_OPT_HTTP_VERB
@ U_OPT_HTTP_VERB
http method (GET, POST, PUT, DELETE, etc.), expected option value type: const char *
Definition: ulfius.h:142
U_OPT_NONE
@ U_OPT_NONE
Empty option to complete a ulfius_set_request_properties or ulfius_set_request_properties.
Definition: ulfius.h:141
U_OPT_BINARY_BODY
@ U_OPT_BINARY_BODY
Set a raw body to the request or the reponse, expected option value type: const char *,...
Definition: ulfius.h:165
U_OPT_AUTH_BASIC_PASSWORD
@ U_OPT_AUTH_BASIC_PASSWORD
basic authentication password, expected option value type: const char *
Definition: ulfius.h:156
U_OPT_SHARED_DATA
@ U_OPT_SHARED_DATA
any data shared between callback functions, must be allocated and freed by the callback functions,...
Definition: ulfius.h:177
U_OPT_URL_PARAMETER_REMOVE
@ U_OPT_URL_PARAMETER_REMOVE
Remove from the map containing the url variables, both from the route and the ?key=value variables,...
Definition: ulfius.h:161
U_OPT_CHECK_SERVER_CERTIFICATE
@ U_OPT_CHECK_SERVER_CERTIFICATE
check server certificate and hostname, default true, used by ulfius_send_http_request,...
Definition: ulfius.h:148
U_OPT_POST_BODY_PARAMETER
@ U_OPT_POST_BODY_PARAMETER
Add to the map containing the post body variables (if available), expected option value type: const c...
Definition: ulfius.h:160
U_OPT_CHECK_PROXY_CERTIFICATE_FLAG
@ U_OPT_CHECK_PROXY_CERTIFICATE_FLAG
check certificate peer and or proxy hostname if check_proxy_certificate is enabled,...
Definition: ulfius.h:151
U_OPT_STRING_BODY
@ U_OPT_STRING_BODY
Set a char * body to the request or the reponse, expected option value type: const char *.
Definition: ulfius.h:166
U_OPT_URL_PARAMETER
@ U_OPT_URL_PARAMETER
Add to the map containing the url variables, both from the route and the ?key=value variables,...
Definition: ulfius.h:157
U_OPT_HEADER_PARAMETER
@ U_OPT_HEADER_PARAMETER
Add to the map containing the header variables, expected option value type: const char *,...
Definition: ulfius.h:158
U_OPT_HTTP_URL_APPEND
@ U_OPT_HTTP_URL_APPEND
append char * value to the current url, expected option value type: const char *
Definition: ulfius.h:178
U_OPT_CHECK_SERVER_CERTIFICATE_FLAG
@ U_OPT_CHECK_SERVER_CERTIFICATE_FLAG
check certificate peer and or server hostname if check_server_certificate is enabled,...
Definition: ulfius.h:149
ulfius_add_cookie_to_response
int ulfius_add_cookie_to_response(struct _u_response *response, const char *key, const char *value, const char *expires, const unsigned int max_age, const char *domain, const char *path, const int secure, const int http_only)
Definition: u_response.c:200
ulfius_add_same_site_cookie_to_response
int ulfius_add_same_site_cookie_to_response(struct _u_response *response, const char *key, const char *value, const char *expires, const unsigned int max_age, const char *domain, const char *path, const int secure, const int http_only, const int same_site)
Definition: u_response.c:205
ulfius_clean_endpoint_list
void ulfius_clean_endpoint_list(struct _u_endpoint *endpoint_list)
Definition: ulfius.c:1395
ulfius_add_endpoint_list
int ulfius_add_endpoint_list(struct _u_instance *u_instance, const struct _u_endpoint **u_endpoint_list)
Definition: ulfius.c:1446
ulfius_add_endpoint
int ulfius_add_endpoint(struct _u_instance *u_instance, const struct _u_endpoint *u_endpoint)
Definition: ulfius.c:1406
ulfius_remove_endpoint
int ulfius_remove_endpoint(struct _u_instance *u_instance, const struct _u_endpoint *u_endpoint)
Definition: ulfius.c:1463
ulfius_copy_endpoint
int ulfius_copy_endpoint(struct _u_endpoint *dest, const struct _u_endpoint *source)
Definition: ulfius.c:1337
ulfius_empty_endpoint
const struct _u_endpoint * ulfius_empty_endpoint()
Definition: ulfius.c:1517
ulfius_remove_endpoint_by_val
int ulfius_remove_endpoint_by_val(struct _u_instance *u_instance, const char *http_method, const char *url_prefix, const char *url_format)
Definition: ulfius.c:1569
ulfius_add_endpoint_by_val
int ulfius_add_endpoint_by_val(struct _u_instance *u_instance, const char *http_method, const char *url_prefix, const char *url_format, unsigned int priority, int(*callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data), void *user_data)
Definition: ulfius.c:1546
ulfius_equals_endpoints
int ulfius_equals_endpoints(const struct _u_endpoint *endpoint1, const struct _u_endpoint *endpoint2)
Definition: ulfius.c:1528
ulfius_set_default_endpoint
int ulfius_set_default_endpoint(struct _u_instance *u_instance, int(*callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data), void *user_data)
Definition: ulfius.c:1582
ulfius_duplicate_endpoint_list
struct _u_endpoint * ulfius_duplicate_endpoint_list(const struct _u_endpoint *endpoint_list)
Definition: ulfius.c:1359
ulfius_clean_endpoint
void ulfius_clean_endpoint(struct _u_endpoint *endpoint)
Definition: ulfius.c:1380
ulfius_send_smtp_email
int ulfius_send_smtp_email(const char *host, const int port, const int use_tls, const int verify_certificate, const char *user, const char *password, const char *from, const char *to, const char *cc, const char *bcc, const char *subject, const char *mail_body)
Definition: u_send_request.c:906
ulfius_send_http_streaming_request
int ulfius_send_http_streaming_request(const struct _u_request *request, struct _u_response *response, size_t(*write_body_function)(void *contents, size_t size, size_t nmemb, void *user_data), void *write_body_data)
Definition: u_send_request.c:191
ulfius_send_smtp_rich_email
int ulfius_send_smtp_rich_email(const char *host, const int port, const int use_tls, const int verify_certificate, const char *user, const char *password, const char *from, const char *to, const char *cc, const char *bcc, const char *content_type, const char *subject, const char *mail_body)
Definition: u_send_request.c:703
ulfius_send_http_request
int ulfius_send_http_request(const struct _u_request *request, struct _u_response *response)
Definition: u_send_request.c:159
mhd_request_completed
void mhd_request_completed(void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe)
Definition: ulfius.c:282
ulfius_init_instance
int ulfius_init_instance(struct _u_instance *u_instance, unsigned int port, struct sockaddr_in *bind_address, const char *default_auth_realm)
Definition: ulfius.c:1730
ulfius_uri_logger
void * ulfius_uri_logger(void *cls, const char *uri)
Definition: ulfius.c:205
ulfius_clean_instance
void ulfius_clean_instance(struct _u_instance *u_instance)
Definition: ulfius.c:1625
ulfius_stop_framework
int ulfius_stop_framework(struct _u_instance *u_instance)
Definition: ulfius.c:1302
ulfius_start_secure_ca_trust_framework
int ulfius_start_secure_ca_trust_framework(struct _u_instance *u_instance, const char *key_pem, const char *cert_pem, const char *root_ca_pem)
Definition: ulfius.c:1215
ulfius_start_framework
int ulfius_start_framework(struct _u_instance *u_instance)
Definition: ulfius.c:1149
ulfius_start_framework_with_mhd_options
int ulfius_start_framework_with_mhd_options(struct _u_instance *u_instance, unsigned int mhd_flags, struct MHD_OptionItem *options)
Definition: ulfius.c:1275
ulfius_start_secure_framework
int ulfius_start_secure_framework(struct _u_instance *u_instance, const char *key_pem, const char *cert_pem)
Definition: ulfius.c:1166
ulfius_set_upload_file_callback_function
int ulfius_set_upload_file_callback_function(struct _u_instance *u_instance, int(*file_upload_callback)(const struct _u_request *request, const char *key, const char *filename, const char *content_type, const char *transfer_encoding, const char *data, uint64_t off, size_t size, void *cls), void *cls)
Definition: ulfius.c:1605
ulfius_global_close
void ulfius_global_close()
Definition: ulfius.c:1928
u_free
void u_free(void *data)
Definition: ulfius.c:1744
ulfius_global_init
int ulfius_global_init()
Definition: ulfius.c:1904
ulfius_add_header_to_response
int ulfius_add_header_to_response(struct _u_response *response, const char *key, const char *value)
Definition: u_response.c:711
ulfius_set_empty_body_request
int ulfius_set_empty_body_request(struct _u_request *request)
Definition: u_request.c:770
ulfius_set_string_body_response
int ulfius_set_string_body_response(struct _u_response *response, const unsigned int status, const char *body)
Definition: u_response.c:510
ulfius_set_string_body_request
int ulfius_set_string_body_request(struct _u_request *request, const char *string_body)
Definition: u_request.c:723
ulfius_set_binary_body_response
int ulfius_set_binary_body_response(struct _u_response *response, const unsigned int status, const char *body, const size_t length)
Definition: u_response.c:528
ulfius_set_binary_body_request
int ulfius_set_binary_body_request(struct _u_request *request, const char *binary_body, const size_t length)
Definition: u_request.c:745
ulfius_set_empty_body_response
int ulfius_set_empty_body_response(struct _u_response *response, const unsigned int status)
Definition: u_response.c:549
ulfius_copy_cookie
int ulfius_copy_cookie(struct _u_cookie *dest, const struct _u_cookie *source)
Definition: u_response.c:301
ulfius_init_request
int ulfius_init_request(struct _u_request *request)
Definition: u_request.c:302
ulfius_init_response
int ulfius_init_response(struct _u_response *response)
Definition: u_response.c:367
ulfius_get_json_body_response
json_t * ulfius_get_json_body_response(struct _u_response *response, json_error_t *json_error)
Definition: u_response.c:703
ulfius_get_json_body_request
json_t * ulfius_get_json_body_request(const struct _u_request *request, json_error_t *json_error)
Definition: u_request.c:843
ulfius_copy_response
int ulfius_copy_response(struct _u_response *dest, const struct _u_response *source)
Definition: u_response.c:420
ulfius_clean_request_full
int ulfius_clean_request_full(struct _u_request *request)
Definition: u_request.c:401
ulfius_clean_response
int ulfius_clean_response(struct _u_response *response)
Definition: u_response.c:326
ulfius_set_response_properties
int ulfius_set_response_properties(struct _u_response *response,...)
Definition: u_response.c:588
ulfius_clean_request
int ulfius_clean_request(struct _u_request *request)
Definition: u_request.c:358
ulfius_duplicate_request
struct _u_request * ulfius_duplicate_request(const struct _u_request *request)
Definition: u_request.c:786
ulfius_copy_request
int ulfius_copy_request(struct _u_request *dest, const struct _u_request *source)
Definition: u_request.c:415
ulfius_set_json_body_response
int ulfius_set_json_body_response(struct _u_response *response, const unsigned int status, const json_t *j_body)
Definition: u_response.c:676
ulfius_set_request_properties
int ulfius_set_request_properties(struct _u_request *request,...)
Definition: u_request.c:529
ulfius_duplicate_response
struct _u_response * ulfius_duplicate_response(const struct _u_response *response)
Definition: u_response.c:487
ulfius_clean_cookie
int ulfius_clean_cookie(struct _u_cookie *cookie)
Definition: u_response.c:283
ulfius_set_json_body_request
int ulfius_set_json_body_request(struct _u_request *request, json_t *j_body)
Definition: u_request.c:817
ulfius_clean_response_full
int ulfius_clean_response_full(struct _u_response *response)
Definition: u_response.c:358
ulfius_set_response_shared_data
int ulfius_set_response_shared_data(struct _u_response *response, void *shared_data, void(*free_shared_data)(void *shared_data))
Definition: u_response.c:657
ulfius_set_stream_response
int ulfius_set_stream_response(struct _u_response *response, const unsigned int status, ssize_t(*stream_callback)(void *stream_user_data, uint64_t offset, char *out_buf, size_t max), void(*stream_callback_free)(void *stream_user_data), uint64_t stream_size, size_t stream_block_size, void *stream_user_data)
Definition: u_response.c:563
u_map_init
int u_map_init(struct _u_map *u_map)
Definition: u_map.c:33
u_map_remove_from_value_binary
int u_map_remove_from_value_binary(struct _u_map *u_map, const char *key, size_t length)
Definition: u_map.c:287
u_map_remove_from_key
int u_map_remove_from_key(struct _u_map *u_map, const char *key)
Definition: u_map.c:237
u_map_clean
int u_map_clean(struct _u_map *u_map)
Definition: u_map.c:66
u_map_remove_at
int u_map_remove_at(struct _u_map *u_map, const int index)
Definition: u_map.c:333
u_map_remove_from_value_case
int u_map_remove_from_value_case(struct _u_map *u_map, const char *value)
Definition: u_map.c:310
u_map_copy
struct _u_map * u_map_copy(const struct _u_map *source)
Definition: u_map.c:452
u_map_get_case_length
ssize_t u_map_get_case_length(const struct _u_map *u_map, const char *key)
Definition: u_map.c:438
u_map_get
const char * u_map_get(const struct _u_map *u_map, const char *key)
Definition: u_map.c:368
u_map_remove_from_key_case
int u_map_remove_from_key_case(struct _u_map *u_map, const char *key)
Definition: u_map.c:260
u_map_has_value
int u_map_has_value(const struct _u_map *u_map, const char *value)
Definition: u_map.c:125
u_map_has_value_case
int u_map_has_value_case(const struct _u_map *u_map, const char *value)
Definition: u_map.c:398
u_map_clean_enum
int u_map_clean_enum(char **array)
Definition: u_map.c:91
u_map_clean_full
int u_map_clean_full(struct _u_map *u_map)
Definition: u_map.c:82
u_map_enum_keys
const char ** u_map_enum_keys(const struct _u_map *u_map)
Definition: u_map.c:105
u_map_has_key_case
int u_map_has_key_case(const struct _u_map *u_map, const char *key)
Definition: u_map.c:386
u_map_get_length
ssize_t u_map_get_length(const struct _u_map *u_map, const char *key)
Definition: u_map.c:424
u_map_empty
int u_map_empty(struct _u_map *u_map)
Definition: u_map.c:504
u_map_copy_into
int u_map_copy_into(struct _u_map *dest, const struct _u_map *source)
Definition: u_map.c:477
u_map_put
int u_map_put(struct _u_map *u_map, const char *key, const char *value)
Definition: u_map.c:141
u_map_has_value_binary
int u_map_has_value_binary(const struct _u_map *u_map, const char *value, size_t length)
Definition: u_map.c:129
u_map_enum_values
const char ** u_map_enum_values(const struct _u_map *u_map)
Definition: u_map.c:109
u_map_has_key
int u_map_has_key(const struct _u_map *u_map, const char *key)
Definition: u_map.c:113
u_map_remove_from_value
int u_map_remove_from_value(struct _u_map *u_map, const char *value)
Definition: u_map.c:283
u_map_put_binary
int u_map_put_binary(struct _u_map *u_map, const char *key, const char *value, uint64_t offset, size_t length)
Definition: u_map.c:149
u_map_count
int u_map_count(const struct _u_map *source)
Definition: u_map.c:495
u_map_get_case
const char * u_map_get_case(const struct _u_map *u_map, const char *key)
Definition: u_map.c:410
ulfius_url_encode
char * ulfius_url_encode(const char *str)
Definition: ulfius.c:1841
ulfius_url_decode
char * ulfius_url_decode(const char *str)
Definition: ulfius.c:1875
_u_cookie
Definition: ulfius.h:209
_u_cookie::key
char * key
Definition: ulfius.h:210
_u_cookie::path
char * path
Definition: ulfius.h:215
_u_cookie::expires
char * expires
Definition: ulfius.h:212
_u_cookie::domain
char * domain
Definition: ulfius.h:214
_u_cookie::http_only
int http_only
Definition: ulfius.h:217
_u_cookie::secure
int secure
Definition: ulfius.h:216
_u_cookie::same_site
int same_site
Definition: ulfius.h:218
_u_cookie::value
char * value
Definition: ulfius.h:211
_u_cookie::max_age
unsigned int max_age
Definition: ulfius.h:213
_u_endpoint
Contains all informations needed for an endpoint.
Definition: ulfius.h:293
_u_endpoint::callback_function
int(* callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data)
Definition: ulfius.h:298
_u_endpoint::user_data
void * user_data
Definition: ulfius.h:301
_u_endpoint::priority
unsigned int priority
Definition: ulfius.h:297
_u_endpoint::http_method
char * http_method
Definition: ulfius.h:294
_u_endpoint::url_format
char * url_format
Definition: ulfius.h:296
_u_endpoint::url_prefix
char * url_prefix
Definition: ulfius.h:295
_u_instance
Contains the needed data for an ulfius instance to work.
Definition: ulfius.h:310
_u_instance::status
int status
Definition: ulfius.h:312
_u_instance::max_post_param_size
size_t max_post_param_size
Definition: ulfius.h:325
_u_instance::mhd_daemon
struct MHD_Daemon * mhd_daemon
Definition: ulfius.h:311
_u_instance::port
unsigned int port
Definition: ulfius.h:313
_u_instance::timeout
unsigned int timeout
Definition: ulfius.h:319
_u_instance::max_post_body_size
size_t max_post_body_size
Definition: ulfius.h:326
_u_instance::bind_address
struct sockaddr_in * bind_address
Definition: ulfius.h:317
_u_instance::file_upload_cls
void * file_upload_cls
Definition: ulfius.h:337
_u_instance::default_headers
struct _u_map * default_headers
Definition: ulfius.h:324
_u_instance::check_utf8
int check_utf8
Definition: ulfius.h:339
_u_instance::bind_address6
struct sockaddr_in6 * bind_address6
Definition: ulfius.h:318
_u_instance::endpoint_list
struct _u_endpoint * endpoint_list
Definition: ulfius.h:322
_u_instance::nb_endpoints
int nb_endpoints
Definition: ulfius.h:320
_u_instance::default_endpoint
struct _u_endpoint * default_endpoint
Definition: ulfius.h:323
_u_instance::websocket_handler
void * websocket_handler
Definition: ulfius.h:327
_u_instance::file_upload_callback
int(* file_upload_callback)(const struct _u_request *request, const char *key, const char *filename, const char *content_type, const char *transfer_encoding, const char *data, uint64_t off, size_t size, void *cls)
Definition: ulfius.h:328
_u_instance::default_auth_realm
char * default_auth_realm
Definition: ulfius.h:321
_u_instance::mhd_response_copy_data
int mhd_response_copy_data
Definition: ulfius.h:338
_u_instance::use_client_cert_auth
int use_client_cert_auth
Definition: ulfius.h:341
_u_map
Definition: ulfius.h:198
_u_map::nb_values
int nb_values
Definition: ulfius.h:199
_u_map::lengths
size_t * lengths
Definition: ulfius.h:202
_u_map::keys
char ** keys
Definition: ulfius.h:200
_u_map::values
char ** values
Definition: ulfius.h:201
_u_request
definition of the parameters available in a struct _u_request
Definition: ulfius.h:227
_u_request::timeout
unsigned long timeout
Definition: ulfius.h:242
_u_request::check_server_certificate_flag
int check_server_certificate_flag
Definition: ulfius.h:237
_u_request::follow_redirect
int follow_redirect
Definition: ulfius.h:240
_u_request::auth_basic_password
char * auth_basic_password
Definition: ulfius.h:245
_u_request::http_protocol
char * http_protocol
Definition: ulfius.h:228
_u_request::check_proxy_certificate_flag
int check_proxy_certificate_flag
Definition: ulfius.h:239
_u_request::client_key_password
char * client_key_password
Definition: ulfius.h:257
_u_request::binary_body
void * binary_body
Definition: ulfius.h:250
_u_request::client_cert
gnutls_x509_crt_t client_cert
Definition: ulfius.h:254
_u_request::map_cookie
struct _u_map * map_cookie
Definition: ulfius.h:248
_u_request::binary_body_length
size_t binary_body_length
Definition: ulfius.h:251
_u_request::map_header
struct _u_map * map_header
Definition: ulfius.h:247
_u_request::check_server_certificate
int check_server_certificate
Definition: ulfius.h:236
_u_request::client_address
struct sockaddr * client_address
Definition: ulfius.h:243
_u_request::ca_path
char * ca_path
Definition: ulfius.h:241
_u_request::map_post_body
struct _u_map * map_post_body
Definition: ulfius.h:249
_u_request::check_proxy_certificate
int check_proxy_certificate
Definition: ulfius.h:238
_u_request::client_key_file
char * client_key_file
Definition: ulfius.h:256
_u_request::url_path
char * url_path
Definition: ulfius.h:231
_u_request::auth_basic_user
char * auth_basic_user
Definition: ulfius.h:244
_u_request::http_verb
char * http_verb
Definition: ulfius.h:229
_u_request::callback_position
unsigned int callback_position
Definition: ulfius.h:252
_u_request::proxy
char * proxy
Definition: ulfius.h:232
_u_request::http_url
char * http_url
Definition: ulfius.h:230
_u_request::map_url
struct _u_map * map_url
Definition: ulfius.h:246
_u_request::client_cert_file
char * client_cert_file
Definition: ulfius.h:255
_u_response
definition of the parameters available in a struct _u_response
Definition: ulfius.h:267
_u_response::protocol
char * protocol
Definition: ulfius.h:269
_u_response::stream_block_size
size_t stream_block_size
Definition: ulfius.h:279
_u_response::stream_user_data
void * stream_user_data
Definition: ulfius.h:280
_u_response::stream_callback
ssize_t(* stream_callback)(void *stream_user_data, uint64_t offset, char *out_buf, size_t max)
Definition: ulfius.h:276
_u_response::websocket_handle
void * websocket_handle
Definition: ulfius.h:281
_u_response::stream_size
uint64_t stream_size
Definition: ulfius.h:278
_u_response::binary_body_length
size_t binary_body_length
Definition: ulfius.h:275
_u_response::map_header
struct _u_map * map_header
Definition: ulfius.h:270
_u_response::status
long status
Definition: ulfius.h:268
_u_response::nb_cookies
unsigned int nb_cookies
Definition: ulfius.h:271
_u_response::timeout
unsigned int timeout
Definition: ulfius.h:284
_u_response::map_cookie
struct _u_cookie * map_cookie
Definition: ulfius.h:272
_u_response::auth_realm
char * auth_realm
Definition: ulfius.h:273
_u_response::stream_callback_free
void(* stream_callback_free)(void *stream_user_data)
Definition: ulfius.h:277
_u_response::free_shared_data
void(* free_shared_data)(void *shared_data)
Definition: ulfius.h:283
_u_response::binary_body
void * binary_body
Definition: ulfius.h:274
_u_response::shared_data
void * shared_data
Definition: ulfius.h:282
connection_info_struct
Definition: ulfius.h:352
connection_info_struct::request
struct _u_request * request
Definition: ulfius.h:357
connection_info_struct::map_url_initial
struct _u_map map_url_initial
Definition: ulfius.h:359
connection_info_struct::u_instance
struct _u_instance * u_instance
Definition: ulfius.h:353
connection_info_struct::max_post_param_size
size_t max_post_param_size
Definition: ulfius.h:358
connection_info_struct::post_processor
struct MHD_PostProcessor * post_processor
Definition: ulfius.h:354
connection_info_struct::callback_first_iteration
int callback_first_iteration
Definition: ulfius.h:356
connection_info_struct::has_post_processor
int has_post_processor
Definition: ulfius.h:355
websocket_extension_message_in_inflate
int websocket_extension_message_in_inflate(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context)
Definition: u_websocket.c:1962
ulfius_add_websocket_extension_message_perform
int ulfius_add_websocket_extension_message_perform(struct _u_response *response, const char *extension_server, uint8_t rsv, int(*websocket_extension_message_out_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_out_perform_user_data, int(*websocket_extension_message_in_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_in_perform_user_data, int(*websocket_extension_server_match)(const char *extension_client, const char **extension_client_list, char **extension_server, void *user_data, void **context), void *websocket_extension_server_match_user_data, void(*websocket_extension_free_context)(void *user_data, void *context), void *websocket_extension_free_context_user_data)
Definition: u_websocket.c:1803
ulfius_websocket_client_connection_send_close_signal
int ulfius_websocket_client_connection_send_close_signal(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2671
ulfius_websocket_send_close_signal
int ulfius_websocket_send_close_signal(struct _websocket_manager *websocket_manager)
Definition: u_websocket.c:2200
ulfius_websocket_send_json_message
int ulfius_websocket_send_json_message(struct _websocket_manager *websocket_manager, json_t *message)
Definition: u_websocket.c:1549
websocket_extension_server_match_deflate
int websocket_extension_server_match_deflate(const char *extension_client, const char **extension_client_list, char **extension_server, void *user_data, void **context)
Definition: u_websocket.c:2040
ulfius_add_websocket_client_deflate_extension
int ulfius_add_websocket_client_deflate_extension(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2662
ulfius_websocket_client_connection_wait_close
int ulfius_websocket_client_connection_wait_close(struct _websocket_client_handler *websocket_client_handler, unsigned int timeout)
Definition: u_websocket.c:2725
ulfius_add_websocket_client_extension_message_perform
int ulfius_add_websocket_client_extension_message_perform(struct _websocket_client_handler *websocket_client_handler, const char *extension, uint8_t rsv, int(*websocket_extension_message_out_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_out_perform_user_data, int(*websocket_extension_message_in_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_in_perform_user_data, int(*websocket_extension_client_match)(const char *extension_server, void *user_data, void **context), void *websocket_extension_client_match_user_data, void(*websocket_extension_free_context)(void *user_data, void *context), void *websocket_extension_free_context_user_data)
Definition: u_websocket.c:2344
ulfius_websocket_client_connection_status
int ulfius_websocket_client_connection_status(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2711
ulfius_websocket_wait_close
int ulfius_websocket_wait_close(struct _websocket_manager *websocket_manager, unsigned int timeout)
Definition: u_websocket.c:2229
ulfius_websocket_status
int ulfius_websocket_status(struct _websocket_manager *websocket_manager)
Definition: u_websocket.c:2215
ulfius_open_websocket_client_connection
int ulfius_open_websocket_client_connection(struct _u_request *request, void(*websocket_manager_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_manager_user_data), void *websocket_manager_user_data, void(*websocket_incoming_message_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, const struct _websocket_message *message, void *websocket_incoming_user_data), void *websocket_incoming_user_data, void(*websocket_onclose_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_onclose_user_data), void *websocket_onclose_user_data, struct _websocket_client_handler *websocket_client_handler, struct _u_response *response)
Definition: u_websocket.c:2430
websocket_extension_message_out_deflate
int websocket_extension_message_out_deflate(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context)
Definition: u_websocket.c:1872
ulfius_set_websocket_response
int ulfius_set_websocket_response(struct _u_response *response, const char *websocket_protocol, const char *websocket_extensions, void(*websocket_manager_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_manager_user_data), void *websocket_manager_user_data, void(*websocket_incoming_message_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, const struct _websocket_message *message, void *websocket_incoming_user_data), void *websocket_incoming_user_data, void(*websocket_onclose_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_onclose_user_data), void *websocket_onclose_user_data)
Definition: u_websocket.c:1756
ulfius_add_websocket_deflate_extension
int ulfius_add_websocket_deflate_extension(struct _u_response *response)
Definition: u_websocket.c:2188
websocket_extension_deflate_free_context
void websocket_extension_deflate_free_context(void *user_data, void *context)
Definition: u_websocket.c:2181
ulfius_websocket_client_connection_close
int ulfius_websocket_client_connection_close(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2684
ulfius_set_websocket_request
int ulfius_set_websocket_request(struct _u_request *request, const char *url, const char *websocket_protocol, const char *websocket_extensions)
Definition: u_websocket.c:2303
ulfius_websocket_send_message
int ulfius_websocket_send_message(struct _websocket_manager *websocket_manager, const uint8_t opcode, const uint64_t data_len, const char *data)
Definition: u_websocket.c:1537
ulfius_websocket_send_fragmented_message
int ulfius_websocket_send_fragmented_message(struct _websocket_manager *websocket_manager, const uint8_t opcode, const uint64_t data_len, const char *data, const uint64_t fragment_len)
Definition: u_websocket.c:1443
ulfius_websocket_pop_first_message
struct _websocket_message * ulfius_websocket_pop_first_message(struct _websocket_message_list *message_list)
Definition: u_websocket.c:1563
websocket_extension_client_match_deflate
int websocket_extension_client_match_deflate(const char *extension_server, void *user_data, void **context)
Definition: u_websocket.c:2551
ulfius_clear_websocket_message
void ulfius_clear_websocket_message(struct _websocket_message *message)
Definition: u_websocket.c:1585