![]() |
ROOT 6.08/07 Reference Guide |
#include <stdio.h>
#include <stddef.h>
Classes | |
struct | mg_callbacks |
struct | mg_client_options |
struct | mg_form_data_handler |
struct | mg_request_info::mg_header |
struct | mg_option |
struct | mg_request_info |
struct | mg_server_ports |
Macros | |
#define | CIVETWEB_API |
#define | CIVETWEB_VERSION "1.8" |
#define | PRINTF_ARGS(x, y) |
#define | PRINTF_FORMAT_STRING(s) s |
Typedefs | |
typedef int(* | mg_authorization_handler) (struct mg_connection *conn, void *cbdata) |
typedef int(* | mg_request_handler) (struct mg_connection *conn, void *cbdata) |
typedef void *(* | mg_thread_func_t) (void *) |
typedef void(* | mg_websocket_close_handler) (const struct mg_connection *, void *) |
typedef int(* | mg_websocket_connect_handler) (const struct mg_connection *, void *) |
typedef int(* | mg_websocket_data_handler) (struct mg_connection *, int, char *, size_t, void *) |
typedef void(* | mg_websocket_ready_handler) (struct mg_connection *, void *) |
Enumerations | |
enum | { CONFIG_TYPE_UNKNOWN = 0x0, CONFIG_TYPE_NUMBER = 0x1, CONFIG_TYPE_STRING = 0x2, CONFIG_TYPE_FILE = 0x3, CONFIG_TYPE_DIRECTORY = 0x4, CONFIG_TYPE_BOOLEAN = 0x5, CONFIG_TYPE_EXT_PATTERN = 0x6 } |
enum | { WEBSOCKET_OPCODE_CONTINUATION = 0x0, WEBSOCKET_OPCODE_TEXT = 0x1, WEBSOCKET_OPCODE_BINARY = 0x2, WEBSOCKET_OPCODE_CONNECTION_CLOSE = 0x8, WEBSOCKET_OPCODE_PING = 0x9, WEBSOCKET_OPCODE_PONG = 0xa } |
enum | { FORM_FIELD_STORAGE_SKIP = 0x0, FORM_FIELD_STORAGE_GET = 0x1, FORM_FIELD_STORAGE_STORE = 0x2, FORM_FIELD_STORAGE_ABORT = 0x10 } |
enum | { TIMEOUT_INFINITE = -1 } |
Functions | |
CIVETWEB_API unsigned | mg_check_feature (unsigned feature) |
CIVETWEB_API struct mg_connection CIVETWEB_API void | mg_close_connection (struct mg_connection *conn) |
CIVETWEB_API struct mg_connection * | mg_connect_client (const char *host, int port, int use_ssl, char *error_buffer, size_t error_buffer_size) |
CIVETWEB_API struct mg_connection * | mg_connect_client_secure (const struct mg_client_options *client_options, char *error_buffer, size_t error_buffer_size) |
CIVETWEB_API struct mg_connection * | mg_connect_websocket_client (const char *host, int port, int use_ssl, char *error_buffer, size_t error_buffer_size, const char *path, const char *origin, mg_websocket_data_handler data_func, mg_websocket_close_handler close_func, void *user_data) |
CIVETWEB_API void | mg_cry (const struct mg_connection *conn, PRINTF_FORMAT_STRING(const char *fmt),...) PRINTF_ARGS(2 |
CIVETWEB_API struct mg_connection * | mg_download (const char *host, int port, int use_ssl, char *error_buffer, size_t error_buffer_size, PRINTF_FORMAT_STRING(const char *request_fmt),...) PRINTF_ARGS(6 |
CIVETWEB_API const char * | mg_get_builtin_mime_type (const char *file_name) |
CIVETWEB_API struct mg_context * | mg_get_context (const struct mg_connection *conn) |
CIVETWEB_API int | mg_get_cookie (const char *cookie, const char *var_name, char *buf, size_t buf_len) |
CIVETWEB_API const char * | mg_get_header (const struct mg_connection *, const char *name) |
CIVETWEB_API const char * | mg_get_option (const struct mg_context *ctx, const char *name) |
CIVETWEB_API size_t | mg_get_ports (const struct mg_context *ctx, size_t size, int *ports, int *ssl) |
CIVETWEB_API const struct mg_request_info * | mg_get_request_info (const struct mg_connection *) |
CIVETWEB_API int | mg_get_response (struct mg_connection *conn, char *ebuf, size_t ebuf_len, int timeout) |
CIVETWEB_API const char * | mg_get_response_code_text (struct mg_connection *conn, int response_code) |
CIVETWEB_API int | mg_get_server_ports (const struct mg_context *ctx, int size, struct mg_server_ports *ports) |
CIVETWEB_API void * | mg_get_user_connection_data (const struct mg_connection *conn) |
CIVETWEB_API void * | mg_get_user_data (const struct mg_context *ctx) |
CIVETWEB_API const struct mg_option * | mg_get_valid_options (void) |
CIVETWEB_API int | mg_get_var (const char *data, size_t data_len, const char *var_name, char *dst, size_t dst_len) |
CIVETWEB_API int | mg_get_var2 (const char *data, size_t data_len, const char *var_name, char *dst, size_t dst_len, size_t occurrence) |
CIVETWEB_API int | mg_handle_form_request (struct mg_connection *conn, struct mg_form_data_handler *fdh) |
CIVETWEB_API void | mg_lock_connection (struct mg_connection *conn) |
CIVETWEB_API void | mg_lock_context (struct mg_context *ctx) |
CIVETWEB_API char * | mg_md5 (char buf[33],...) |
CIVETWEB_API int | mg_modify_passwords_file (const char *passwords_file_name, const char *domain, const char *user, const char *password) |
CIVETWEB_API int | mg_printf (struct mg_connection *, PRINTF_FORMAT_STRING(const char *fmt),...) PRINTF_ARGS(2 |
CIVETWEB_API int | mg_read (struct mg_connection *, void *buf, size_t len) |
CIVETWEB_API int CIVETWEB_API void | mg_send_file (struct mg_connection *conn, const char *path) |
CIVETWEB_API void | mg_send_mime_file (struct mg_connection *conn, const char *path, const char *mime_type) |
CIVETWEB_API void | mg_set_auth_handler (struct mg_context *ctx, const char *uri, mg_authorization_handler handler, void *cbdata) |
CIVETWEB_API void | mg_set_request_handler (struct mg_context *ctx, const char *uri, mg_request_handler handler, void *cbdata) |
CIVETWEB_API void | mg_set_user_connection_data (struct mg_connection *conn, void *data) |
CIVETWEB_API void | mg_set_websocket_handler (struct mg_context *ctx, const char *uri, mg_websocket_connect_handler connect_handler, mg_websocket_ready_handler ready_handler, mg_websocket_data_handler data_handler, mg_websocket_close_handler close_handler, void *cbdata) |
CIVETWEB_API struct mg_context * | mg_start (const struct mg_callbacks *callbacks, void *user_data, const char **configuration_options) |
CIVETWEB_API int | mg_start_thread (mg_thread_func_t f, void *p) |
CIVETWEB_API void | mg_stop (struct mg_context *) |
CIVETWEB_API long long | mg_store_body (struct mg_connection *conn, const char *path) |
CIVETWEB_API void CIVETWEB_API int | mg_strcasecmp (const char *s1, const char *s2) |
CIVETWEB_API int | mg_strncasecmp (const char *s1, const char *s2, size_t len) |
CIVETWEB_API void | mg_unlock_connection (struct mg_connection *conn) |
CIVETWEB_API void | mg_unlock_context (struct mg_context *ctx) |
CIVETWEB_API int | mg_url_decode (const char *src, int src_len, char *dst, int dst_len, int is_form_url_encoded) |
CIVETWEB_API int | mg_url_encode (const char *src, char *dst, size_t dst_len) |
CIVETWEB_API const char * | mg_version (void) |
CIVETWEB_API int | mg_websocket_client_write (struct mg_connection *conn, int opcode, const char *data, size_t data_len) |
CIVETWEB_API int | mg_websocket_write (struct mg_connection *conn, int opcode, const char *data, size_t data_len) |
CIVETWEB_API int | mg_write (struct mg_connection *, const void *buf, size_t len) |
#define CIVETWEB_API |
Definition at line 40 of file civetweb.h.
#define CIVETWEB_VERSION "1.8" |
Definition at line 26 of file civetweb.h.
Definition at line 590 of file civetweb.h.
#define PRINTF_FORMAT_STRING | ( | s | ) | s |
Definition at line 584 of file civetweb.h.
typedef int(* mg_authorization_handler) (struct mg_connection *conn, void *cbdata) |
Definition at line 371 of file civetweb.h.
typedef int(* mg_request_handler) (struct mg_connection *conn, void *cbdata) |
Definition at line 279 of file civetweb.h.
Definition at line 852 of file civetweb.h.
Definition at line 342 of file civetweb.h.
typedef int(* mg_websocket_connect_handler) (const struct mg_connection *, void *) |
Definition at line 334 of file civetweb.h.
typedef int(* mg_websocket_data_handler) (struct mg_connection *, int, char *, size_t, void *) |
Definition at line 337 of file civetweb.h.
Definition at line 336 of file civetweb.h.
anonymous enum |
Enumerator | |
---|---|
CONFIG_TYPE_UNKNOWN | |
CONFIG_TYPE_NUMBER | |
CONFIG_TYPE_STRING | |
CONFIG_TYPE_FILE | |
CONFIG_TYPE_DIRECTORY | |
CONFIG_TYPE_BOOLEAN | |
CONFIG_TYPE_EXT_PATTERN |
Definition at line 431 of file civetweb.h.
anonymous enum |
Enumerator | |
---|---|
WEBSOCKET_OPCODE_CONTINUATION | |
WEBSOCKET_OPCODE_TEXT | |
WEBSOCKET_OPCODE_BINARY | |
WEBSOCKET_OPCODE_CONNECTION_CLOSE | |
WEBSOCKET_OPCODE_PING | |
WEBSOCKET_OPCODE_PONG |
Definition at line 564 of file civetweb.h.
anonymous enum |
Enumerator | |
---|---|
FORM_FIELD_STORAGE_SKIP | |
FORM_FIELD_STORAGE_GET | |
FORM_FIELD_STORAGE_STORE | |
FORM_FIELD_STORAGE_ABORT |
Definition at line 826 of file civetweb.h.
anonymous enum |
Enumerator | |
---|---|
TIMEOUT_INFINITE |
Definition at line 980 of file civetweb.h.
CIVETWEB_API unsigned mg_check_feature | ( | unsigned | feature | ) |
Definition at line 13099 of file civetweb.c.
CIVETWEB_API struct mg_connection CIVETWEB_API void mg_close_connection | ( | struct mg_connection * | conn | ) |
Definition at line 11458 of file civetweb.c.
CIVETWEB_API struct mg_connection* mg_connect_client | ( | const char * | host, |
int | port, | ||
int | use_ssl, | ||
char * | error_buffer, | ||
size_t | error_buffer_size | ||
) |
Definition at line 11634 of file civetweb.c.
CIVETWEB_API struct mg_connection* mg_connect_client_secure | ( | const struct mg_client_options * | client_options, |
char * | error_buffer, | ||
size_t | error_buffer_size | ||
) |
Definition at line 11622 of file civetweb.c.
CIVETWEB_API struct mg_connection* mg_connect_websocket_client | ( | const char * | host, |
int | port, | ||
int | use_ssl, | ||
char * | error_buffer, | ||
size_t | error_buffer_size, | ||
const char * | path, | ||
const char * | origin, | ||
mg_websocket_data_handler | data_func, | ||
mg_websocket_close_handler | close_func, | ||
void * | user_data | ||
) |
Definition at line 12058 of file civetweb.c.
CIVETWEB_API void mg_cry | ( | const struct mg_connection * | conn, |
PRINTF_FORMAT_STRING(const char *fmt) | , | ||
... | |||
) |
CIVETWEB_API struct mg_connection* mg_download | ( | const char * | host, |
int | port, | ||
int | use_ssl, | ||
char * | error_buffer, | ||
size_t | error_buffer_size, | ||
PRINTF_FORMAT_STRING(const char *request_fmt) | , | ||
... | |||
) |
CIVETWEB_API const char* mg_get_builtin_mime_type | ( | const char * | file_name | ) |
Definition at line 5106 of file civetweb.c.
CIVETWEB_API struct mg_context* mg_get_context | ( | const struct mg_connection * | conn | ) |
Definition at line 1748 of file civetweb.c.
CIVETWEB_API int mg_get_cookie | ( | const char * | cookie, |
const char * | var_name, | ||
char * | buf, | ||
size_t | buf_len | ||
) |
Definition at line 4513 of file civetweb.c.
CIVETWEB_API const char* mg_get_header | ( | const struct mg_connection * | , |
const char * | name | ||
) |
Definition at line 2063 of file civetweb.c.
CIVETWEB_API const char* mg_get_option | ( | const struct mg_context * | ctx, |
const char * | name | ||
) |
Definition at line 1734 of file civetweb.c.
CIVETWEB_API size_t mg_get_ports | ( | const struct mg_context * | ctx, |
size_t | size, | ||
int * | ports, | ||
int * | ssl | ||
) |
Definition at line 1781 of file civetweb.c.
CIVETWEB_API const struct mg_request_info* mg_get_request_info | ( | const struct mg_connection * | ) |
Definition at line 1972 of file civetweb.c.
CIVETWEB_API int mg_get_response | ( | struct mg_connection * | conn, |
char * | ebuf, | ||
size_t | ebuf_len, | ||
int | timeout | ||
) |
Definition at line 11924 of file civetweb.c.
CIVETWEB_API const char* mg_get_response_code_text | ( | struct mg_connection * | conn, |
int | response_code | ||
) |
Definition at line 2286 of file civetweb.c.
CIVETWEB_API int mg_get_server_ports | ( | const struct mg_context * | ctx, |
int | size, | ||
struct mg_server_ports * | ports | ||
) |
Definition at line 1796 of file civetweb.c.
CIVETWEB_API void* mg_get_user_connection_data | ( | const struct mg_connection * | conn | ) |
Definition at line 1771 of file civetweb.c.
CIVETWEB_API void* mg_get_user_data | ( | const struct mg_context * | ctx | ) |
Definition at line 1755 of file civetweb.c.
CIVETWEB_API const struct mg_option* mg_get_valid_options | ( | void | ) |
Definition at line 1482 of file civetweb.c.
CIVETWEB_API int mg_get_var | ( | const char * | data, |
size_t | data_len, | ||
const char * | var_name, | ||
char * | dst, | ||
size_t | dst_len | ||
) |
Definition at line 4445 of file civetweb.c.
CIVETWEB_API int mg_get_var2 | ( | const char * | data, |
size_t | data_len, | ||
const char * | var_name, | ||
char * | dst, | ||
size_t | dst_len, | ||
size_t | occurrence | ||
) |
Definition at line 4456 of file civetweb.c.
CIVETWEB_API int mg_handle_form_request | ( | struct mg_connection * | conn, |
struct mg_form_data_handler * | fdh | ||
) |
Definition at line 154 of file handle_form.inl.
CIVETWEB_API void mg_lock_connection | ( | struct mg_connection * | conn | ) |
Definition at line 8384 of file civetweb.c.
CIVETWEB_API void mg_lock_context | ( | struct mg_context * | ctx | ) |
Definition at line 8400 of file civetweb.c.
CIVETWEB_API char* mg_md5 | ( | char | buf[33], |
... | |||
) |
Definition at line 5174 of file civetweb.c.
CIVETWEB_API int mg_modify_passwords_file | ( | const char * | passwords_file_name, |
const char * | domain, | ||
const char * | user, | ||
const char * | password | ||
) |
Definition at line 5684 of file civetweb.c.
CIVETWEB_API int mg_printf | ( | struct mg_connection * | , |
PRINTF_FORMAT_STRING(const char *fmt) | , | ||
... | |||
) |
CIVETWEB_API int mg_read | ( | struct mg_connection * | , |
void * | buf, | ||
size_t | len | ||
) |
Definition at line 4146 of file civetweb.c.
CIVETWEB_API int CIVETWEB_API void mg_send_file | ( | struct mg_connection * | conn, |
const char * | path | ||
) |
Definition at line 6674 of file civetweb.c.
CIVETWEB_API void mg_send_mime_file | ( | struct mg_connection * | conn, |
const char * | path, | ||
const char * | mime_type | ||
) |
Definition at line 6681 of file civetweb.c.
CIVETWEB_API void mg_set_auth_handler | ( | struct mg_context * | ctx, |
const char * | uri, | ||
mg_authorization_handler | handler, | ||
void * | cbdata | ||
) |
Definition at line 9612 of file civetweb.c.
CIVETWEB_API void mg_set_request_handler | ( | struct mg_context * | ctx, |
const char * | uri, | ||
mg_request_handler | handler, | ||
void * | cbdata | ||
) |
Definition at line 9566 of file civetweb.c.
CIVETWEB_API void mg_set_user_connection_data | ( | struct mg_connection * | conn, |
void * | data | ||
) |
Definition at line 1762 of file civetweb.c.
CIVETWEB_API void mg_set_websocket_handler | ( | struct mg_context * | ctx, |
const char * | uri, | ||
mg_websocket_connect_handler | connect_handler, | ||
mg_websocket_ready_handler | ready_handler, | ||
mg_websocket_data_handler | data_handler, | ||
mg_websocket_close_handler | close_handler, | ||
void * | cbdata | ||
) |
Definition at line 9586 of file civetweb.c.
CIVETWEB_API struct mg_context* mg_start | ( | const struct mg_callbacks * | callbacks, |
void * | user_data, | ||
const char ** | configuration_options | ||
) |
Definition at line 12875 of file civetweb.c.
CIVETWEB_API int mg_start_thread | ( | mg_thread_func_t | f, |
void * | p | ||
) |
Definition at line 3550 of file civetweb.c.
CIVETWEB_API void mg_stop | ( | struct mg_context * | ) |
Definition at line 12800 of file civetweb.c.
CIVETWEB_API long long mg_store_body | ( | struct mg_connection * | conn, |
const char * | path | ||
) |
Definition at line 6763 of file civetweb.c.
CIVETWEB_API void CIVETWEB_API int mg_strcasecmp | ( | const char * | s1, |
const char * | s2 | ||
) |
Definition at line 1606 of file civetweb.c.
CIVETWEB_API int mg_strncasecmp | ( | const char * | s1, |
const char * | s2, | ||
size_t | len | ||
) |
Definition at line 1591 of file civetweb.c.
CIVETWEB_API void mg_unlock_connection | ( | struct mg_connection * | conn | ) |
Definition at line 8392 of file civetweb.c.
CIVETWEB_API void mg_unlock_context | ( | struct mg_context * | ctx | ) |
Definition at line 8408 of file civetweb.c.
CIVETWEB_API int mg_url_decode | ( | const char * | src, |
int | src_len, | ||
char * | dst, | ||
int | dst_len, | ||
int | is_form_url_encoded | ||
) |
Definition at line 4414 of file civetweb.c.
CIVETWEB_API int mg_url_encode | ( | const char * | src, |
char * | dst, | ||
size_t | dst_len | ||
) |
Definition at line 5973 of file civetweb.c.
CIVETWEB_API const char* mg_version | ( | void | ) |
Definition at line 1965 of file civetweb.c.
CIVETWEB_API int mg_websocket_client_write | ( | struct mg_connection * | conn, |
int | opcode, | ||
const char * | data, | ||
size_t | data_len | ||
) |
CIVETWEB_API int mg_websocket_write | ( | struct mg_connection * | conn, |
int | opcode, | ||
const char * | data, | ||
size_t | data_len | ||
) |
CIVETWEB_API int mg_write | ( | struct mg_connection * | , |
const void * | buf, | ||
size_t | len | ||
) |
Definition at line 4235 of file civetweb.c.