You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by bp...@apache.org on 2015/07/09 12:02:53 UTC
[2/2] celix git commit: CELIX-247: Inital changes to be able to
compile on ANDROID
CELIX-247: Inital changes to be able to compile on ANDROID
Project: http://git-wip-us.apache.org/repos/asf/celix/repo
Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/654f4252
Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/654f4252
Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/654f4252
Branch: refs/heads/feature/CELIX-247_android_support
Commit: 654f4252c843d58c14ea9458de18367e615fc407
Parents: 3b36eb2
Author: Bjoern Petri <bp...@apache.org>
Authored: Thu Jul 9 12:00:00 2015 +0200
Committer: Bjoern Petri <bp...@apache.org>
Committed: Thu Jul 9 12:00:00 2015 +0200
----------------------------------------------------------------------
cmake/CMakeCelix.cmake | 4 +
examples/CMakeLists.txt | 7 +-
examples/deploy.cmake | 6 +-
framework/private/src/framework.c | 3 +-
.../private/src/endpoint_discovery_server.c | 9 +
.../discovery_configured/CMakeLists.txt | 22 +-
.../remote_service_admin_http/CMakeLists.txt | 6 +-
.../private/src/remote_service_admin_impl.c | 10 +-
.../utils/private/include/civetweb.h | 542 +-
remote_services/utils/private/src/civetweb.c | 14935 +++++++----------
10 files changed, 6570 insertions(+), 8974 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/cmake/CMakeCelix.cmake
----------------------------------------------------------------------
diff --git a/cmake/CMakeCelix.cmake b/cmake/CMakeCelix.cmake
index 40221b8..a8a5067 100644
--- a/cmake/CMakeCelix.cmake
+++ b/cmake/CMakeCelix.cmake
@@ -18,6 +18,10 @@
set(CELIX_CMAKE_DIRECTORY ${CMAKE_CURRENT_LIST_DIR})
+if (ANDROID)
+ add_definitions( -DANDROID )
+endif ()
+
include_directories("framework/public/include")
include_directories(${CMAKE_CURRENT_BINARY_DIR})
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/examples/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
index 04c250c..25eac59 100644
--- a/examples/CMakeLists.txt
+++ b/examples/CMakeLists.txt
@@ -18,8 +18,11 @@ celix_subproject(EXAMPLES "Option to enable building the Examples" "OFF" DEPS FR
if (EXAMPLES)
add_subdirectory(hello_world)
add_subdirectory(hello_world_test)
- add_subdirectory(mongoose)
-
+
+ if (NOT ANDROID)
+ add_subdirectory(mongoose)
+ endif()
+
add_subdirectory(whiteboard)
add_subdirectory(echo_service)
add_subdirectory(producer_consumer)
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/examples/deploy.cmake
----------------------------------------------------------------------
diff --git a/examples/deploy.cmake b/examples/deploy.cmake
index 183e8cb..a8d97a1 100644
--- a/examples/deploy.cmake
+++ b/examples/deploy.cmake
@@ -25,5 +25,7 @@ if (EXAMPLES)
deploy("wb_dp" BUNDLES tracker_depman publisherA publisherB shell shell_tui log_service log_writer)
deploy("echo" BUNDLES echo_server echo_client shell shell_tui)
deploy("producer_consumer" BUNDLES producer consumer database shell shell_tui)
- deploy("mongoose" BUNDLES shell shell_tui log_service apache_celix_examples_mongoose)
-endif (EXAMPLES)
\ No newline at end of file
+ if (NOT ANDROID)
+ deploy("mongoose" BUNDLES shell shell_tui log_service apache_celix_examples_mongoose)
+ endif ()
+endif (EXAMPLES)
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/framework/private/src/framework.c
----------------------------------------------------------------------
diff --git a/framework/private/src/framework.c b/framework/private/src/framework.c
index 3f49cdc..f493318 100644
--- a/framework/private/src/framework.c
+++ b/framework/private/src/framework.c
@@ -2073,8 +2073,9 @@ static void *framework_shutdown(void *framework) {
bundle_close(bundle);
}
hashMapIterator_destroy(iter);
-
+#ifndef ANDROID
pthread_cancel(fw->dispatcherThread.thread);
+#endif
celixThread_join(fw->dispatcherThread, NULL);
err = celixThreadMutex_lock(&fw->mutex);
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/remote_services/discovery/private/src/endpoint_discovery_server.c
----------------------------------------------------------------------
diff --git a/remote_services/discovery/private/src/endpoint_discovery_server.c b/remote_services/discovery/private/src/endpoint_discovery_server.c
index e37baa7..930be59 100644
--- a/remote_services/discovery/private/src/endpoint_discovery_server.c
+++ b/remote_services/discovery/private/src/endpoint_discovery_server.c
@@ -27,7 +27,9 @@
#include <string.h>
#include <arpa/inet.h>
#include <netdb.h>
+#ifndef ANDROID
#include <ifaddrs.h>
+#endif
#include "civetweb.h"
#include "celix_errno.h"
#include "utils.h"
@@ -65,7 +67,10 @@ struct endpoint_discovery_server {
// Forward declarations...
static int endpointDiscoveryServer_callback(struct mg_connection *conn);
static char* format_path(char* path);
+
+#ifndef ANDROID
static celix_status_t endpointDiscoveryServer_getIpAdress(char* interface, char** ip);
+#endif
celix_status_t endpointDiscoveryServer_create(discovery_pt discovery, bundle_context_pt context, endpoint_discovery_server_pt *server) {
celix_status_t status;
@@ -93,6 +98,7 @@ celix_status_t endpointDiscoveryServer_create(discovery_pt discovery, bundle_con
}
bundleContext_getProperty(context, DISCOVERY_SERVER_IP, &ip);
+ #ifndef ANDROID
if (ip == NULL) {
char *interface = NULL;
@@ -107,6 +113,7 @@ celix_status_t endpointDiscoveryServer_create(discovery_pt discovery, bundle_con
ip = detectedIp;
}
+ #endif
if (ip != NULL) {
logHelper_log(*(*server)->loghelper, OSGI_LOGSERVICE_INFO, "Using %s for service annunciation", ip);
@@ -391,6 +398,7 @@ static int endpointDiscoveryServer_callback(struct mg_connection* conn) {
return status;
}
+#ifndef ANDROID
static celix_status_t endpointDiscoveryServer_getIpAdress(char* interface, char** ip) {
celix_status_t status = CELIX_BUNDLE_EXCEPTION;
@@ -421,3 +429,4 @@ static celix_status_t endpointDiscoveryServer_getIpAdress(char* interface, char*
return status;
}
+#endif
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/remote_services/discovery_configured/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/remote_services/discovery_configured/CMakeLists.txt b/remote_services/discovery_configured/CMakeLists.txt
index 9c0bcc1..9b8fa09 100644
--- a/remote_services/discovery_configured/CMakeLists.txt
+++ b/remote_services/discovery_configured/CMakeLists.txt
@@ -36,17 +36,17 @@ if (RSA_DISCOVERY_CONFIGURED)
SET_HEADERS("Bundle-Name: Apache Celix RSA Configured Discovery")
bundle(discovery_configured SOURCES
- private/src/discovery_impl.c
- ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/discovery_activator.c
- ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/discovery.c
- ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_descriptor_reader.c
- ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_descriptor_writer.c
- ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_discovery_poller.c
- ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_discovery_server.c
- ${PROJECT_SOURCE_DIR}/remote_services/remote_service_admin/private/src/endpoint_description.c
- ${PROJECT_SOURCE_DIR}/remote_services/utils/private/src/civetweb.c
+ private/src/discovery_impl.c
+ ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/discovery_activator.c
+ ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/discovery.c
+ ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_descriptor_reader.c
+ ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_descriptor_writer.c
+ ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_discovery_poller.c
+ ${PROJECT_SOURCE_DIR}/remote_services/discovery/private/src/endpoint_discovery_server.c
+ ${PROJECT_SOURCE_DIR}/remote_services/remote_service_admin/private/src/endpoint_description.c
+ ${PROJECT_SOURCE_DIR}/remote_services/utils/private/src/civetweb.c
- ${PROJECT_SOURCE_DIR}/log_service/public/src/log_helper.c
+ ${PROJECT_SOURCE_DIR}/log_service/public/src/log_helper.c
)
install_bundle(discovery_configured)
@@ -68,4 +68,4 @@ if (RSA_DISCOVERY_CONFIGURED)
target_link_libraries(descwriter ${LIBXML2_LIBRARIES} celix_framework celix_utils)
endif(RSA_ENDPOINT_TEST_WRITER)
-endif (RSA_DISCOVERY_CONFIGURED)
\ No newline at end of file
+endif (RSA_DISCOVERY_CONFIGURED)
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/remote_services/remote_service_admin_http/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/remote_services/remote_service_admin_http/CMakeLists.txt b/remote_services/remote_service_admin_http/CMakeLists.txt
index 44b4c8d..f066407 100644
--- a/remote_services/remote_service_admin_http/CMakeLists.txt
+++ b/remote_services/remote_service_admin_http/CMakeLists.txt
@@ -17,8 +17,10 @@
celix_subproject(RSA_REMOTE_SERVICE_ADMIN_HTTP "Option to enable building the Remote Service Admin Service HTTP bundle" OFF)
if (RSA_REMOTE_SERVICE_ADMIN_HTTP)
find_package(CURL REQUIRED)
+ find_package(UUID REQUIRED)
include_directories(${CURL_INCLUDE_DIRS})
+ include_directories(${UUID_INCLUDE_DIR})
include_directories("${PROJECT_SOURCE_DIR}/utils/public/include")
include_directories("${PROJECT_SOURCE_DIR}/log_service/public/include")
include_directories("${PROJECT_SOURCE_DIR}/remote_services/utils/private/include")
@@ -43,5 +45,5 @@ if (RSA_REMOTE_SERVICE_ADMIN_HTTP)
install_bundle(remote_service_admin_http)
- target_link_libraries(remote_service_admin_http celix_framework ${CURL_LIBRARIES})
-endif (RSA_REMOTE_SERVICE_ADMIN_HTTP)
\ No newline at end of file
+ target_link_libraries(remote_service_admin_http celix_framework ${CURL_LIBRARIES} ${UUID})
+endif (RSA_REMOTE_SERVICE_ADMIN_HTTP)
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/remote_services/remote_service_admin_http/private/src/remote_service_admin_impl.c
----------------------------------------------------------------------
diff --git a/remote_services/remote_service_admin_http/private/src/remote_service_admin_impl.c b/remote_services/remote_service_admin_http/private/src/remote_service_admin_impl.c
index 319c849..01b2abb 100644
--- a/remote_services/remote_service_admin_http/private/src/remote_service_admin_impl.c
+++ b/remote_services/remote_service_admin_http/private/src/remote_service_admin_impl.c
@@ -29,7 +29,11 @@
#include <arpa/inet.h>
#include <sys/socket.h>
#include <netdb.h>
+
+#ifndef ANDROID
#include <ifaddrs.h>
+#endif
+
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
@@ -122,6 +126,8 @@ celix_status_t remoteServiceAdmin_create(bundle_context_pt context, remote_servi
}
bundleContext_getProperty(context, "RSA_IP", &ip);
+
+ #ifndef ANDROID
if (ip == NULL) {
char *interface = NULL;
@@ -136,6 +142,7 @@ celix_status_t remoteServiceAdmin_create(bundle_context_pt context, remote_servi
ip = detectedIp;
}
+ #endif
if (ip != NULL) {
logHelper_log((*admin)->loghelper, OSGI_LOGSERVICE_INFO, "RSA: Using %s for service annunciation", ip);
@@ -520,7 +527,7 @@ celix_status_t remoteServiceAdmin_installEndpoint(remote_service_admin_pt admin,
return status;
}
-
+#ifndef ANDROID
static celix_status_t remoteServiceAdmin_getIpAdress(char* interface, char** ip) {
celix_status_t status = CELIX_BUNDLE_EXCEPTION;
@@ -551,6 +558,7 @@ static celix_status_t remoteServiceAdmin_getIpAdress(char* interface, char** ip)
return status;
}
+#endif
celix_status_t remoteServiceAdmin_createEndpointDescription(remote_service_admin_pt admin, service_reference_pt reference,
http://git-wip-us.apache.org/repos/asf/celix/blob/654f4252/remote_services/utils/private/include/civetweb.h
----------------------------------------------------------------------
diff --git a/remote_services/utils/private/include/civetweb.h b/remote_services/utils/private/include/civetweb.h
index 90e9964..61a8e98 100644
--- a/remote_services/utils/private/include/civetweb.h
+++ b/remote_services/utils/private/include/civetweb.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2013-2015 the Civetweb developers
+/* Copyright (c) 2013-2014 the Civetweb developers
* Copyright (c) 2004-2013 Sergey Lyubka
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -23,22 +23,22 @@
#ifndef CIVETWEB_HEADER_INCLUDED
#define CIVETWEB_HEADER_INCLUDED
+#ifndef CIVETWEB_VERSION
#define CIVETWEB_VERSION "1.7"
+#endif
#ifndef CIVETWEB_API
-#if defined(_WIN32)
-#if defined(CIVETWEB_DLL_EXPORTS)
-#define CIVETWEB_API __declspec(dllexport)
-#elif defined(CIVETWEB_DLL_IMPORTS)
-#define CIVETWEB_API __declspec(dllimport)
-#else
-#define CIVETWEB_API
-#endif
-#elif __GNUC__ >= 4
-#define CIVETWEB_API __attribute__((visibility ("default")))
-#else
-#define CIVETWEB_API
-#endif
+ #if defined(_WIN32)
+ #if defined(CIVETWEB_DLL_EXPORTS)
+ #define CIVETWEB_API __declspec(dllexport)
+ #elif defined(CIVETWEB_DLL_IMPORTS)
+ #define CIVETWEB_API __declspec(dllimport)
+ #else
+ #define CIVETWEB_API
+ #endif
+ #else
+ #define CIVETWEB_API
+ #endif
#endif
#include <stdio.h>
@@ -48,152 +48,145 @@
extern "C" {
#endif /* __cplusplus */
-struct mg_context; /* Handle for the HTTP service itself */
-struct mg_connection; /* Handle for the individual connection */
+struct mg_context; /* Handle for the HTTP service itself */
+struct mg_connection; /* Handle for the individual connection */
+
/* This structure contains information about the HTTP request. */
struct mg_request_info {
- const char *request_method; /* "GET", "POST", etc */
- const char *uri; /* URL-decoded URI */
- const char *http_version; /* E.g. "1.0", "1.1" */
- const char *query_string; /* URL part after '?', not including '?', or
- NULL */
- const char *remote_user; /* Authenticated user, or NULL if no auth
- used */
- char remote_addr[48]; /* Client's IP address as a string. */
- long remote_ip; /* Client's IP address. Deprecated: use remote_addr instead
- */
-
- long long content_length; /* Length (in bytes) of the request body,
- can be -1 if no length was given. */
- int remote_port; /* Client's port */
- int is_ssl; /* 1 if SSL-ed, 0 if not */
- void *user_data; /* User data pointer passed to mg_start() */
- void *conn_data; /* Connection-specific user data */
-
- int num_headers; /* Number of HTTP headers */
- struct mg_header {
- const char *name; /* HTTP header name */
- const char *value; /* HTTP header value */
- } http_headers[64]; /* Maximum 64 headers */
+ const char *request_method; /* "GET", "POST", etc */
+ const char *uri; /* URL-decoded URI */
+ const char *http_version; /* E.g. "1.0", "1.1" */
+ const char *query_string; /* URL part after '?', not including '?', or
+ NULL */
+ const char *remote_user; /* Authenticated user, or NULL if no auth
+ used */
+ char remote_addr[48]; /* Client's IP address as a string. */
+ long remote_ip; /* Client's IP address. Deprecated: use remote_addr instead */
+
+ long long content_length; /* Length (in bytes) of the request body,
+ can be -1 if no length was given. */
+ int remote_port; /* Client's port */
+ int is_ssl; /* 1 if SSL-ed, 0 if not */
+ void *user_data; /* User data pointer passed to mg_start() */
+ void *conn_data; /* Connection-specific user data */
+
+ int num_headers; /* Number of HTTP headers */
+ struct mg_header {
+ const char *name; /* HTTP header name */
+ const char *value; /* HTTP header value */
+ } http_headers[64]; /* Maximum 64 headers */
};
+
/* This structure needs to be passed to mg_start(), to let civetweb know
which callbacks to invoke. For a detailed description, see
https://github.com/bel2125/civetweb/blob/master/docs/UserManual.md */
struct mg_callbacks {
- /* Called when civetweb has received new HTTP request.
- If the callback returns one, it must process the request
- by sending valid HTTP headers and a body. Civetweb will not do
- any further processing. Otherwise it must return zero.
- Note that since V1.7 the "begin_request" function is called
- before an authorization check. If an authorization check is
- required, use a request_handler instead.
- Return value:
- 0: civetweb will process the request itself. In this case,
- the callback must not send any data to the client.
- 1: callback already processed the request. Civetweb will
- not send any data after the callback returned. */
- int (*begin_request)(struct mg_connection *);
-
- /* Called when civetweb has finished processing request. */
- void (*end_request)(const struct mg_connection *, int reply_status_code);
-
- /* Called when civetweb is about to log a message. If callback returns
- non-zero, civetweb does not log anything. */
- int (*log_message)(const struct mg_connection *, const char *message);
-
- /* Called when civetweb is about to log access. If callback returns
- non-zero, civetweb does not log anything. */
- int (*log_access)(const struct mg_connection *, const char *message);
-
- /* Called when civetweb initializes SSL library.
- Parameters:
- user_data: parameter user_data passed when starting the server.
- Return value:
- 0: civetweb will set up the SSL certificate.
- 1: civetweb assumes the callback already set up the certificate.
- -1: initializing ssl fails. */
- int (*init_ssl)(void *ssl_context, void *user_data);
-
- /* Called when websocket request is received, before websocket handshake.
- Return value:
- 0: civetweb proceeds with websocket handshake.
- 1: connection is closed immediately.
- This callback is deprecated, use mg_set_websocket_handler instead. */
- int (*websocket_connect)(const struct mg_connection *);
-
- /* Called when websocket handshake is successfully completed, and
- connection is ready for data exchange.
- This callback is deprecated, use mg_set_websocket_handler instead. */
- void (*websocket_ready)(struct mg_connection *);
-
- /* Called when data frame has been received from the client.
- Parameters:
- bits: first byte of the websocket frame, see websocket RFC at
- http://tools.ietf.org/html/rfc6455, section 5.2
- data, data_len: payload, with mask (if any) already applied.
- Return value:
- 1: keep this websocket connection open.
- 0: close this websocket connection.
- This callback is deprecated, use mg_set_websocket_handler instead. */
- int (*websocket_data)(struct mg_connection *, int bits, char *data,
- size_t data_len);
-
- /* Called when civetweb is closing a connection. The per-context mutex is
- locked when this is invoked. This is primarily useful for noting when
- a websocket is closing and removing it from any application-maintained
- list of clients.
- Using this callback for websocket connections is deprecated, use
- mg_set_websocket_handler instead. */
- void (*connection_close)(const struct mg_connection *);
-
- /* Called when civetweb tries to open a file. Used to intercept file open
- calls, and serve file data from memory instead.
- Parameters:
- path: Full path to the file to open.
- data_len: Placeholder for the file size, if file is served from
- memory.
- Return value:
- NULL: do not serve file from memory, proceed with normal file open.
- non-NULL: pointer to the file contents in memory. data_len must be
- initilized with the size of the memory block. */
- const char *(*open_file)(const struct mg_connection *, const char *path,
- size_t *data_len);
-
- /* Called when civetweb is about to serve Lua server page, if
- Lua support is enabled.
- Parameters:
- lua_context: "lua_State *" pointer. */
- void (*init_lua)(const struct mg_connection *, void *lua_context);
-
- /* Called when civetweb has uploaded a file to a temporary directory as a
- result of mg_upload() call.
- Parameters:
- file_name: full path name to the uploaded file. */
- void (*upload)(struct mg_connection *, const char *file_name);
-
- /* Called when civetweb is about to send HTTP error to the client.
- Implementing this callback allows to create custom error pages.
- Parameters:
- status: HTTP error status code.
- Return value:
- 1: run civetweb error handler.
- 0: callback already handled the error. */
- int (*http_error)(struct mg_connection *, int status);
-
- /* Called after civetweb context has been created, before requests
- are processed.
- Parameters:
- ctx: context handle */
- void (*init_context)(const struct mg_context *ctx);
-
- /* Called when civetweb context is deleted.
- Parameters:
- ctx: context handle */
- void (*exit_context)(const struct mg_context *ctx);
+ /* Called when civetweb has received new HTTP request.
+ If the callback returns one, it must process the request
+ by sending valid HTTP headers and a body. Civetweb will not do
+ any further processing. Otherwise it must return zero.
+ Note that since V1.7 the "begin_request" function is called
+ before an authorization check. If an authorization check is
+ required, use a request_handler instead.
+ Return value:
+ 0: civetweb will process the request itself. In this case,
+ the callback must not send any data to the client.
+ 1: callback already processed the request. Civetweb will
+ not send any data after the callback returned. */
+ int (*begin_request)(struct mg_connection *);
+
+ /* Called when civetweb has finished processing request. */
+ void (*end_request)(const struct mg_connection *, int reply_status_code);
+
+ /* Called when civetweb is about to log a message. If callback returns
+ non-zero, civetweb does not log anything. */
+ int (*log_message)(const struct mg_connection *, const char *message);
+
+ /* Called when civetweb initializes SSL library.
+ Parameters:
+ user_data: parameter user_data passed when starting the server.
+ Return value:
+ 0: civetweb will set up the SSL certificate.
+ 1: civetweb assumes the callback already set up the certificate.
+ -1: initializing ssl fails. */
+ int (*init_ssl)(void *ssl_context, void *user_data);
+
+ /* Called when websocket request is received, before websocket handshake.
+ Return value:
+ 0: civetweb proceeds with websocket handshake.
+ 1: connection is closed immediately. */
+ int (*websocket_connect)(const struct mg_connection *);
+
+ /* Called when websocket handshake is successfully completed, and
+ connection is ready for data exchange. */
+ void (*websocket_ready)(struct mg_connection *);
+
+ /* Called when data frame has been received from the client.
+ Parameters:
+ bits: first byte of the websocket frame, see websocket RFC at
+ http://tools.ietf.org/html/rfc6455, section 5.2
+ data, data_len: payload, with mask (if any) already applied.
+ Return value:
+ 1: keep this websocket connection open.
+ 0: close this websocket connection. */
+ int (*websocket_data)(struct mg_connection *, int bits,
+ char *data, size_t data_len);
+
+ /* Called when civetweb is closing a connection. The per-context mutex is
+ locked when this is invoked. This is primarily useful for noting when
+ a websocket is closing and removing it from any application-maintained
+ list of clients. */
+ void (*connection_close)(struct mg_connection *);
+
+ /* Called when civetweb tries to open a file. Used to intercept file open
+ calls, and serve file data from memory instead.
+ Parameters:
+ path: Full path to the file to open.
+ data_len: Placeholder for the file size, if file is served from
+ memory.
+ Return value:
+ NULL: do not serve file from memory, proceed with normal file open.
+ non-NULL: pointer to the file contents in memory. data_len must be
+ initilized with the size of the memory block. */
+ const char * (*open_file)(const struct mg_connection *,
+ const char *path, size_t *data_len);
+
+ /* Called when civetweb is about to serve Lua server page, if
+ Lua support is enabled.
+ Parameters:
+ lua_context: "lua_State *" pointer. */
+ void (*init_lua)(struct mg_connection *, void *lua_context);
+
+ /* Called when civetweb has uploaded a file to a temporary directory as a
+ result of mg_upload() call.
+ Parameters:
+ file_name: full path name to the uploaded file. */
+ void (*upload)(struct mg_connection *, const char *file_name);
+
+ /* Called when civetweb is about to send HTTP error to the client.
+ Implementing this callback allows to create custom error pages.
+ Parameters:
+ status: HTTP error status code.
+ Return value:
+ 1: run civetweb error handler.
+ 0: callback already handled the error. */
+ int (*http_error)(struct mg_connection *, int status);
+
+ /* Called after civetweb context has been created, before requests
+ are processed.
+ Parameters:
+ ctx: context handle */
+ void (*init_context)(struct mg_context * ctx);
+
+ /* Called when civetweb context is deleted.
+ Parameters:
+ ctx: context handle */
+ void (*exit_context)(struct mg_context * ctx);
};
+
/* Start web server.
Parameters:
@@ -220,8 +213,9 @@ struct mg_callbacks {
Return:
web server context, or NULL on error. */
CIVETWEB_API struct mg_context *mg_start(const struct mg_callbacks *callbacks,
- void *user_data,
- const char **configuration_options);
+ void *user_data,
+ const char **configuration_options);
+
/* Stop the web server.
@@ -230,6 +224,7 @@ CIVETWEB_API struct mg_context *mg_start(const struct mg_callbacks *callbacks,
threads are stopped. Context pointer becomes invalid. */
CIVETWEB_API void mg_stop(struct mg_context *);
+
/* mg_request_handler
Called when a new request comes in. This callback is URI based
@@ -241,12 +236,12 @@ CIVETWEB_API void mg_stop(struct mg_context *);
Returns:
0: the handler could not handle the request, so fall through.
1: the handler processed the request. */
-typedef int (*mg_request_handler)(struct mg_connection *conn, void *cbdata);
+typedef int (* mg_request_handler)(struct mg_connection *conn, void *cbdata);
+
/* mg_set_request_handler
Sets or removes a URI mapping for a request handler.
- This function uses mg_lock_context internally.
URI's are ordered and prefixed URI's are supported. For example,
consider two URIs: /a/b and /a
@@ -256,63 +251,12 @@ typedef int (*mg_request_handler)(struct mg_connection *conn, void *cbdata);
Parameters:
ctx: server context
- uri: the URI (exact or pattern) for the handler
+ uri: the URI to configure
handler: the callback handler to use when the URI is requested.
- If NULL, an already registered handler for this URI will be
- removed.
- The URI used to remove a handler must match exactly the one used
- to
- register it (not only a pattern match).
- cbdata: the callback data to give to the handler when it is called. */
-CIVETWEB_API void mg_set_request_handler(struct mg_context *ctx,
- const char *uri,
- mg_request_handler handler,
- void *cbdata);
-
-/* Callback types for websocket handlers in C/C++.
-
- mg_websocket_connect_handler
- Is called when the client intends to establish a websocket connection,
- before websocket handshake.
- Return value:
- 0: civetweb proceeds with websocket handshake.
- 1: connection is closed immediately.
+ If NULL, the URI will be removed.
+ cbdata: the callback data to give to the handler when it s requested. */
+CIVETWEB_API void mg_set_request_handler(struct mg_context *ctx, const char *uri, mg_request_handler handler, void *cbdata);
- mg_websocket_ready_handler
- Is called when websocket handshake is successfully completed, and
- connection is ready for data exchange.
-
- mg_websocket_data_handler
- Is called when a data frame has been received from the client.
- Parameters:
- bits: first byte of the websocket frame, see websocket RFC at
- http://tools.ietf.org/html/rfc6455, section 5.2
- data, data_len: payload, with mask (if any) already applied.
- Return value:
- 1: keep this websocket connection open.
- 0: close this websocket connection.
-
- mg_connection_close_handler
- Is called, when the connection is closed.*/
-typedef int (*mg_websocket_connect_handler)(const struct mg_connection *,
- void *);
-typedef void (*mg_websocket_ready_handler)(struct mg_connection *, void *);
-typedef int (*mg_websocket_data_handler)(struct mg_connection *, int, char *,
- size_t, void *);
-typedef void (*mg_websocket_close_handler)(const struct mg_connection *,
- void *);
-
-/* mg_set_websocket_handler
-
- Set or remove handler functions for websocket connections.
- This function works similar to mg_set_request_handler - see there. */
-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);
/* Get the value of particular configuration parameter.
The value returned is read-only. Civetweb does not allow changing
@@ -320,23 +264,16 @@ mg_set_websocket_handler(struct mg_context *ctx, const char *uri,
If given parameter name is not valid, NULL is returned. For valid
names, return value is guaranteed to be non-NULL. If parameter is not
set, zero-length string is returned. */
-CIVETWEB_API const char *mg_get_option(const struct mg_context *ctx,
- const char *name);
+CIVETWEB_API const char *mg_get_option(const struct mg_context *ctx, const char *name);
+
/* Get context from connection. */
-CIVETWEB_API struct mg_context *
-mg_get_context(const struct mg_connection *conn);
+CIVETWEB_API struct mg_context *mg_get_context(struct mg_connection *conn);
-/* Get user data passed to mg_start from context. */
-CIVETWEB_API void *mg_get_user_data(const struct mg_context *ctx);
-/* Set user data for the current connection. */
-CIVETWEB_API void mg_set_user_connection_data(const struct mg_connection *conn,
- void *data);
+/* Get user data passed to mg_start from context. */
+CIVETWEB_API void *mg_get_user_data(struct mg_context *ctx);
-/* Get user data set for the current connection. */
-CIVETWEB_API void *
-mg_get_user_connection_data(const struct mg_connection *conn);
#if defined(MG_LEGACY_INTERFACE)
/* Return array of strings that represent valid configuration options.
@@ -347,27 +284,30 @@ mg_get_user_connection_data(const struct mg_connection *conn);
CIVETWEB_API const char **mg_get_valid_option_names(void);
#endif
+
struct mg_option {
- const char *name;
- int type;
- const char *default_value;
+ const char * name;
+ int type;
+ const char * default_value;
};
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
+ 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
};
+
/* Return array of struct mg_option, representing all valid configuration
options of civetweb.c.
The array is terminated by a NULL name option. */
CIVETWEB_API const struct mg_option *mg_get_valid_options(void);
+
/* Get the list of ports that civetweb is listening on.
size is the size of the ports int array and ssl int array to fill.
It is the caller's responsibility to make sure ports and ssl each
@@ -375,8 +315,8 @@ CIVETWEB_API const struct mg_option *mg_get_valid_options(void);
Return value is the number of ports and ssl information filled in.
The value returned is read-only. Civetweb does not allow changing
configuration at run time. */
-CIVETWEB_API size_t
-mg_get_ports(const struct mg_context *ctx, size_t size, int *ports, int *ssl);
+CIVETWEB_API size_t mg_get_ports(const struct mg_context *ctx, size_t size, int* ports, int* ssl);
+
/* Add, edit or delete the entry in the passwords file.
@@ -391,12 +331,14 @@ mg_get_ports(const struct mg_context *ctx, size_t size, int *ports, int *ssl);
Return:
1 on success, 0 on error. */
CIVETWEB_API int mg_modify_passwords_file(const char *passwords_file_name,
- const char *domain, const char *user,
+ const char *domain,
+ const char *user,
const char *password);
+
/* Return information associated with the request. */
-CIVETWEB_API const struct mg_request_info *
-mg_get_request_info(const struct mg_connection *);
+CIVETWEB_API struct mg_request_info *mg_get_request_info(struct mg_connection *);
+
/* Send data to the client.
Return:
@@ -405,10 +347,11 @@ mg_get_request_info(const struct mg_connection *);
>0 number of bytes written on success */
CIVETWEB_API int mg_write(struct mg_connection *, const void *buf, size_t len);
-/* Send data to a websocket client wrapped in a websocket frame. Uses
- mg_lock_connection to ensure that the transmission is not interrupted,
- i.e., when the application is proactively communicating and responding to
- a request simultaneously.
+
+/* Send data to a websocket client wrapped in a websocket frame. Uses mg_lock
+ to ensure that the transmission is not interrupted, i.e., when the
+ application is proactively communicating and responding to a request
+ simultaneously.
Send data to a websocket client wrapped in a websocket frame.
This function is available when civetweb is compiled with -DUSE_WEBSOCKET
@@ -417,38 +360,41 @@ CIVETWEB_API int mg_write(struct mg_connection *, const void *buf, size_t len);
0 when the connection has been closed
-1 on error
>0 number of bytes written on success */
-CIVETWEB_API int mg_websocket_write(struct mg_connection *conn, int opcode,
+CIVETWEB_API int mg_websocket_write(struct mg_connection* conn, int opcode,
const char *data, size_t data_len);
+
/* Blocks until unique access is obtained to this connection. Intended for use
with websockets only.
Invoke this before mg_write or mg_printf when communicating with a
websocket if your code has server-initiated communication as well as
communication in direct response to a message. */
-CIVETWEB_API void mg_lock_connection(struct mg_connection *conn);
-CIVETWEB_API void mg_unlock_connection(struct mg_connection *conn);
+CIVETWEB_API void mg_lock_connection(struct mg_connection* conn);
+CIVETWEB_API void mg_unlock_connection(struct mg_connection* conn);
#if defined(MG_LEGACY_INTERFACE)
#define mg_lock mg_lock_connection
#define mg_unlock mg_unlock_connection
#endif
-/* Lock server context. This lock may be used to protect resources
+/* Lock server context. This lock may be used to protect ressources
that are shared between different connection/worker threads. */
-CIVETWEB_API void mg_lock_context(struct mg_context *ctx);
-CIVETWEB_API void mg_unlock_context(struct mg_context *ctx);
+CIVETWEB_API void mg_lock_context(struct mg_context* ctx);
+CIVETWEB_API void mg_unlock_context(struct mg_context* ctx);
+
/* Opcodes, from http://tools.ietf.org/html/rfc6455 */
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
+ 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
};
-/* Macros for enabling compiler-specific checks for printf-like arguments. */
+
+/* Macros for enabling compiler-specific checks forprintf-like arguments. */
#undef PRINTF_FORMAT_STRING
#if defined(_MSC_VER) && _MSC_VER >= 1400
#include <sal.h>
@@ -467,15 +413,16 @@ enum {
#define PRINTF_ARGS(x, y)
#endif
-/* Send data to the client using printf() semantics.
+/* Send data to the client usingprintf() semantics.
Works exactly like mg_write(), but allows to do message formatting. */
CIVETWEB_API int mg_printf(struct mg_connection *,
- PRINTF_FORMAT_STRING(const char *fmt), ...)
- PRINTF_ARGS(2, 3);
+ PRINTF_FORMAT_STRING(const char *fmt), ...) PRINTF_ARGS(2, 3);
+
/* Send contents of the entire file together with HTTP headers. */
CIVETWEB_API void mg_send_file(struct mg_connection *conn, const char *path);
+
/* Read data from the remote end, return number of bytes read.
Return:
0 connection has been closed by peer. No more data could be read.
@@ -483,13 +430,14 @@ CIVETWEB_API void mg_send_file(struct mg_connection *conn, const char *path);
> 0 number of bytes read into the buffer. */
CIVETWEB_API int mg_read(struct mg_connection *, void *buf, size_t len);
+
/* Get the value of particular HTTP header.
This is a helper function. It traverses request_info->http_headers array,
and if the header is present in the array, returns its value. If it is
not present, NULL is returned. */
-CIVETWEB_API const char *mg_get_header(const struct mg_connection *,
- const char *name);
+CIVETWEB_API const char *mg_get_header(const struct mg_connection *, const char *name);
+
/* Get a value of particular form variable.
@@ -513,6 +461,7 @@ CIVETWEB_API const char *mg_get_header(const struct mg_connection *,
CIVETWEB_API int mg_get_var(const char *data, size_t data_len,
const char *var_name, char *dst, size_t dst_len);
+
/* Get a value of particular form variable.
Parameters:
@@ -537,8 +486,8 @@ CIVETWEB_API int mg_get_var(const char *data, size_t data_len,
Destination buffer is guaranteed to be '\0' - terminated if it is not
NULL or zero length. */
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);
+ const char *var_name, char *dst, size_t dst_len, size_t occurrence);
+
/* Fetch value of certain cookie variable into the destination buffer.
@@ -556,6 +505,7 @@ CIVETWEB_API int mg_get_var2(const char *data, size_t data_len,
CIVETWEB_API int mg_get_cookie(const char *cookie, const char *var_name,
char *buf, size_t buf_len);
+
/* Download data from the remote web server.
host: host name to connect to, e.g. "foo.com", or "10.12.40.1".
port: port number, e.g. 80.
@@ -571,33 +521,37 @@ CIVETWEB_API int mg_get_cookie(const char *cookie, const char *var_name,
conn = mg_download("google.com", 80, 0, ebuf, sizeof(ebuf),
"%s", "GET / HTTP/1.0\r\nHost: google.com\r\n\r\n");
*/
-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, 7);
+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, 7);
+
/* Close the connection opened by mg_download(). */
CIVETWEB_API void mg_close_connection(struct mg_connection *conn);
+
/* File upload functionality. Each uploaded file gets saved into a temporary
file and MG_UPLOAD event is sent.
Return number of uploaded files. */
-CIVETWEB_API int mg_upload(struct mg_connection *conn,
- const char *destination_dir);
+CIVETWEB_API int mg_upload(struct mg_connection *conn, const char *destination_dir);
+
/* Convenience function -- create detached thread.
Return: 0 on success, non-0 on error. */
-typedef void *(*mg_thread_func_t)(void *);
+typedef void * (*mg_thread_func_t)(void *);
CIVETWEB_API int mg_start_thread(mg_thread_func_t f, void *p);
+
/* Return builtin mime type for the given file name.
For unrecognized extensions, "text/plain" is returned. */
CIVETWEB_API const char *mg_get_builtin_mime_type(const char *file_name);
+
/* Return Civetweb version. */
CIVETWEB_API const char *mg_version(void);
+
/* URL-decode input buffer into destination buffer.
0-terminate the destination buffer.
form-url-encoded data differs from URI encoding in a way that it
@@ -607,11 +561,13 @@ CIVETWEB_API const char *mg_version(void);
CIVETWEB_API int mg_url_decode(const char *src, int src_len, char *dst,
int dst_len, int is_form_url_encoded);
+
/* URL-encode input buffer into destination buffer.
returns the length of the resulting buffer or -1
is the buffer is too small. */
CIVETWEB_API int mg_url_encode(const char *src, char *dst, size_t dst_len);
+
/* MD5 hash given strings.
Buffer 'buf' must be 33 bytes long. Varargs is a NULL terminated list of
ASCIIz strings. When function returns, buf will contain human-readable
@@ -620,6 +576,7 @@ CIVETWEB_API int mg_url_encode(const char *src, char *dst, size_t dst_len);
mg_md5(buf, "aa", "bb", NULL); */
CIVETWEB_API char *mg_md5(char buf[33], ...);
+
/* Print error message to the opened error log stream.
This utilizes the provided logging configuration.
conn: connection
@@ -627,25 +584,22 @@ CIVETWEB_API char *mg_md5(char buf[33], ...);
...: variable argument list
Example:
mg_cry(conn,"i like %s", "logging"); */
-CIVETWEB_API void mg_cry(const struct mg_connection *conn,
- PRINTF_FORMAT_STRING(const char *fmt), ...)
- PRINTF_ARGS(2, 3);
+CIVETWEB_API void mg_cry(struct mg_connection *conn,
+ PRINTF_FORMAT_STRING(const char *fmt), ...) PRINTF_ARGS(2, 3);
+
/* utility method to compare two buffers, case incensitive. */
CIVETWEB_API int mg_strncasecmp(const char *s1, const char *s2, size_t len);
/* Connect to a websocket as a client
Parameters:
- host: host to connect to, i.e. "echo.websocket.org" or "192.168.1.1" or
- "localhost"
+ host: host to connect to, i.e. "echo.websocket.org" or "192.168.1.1" or "localhost"
port: server port
use_ssl: make a secure connection to server
error_buffer, error_buffer_size: buffer for an error message
- path: server path you are trying to connect to, i.e. if connection to
- localhost/app, path should be "/app"
+ path: server path you are trying to connect to, i.e. if connection to localhost/app, path should be "/app"
origin: value of the Origin HTTP header
- data_func: callback that should be used when data is received from the
- server
+ data_func: callback that should be used when data is received from the server
user_data: user supplied argument
Return:
@@ -653,16 +607,20 @@ CIVETWEB_API int mg_strncasecmp(const char *s1, const char *s2, size_t len);
On error, NULL. Se error_buffer for details.
*/
-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);
+typedef int (*websocket_data_func)(struct mg_connection *, int bits,
+ char *data, size_t data_len);
+
+typedef void (*websocket_close_func)(struct mg_connection *);
+
+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,
+ websocket_data_func data_func, websocket_close_func close_func,
+ void * user_data);
/* Connect to a TCP server as a client (can be used to connect to a HTTP server)
Parameters:
- host: host to connect to, i.e. "www.wikipedia.org" or "192.168.1.1" or
- "localhost"
+ host: host to connect to, i.e. "www.wikipedia.org" or "192.168.1.1" or "localhost"
port: server port
use_ssl: make a secure connection to server
error_buffer, error_buffer_size: buffer for an error message
@@ -671,26 +629,26 @@ CIVETWEB_API struct mg_connection *mg_connect_websocket_client(
On success, valid mg_connection object.
On error, NULL. Se error_buffer for details.
*/
-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(const char *host, int port, int use_ssl,
+ char *error_buffer, size_t error_buffer_size);
-enum { TIMEOUT_INFINITE = -1 };
+
+enum {
+ TIMEOUT_INFINITE = -1
+};
/* Wait for a response from the server
Parameters:
conn: connection
ebuf, ebuf_len: error message placeholder.
- timeout: time to wait for a response in milliseconds (if < 0 then wait
- forever)
+ timeout: time to wait for a response in milliseconds (if < 0 then wait forever)
Return:
On success, >= 0
On error/timeout, < 0
*/
-CIVETWEB_API int mg_get_response(struct mg_connection *conn, char *ebuf,
- size_t ebuf_len, int timeout);
+CIVETWEB_API int mg_get_response(struct mg_connection *conn, char *ebuf, size_t ebuf_len, int timeout);
+
#ifdef __cplusplus
}