api-v3: First draft

[src/app-framework-binder.git] / src / afb-config.h

diff --git a/src/afb-config.h b/src/afb-config.h
index 89b1f78..30fd398 100644 (file)
--- a/src/afb-config.h
+++ b/src/afb-config.h
@@ -22,22 +22,27 @@ struct json_object;
  * other definitions ---------------------------------------------------
  */
 
+/**
+ * list of configuration values
+ */
 struct afb_config_list {
        struct afb_config_list *next;
        char *value;
 };
 
-// main config structure
+/**
+ * main config structure
+ */
 struct afb_config {
-       char *console;          // console device name (can be a file or a tty)
-       char *rootdir;          // base dir for files
-       char *roothttp;         // directory for http files
-       char *rootbase;         // Angular HTML5 base URL
-       char *rootapi;          // Base URL for REST APIs
-       char *workdir;          // where to run the program
-       char *uploaddir;        // where to store transient files
-       char *token;            // initial authentication token [default NULL no session]
-       char *name;             /* name to set to the daemon */
+       char *console;          /*< console device name (can be a file or a tty) */
+       char *rootdir;          /*< base dir for files */
+       char *roothttp;         /*< directory for http files */
+       char *rootbase;         /*< Angular HTML5 base URL */
+       char *rootapi;          /*< Base URL for REST APIs */
+       char *workdir;          /*< where to run the program */
+       char *uploaddir;        /*< where to store transient files */
+       char *token;            /*< initial authentication token [default NULL no session] */
+       char *name;             /*< name to set to the daemon */
 
        struct afb_config_list *aliases;
 #if defined(WITH_DBUS_TRANSPARENCY)
@@ -50,32 +55,39 @@ struct afb_config {
        struct afb_config_list *ldpaths;
        struct afb_config_list *weak_ldpaths;
        struct afb_config_list *calls;
+       struct afb_config_list *auto_ws;
+       struct afb_config_list *auto_link;
 
        char **exec;
 
        /* integers */
-       int httpdPort;
-       int cacheTimeout;
-       int apiTimeout;
-       int cntxTimeout;        // Client Session Context timeout
-       int nbSessionMax;       // max count of sessions
+       int http_port;
+       int cache_timeout;
+       int api_timeout;
+       int session_timeout;    /*< session timeout */
+       int max_session_count;  /*< max count of sessions */
 
        /* enums */
+#if defined(KEEP_LEGACY_MODE)
        int mode;               // mode of listening
+#endif
        int tracereq;
+#if !defined(REMOVE_LEGACY_TRACE)
        int traceditf;
        int tracesvc;
+#endif
        int traceevt;
        int traceses;
+       int traceapi;
 
        /* booleans */
-       unsigned no_ldpaths: 1;         /* disable default ldpaths */
-       unsigned noHttpd: 1;
-       unsigned background: 1;         /* run in backround mode */
+       unsigned no_ldpaths: 1;         /**< disable default ldpaths */
+       unsigned no_httpd: 1;
+       unsigned background: 1;         /**< run in backround mode */
+       unsigned random_token: 1;       /**< expects a random token */
 #if defined(WITH_MONITORING_OPTION)
-       unsigned monitoring: 1;         /* activates monitoring */
+       unsigned monitoring: 1;         /**< activates monitoring */
 #endif
-       unsigned random_token: 1;       /* expects a random token */
 };
 
 extern struct afb_config *afb_config_parse_arguments(int argc, char **argv);