mirror/mongoose
1
0
Fork 0
mirror of https://github.com/cesanta/mongoose.git synced 2024-12-15 09:49:19 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
499a7d6a37
mongoose/docs/c-api/net.h/struct_mg_bind_opts.md
Deomid Ryabkov bafc30bec6 Change from using #ifdef to #if for features tests 
"#if FOO" still works with simple -DFOO, but gives more flexibility.
Specifically, if user expressed no preference (FOO is not defined),
we can apply reasonable defaults (this is the legitimate use of ifdef).

In short, from now on, please use

 #if MG_ENABLE_FOO

instead of

 #ifdef MG_ENABLE_FOO

Since we are all used to #ifdef, this change also adds a precommit check
to police this. Specifically, in *.h and *.c files that are Copyright Cesanta,
"ifdef" and "if defined()" are not allowed to be used with macros that contain
ENABLE or DISABLE, unless the like also contains "ifdef-ok".

Hence, if you are sure you want to use ifdef, use this:

 #ifdef MG_ENABLE_FOO /* ifdef-ok */

PUBLISHED_FROM=9be829448f53cff575d6cae8b9945fb12531c15a
2016-10-13 18:07:25 +00:00

899 B
Raw Blame History

title decl_name symbol_kind signature
struct mg_bind_opts struct mg_bind_opts struct struct mg_bind_opts { void *user_data; /* Initial value for connection's user_data */ unsigned int flags; /* Extra connection flags */ const char **error_string; /* Placeholder for the error string */ #if MG_ENABLE_SSL /* SSL settings. */ const char *ssl_cert; /* Server certificate to present to clients */ const char *ssl_key; /* Private key corresponding to the certificate. If ssl_cert is set but ssl_key is not, ssl_cert is used. */ const char *ssl_ca_cert; /* Verify client certificates with this CA bundle */ #endif };

Optional parameters to mg_bind_opt().

flags is an initial struct mg_connection::flags bitmask to set, see MG_F_* flags definitions.