Fixes #40 Fixing doxygen documentation

No more errors sent by doxygen

docs/Doxyfile.in

@@ -453,7 +453,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
@@ -690,7 +690,7 @@ SHOW_NAMESPACES        = YES
 # by doxygen. Whatever the program writes to standard output is used as the file
 # version. For an example see the documentation.
 
-FILE_VERSION_FILTER    = @DOXYFILE_FILE_VERSION_FILTER@
+FILE_VERSION_FILTER    = "git log --follow -s -n1 --format='%ai commit:%h' -- "
 
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
 # by doxygen. The layout file controls the global structure of the generated
@@ -2059,7 +2059,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -2067,7 +2067,7 @@ MACRO_EXPANSION        = NO
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_ONLY_PREDEF     = NO
+EXPAND_ONLY_PREDEF     = YES
 
 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
 # INCLUDE_PATH will be searched if a #include is found.
@@ -2099,7 +2099,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = 
+PREDEFINED             = __attribute__(x)=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

docs/man/man1/pyfcgi.1

@@ -1,18 +1,16 @@
-.TH "pyfcgi" 1 "Mon Oct 28 2019" "Version 0.0.1" "PyFCGI" \" -*- nroff -*-
+.TH "pyfcgi" 1 "Wed Dec 18 2019" "Version 0.0.1" "PyFCGI" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
 pyfcgi \- Python Fast CGI runner
 .SH "SYNOPSIS"
 .PP
-spawn-fcgi [OPTS] -- pyfcgi [OPTIONS] 
+pyfcgi [OPTIONS] 
 .SH "DESCRIPTION"
 .PP
 Run WSGI python application in a pool of worker\&.
 .SH "OPTIONS"
 .PP
-.SS "spawn-fcgi OPTIONS"
-OPTS are \fBspawn-fcgi(1)\fP options\&.
 .SS "General OPTIONS"
 \fB-h --help\fP
 .RS 4
@@ -139,11 +137,11 @@ unix with HOST a valid PATH
 .PP
 To run foo_pep333\&.entrypoint() PEP333 application :
 .PP
-spawn-fcgi -d \&. -n -p 9000 -a 127\&.0\&.0\&.1 -- src/pyfcgi -S -e foo_pep333 -E entrypoint
+src/pyfcgi -l '127\&.0\&.0\&.1:9000' -S -e foo_pep333 -E entrypoint
 .PP
 Logfile example :
 .PP
-spawn-fcgi -d \&. -n -p 9000 -a 127\&.0\&.0\&.1 -- src/pyfcgi -S -e foo_pep333 -E entrypoint -L '/tmp/foo\&.log;0xff;{datetime} {msg} {ident}'
+src/pyfcgi -l '127\&.0\&.0\&.1:9000' -S -e foo_pep333 -E entrypoint -L '/tmp/foo\&.log;0xff;{datetime} {msg} {ident}'
 .SH "AUTHOR"
 .PP
 Written by Yann Weber <yann.weber@member.fsf.org>
@@ -152,8 +150,5 @@ Written by Yann Weber <yann.weber@member.fsf.org>
 Copyright @ 2019 Yann Weber License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licences/gpl.html>\&.
 .PP
 This is free software: you are free to change and redistribute it\&. There is NO WARRANTY, to extent permitted by law\&.
-.SH "See Also"
-.PP
-\fBspawn-fcgi(1)\fP
 .PP
 PyFCGI git repositorie <https://git.yannweb.net/yannweb/pyfcgi> 

include/conf.h

@@ -34,22 +34,30 @@
 #include <sys/wait.h>
 
 #include "config.h"
-/**@defgroup conf_internal PYFCGI configuration handling
+/**@file conf.h 
+ * @brief PyFCGI configuration handling headers
+ * @ingroup conf_internal */
+
+/**@defgroup conf_internal PyFCGI configuration handling
+ * @brief Informations about PyFCGI configuration handling
  */
+
 /**@defgroup conf_glob PYFCGI global (for all process) configurations
  * @see struct_pyfcgi_conf_s
  * @ingroup conf_internal */
 
-/**@brief Friendly name for @ref struct pyfcgi_conf_s
- * @see struct pyfcgi_conf_s */
+/**@brief Friendly name for @ref pyfcgi_conf_s
+ * @see struct pyfcgi_conf_s
+ * @ingroup conf_internal */
 typedef struct pyfcgi_conf_s pyfcgi_conf_t;
 typedef struct pyfcgi_conf_logger_s pyfcgi_conf_logger_t;
 typedef struct pyfcgi_context_s pyfcgi_context_t;
 typedef struct pyfcgi_semdata_s pyfcgi_semdata_t;
 typedef struct pyfcgi_shmdata_s pyfcgi_shmdata_t;
 
-/**@brief Configuration globals, inherited from parent to childs
+/**@brief Configuration globals, inherited from parent process to childs
  * @ingroup conf_internal
+ * @see pyfcgi_conf_s
  */
 pyfcgi_conf_t PyFCGI_conf;
 
@@ -60,6 +68,8 @@ pyfcgi_conf_t PyFCGI_conf;
 #include "monitor.h"
 
 /**@defgroup ret_status Function & process return status
+ * @brief Constants
+ * @ingroup proc_intern
  */
 /**@ingroup ret_status */
 #define EXIT_PYERR 4
@@ -77,10 +87,13 @@ pyfcgi_conf_t PyFCGI_conf;
 /**@brief Backlog argument for socket creation */
 #define PYFCGI_SOCK_BACKLOG 100
 
-#define PYFCGI_NAME "spawn-fcgi [OPTIONS] -- pyfcgi"
+/**@brief Program name */
+#define PYFCGI_NAME "pyfcgi"
 
+/**@brief Short options specifications */
 #define PYFCGI_SHORT_OPT "C:l:e:E:Aw:W:m:ft:L:SPs:vVh"
 
+/**@brief Long options specifications */
 #define PYFCGI_LONG_OPT { \
 	{"config", required_argument, 0, 'C'},\
 	{"listen", required_argument, 0, 'l'},\
@@ -102,6 +115,10 @@ pyfcgi_conf_t PyFCGI_conf;
 	{0, 0, 0, 0}\
 }
 
+/**@brief Data for help generation
+ *
+ * For each options {HELP_TEXT, ARGS_PLACEOLDER} are specified PLACEOLDER
+ * is NULL for flags*/
 #define PYFCGI_OPT_HELP {\
 	{"Load options from configuration file", "CONFIG"},\
 	{"Listen socket path (a path for UNIX socket or a 'IPV4:PORT' string)", "SOCK_PATH"},\
@@ -218,8 +235,8 @@ struct pyfcgi_context_s {
 
 /**@brief Structure containing configuration
  * @ingroup conf_internal
- * The structure is used for the global @ref pyfcgi_conf variable.
- * @see pyfcgi_conf_t
+ * The structure is used for the global @ref PyFCGI_conf variable.
+ * @see pyfcgi_conf_s
  */
 struct pyfcgi_conf_s
 {
@@ -270,7 +287,7 @@ struct pyfcgi_conf_s
 	/**@brief 0 is silent 1 means logs to stderr */
 	short verbosity;
 	/**@brief Logger configuration
-	 * @ingroupe conf_glob */
+	 * @ingroup conf_glob */
 	pyfcgi_conf_logger_t logs;
 
 	/**@brief Context informations */
@@ -310,29 +327,59 @@ void default_conf();
  * @return 0 if no error */
 int parse_args(int argc, char *argv[]);
 
+/**@brief Check Python entrypoint import
+ *
+ * Forks into a childprocess that will start python and import the entrypoint.
+ * The child process exit status indicate if the import was successfull or not
+ * @return 0 if no errors 1 if import fails
+ */
 int check_entrypoint_import();
 
-int parse_optlog(const char*);
+/**@brief Parse a logger declaration option
+
+ * Expected format is : LOGFILE[;FILTER][;FMT]
+ * @param logspec The logspec option value
+ * @return 0 if no error else 1
+ */
+int parse_optlog(const char* logspec);
+
+/**@defgroup pyfcgi_watchdog PyFCGI watchdogs
+ * @brief Child process watchdogs mecanism
+ *
+ * @ingroup proc_intern
+ */
 
 /**@brief Initialize the watchdog
- * @param void (*wd_sig_cleaner)(int) pointer on a signal handler (or NULL to
- * use @ref pyfcgi_default_sighandler
- * @param const struct timespec* delay a pointer on the watchdog timeout
+ * @ingroup pyfcgi_watchdog
+ * @param wd_sig_cleaner pointer on a signal handler (or NULL to
+ * use @ref pyfcgi_wd_default_sighandler
+ * @param delay a pointer on the watchdog timeout
  * @return 0 if no error else -1
  */
 int pyfcgi_wd_init(void (*wd_sig_cleaner)(int), const struct timespec *delay);
+/**@brief (Re)starts watchdog timer
+ * @ingroup pyfcgi_watchdog
+ *@return 0 if no error else -1 */
 int pyfcgi_wd_arm();
+/**@brief Temporarly disables watchdog
+ * @ingroup pyfcgi_watchdog
+ *@return 0 if no error else -1 */
 int pyfcgi_wd_pause();
+/**@brief Stop and delete a watchdog
+ * @ingroup pyfcgi_watchdog
+ * @return 0 if no error else -1*/
 int pyfcgi_wd_stop();
 
-/**@brief Watchdog default signal handler */
+/**@brief Watchdog default signal handler
+ * @ingroup pyfcgi_watchdog
+ * @param signum signal number*/
 void pyfcgi_wd_default_sighandler(int signum);
 
 /**@brief Return a string representing a status
- * @param int status
+ * @param status Status
  * @return a char* that should be freed
  */
-char *status2str(int);
+char *status2str(int status);
 
 void pyfcgi_sighandler_drop(int signum);
 

include/ipc.h

@@ -17,6 +17,8 @@
  * along with PyFCGI.  If not, see <http://www.gnu.org/licenses/>.
  */
 /**@defgroup IPC Inter process communication mechanism
+ * @brief IPC mechanism
+ * @ingroup proc_intern
  */
 /**@file ipc.h
  * @ingroup IPC */
@@ -68,18 +70,18 @@ typedef unsigned short pyfcgi_ipc_flag_t;
 #include "stats.h" //to get SHM size
 
 /**@brief Set semaphore names using master process PID as uniq key
- * @param pid_t master process PID
+ * @param master_pid master process PID
  */
 void pyfcgi_name_IPC(pid_t master_pid);
 
 /**@brief Do shm_open & sem_open given component indicated by flag
- * @param pyfcgi_ipc_flah_t flag a binary or combination of component flags
+ * @param flag a binary or combination of component flags
  * @return 0 if no error else -1
  * @note Stores the flag in configuration context 
  * @see IPC_flags
  */
 int pyfcgi_IPC_init(pyfcgi_ipc_flag_t flag);
-/**@brief Same than @ref pyfchi_IPC_init but with O_CREAT flag set */
+/**@brief Same than @ref pyfcgi_IPC_init but with O_CREAT flag set */
 int pyfcgi_IPC_create(pyfcgi_ipc_flag_t flag);
 
 /**@brief Close previously opened IPC component (from conf context stored flag)

include/logger.h

@@ -1,7 +1,7 @@
 /*
  * Copyright (C) 2019 Weber Yann
  * 
- * This file is part of PyFCGI.
+ * This file is part mf PyFCGI.
  * 
  * PyFCGI is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -34,15 +34,19 @@
 #include <sys/stat.h>
 
 /**@file logger.h
- * @brief PyFCGI logging facility
+ * @brief PyFCGI logging handling headers
  * @ingroup conf_logger
  */
+
 /**@defgroup conf_logger Logging configuration
+ * @brief Informations about PyFCGI logger configuration
  * @ingroup conf_internal
  * @ingroup logging
  */
 
-/**@defgroup log_facility Logger custom facilities */
+/**@defgroup log_facility Logger custom facilities
+ * @ingroup conf_logger
+ */
 /**@ingroup log_facility */
 #define LOG_GLOBAL 0
 /**@ingroup log_facility */
@@ -58,7 +62,7 @@
 #define PYFCGI_LOGGER_FMT_MAX PYFCGI_LOGGER_MAX
 #define PYFCGI_LOGGER_FIELD_MAX 24
 #define PYFCGI_LOGGER_FMT_PARSE_ERRSZ 64
-/**@brief The size of the @ref struct pyfcgi_logger_format_t.buf allocated to
+/**@brief The size of the @ref pyfcgi_logger_format_t.buf allocated to
  * the message field */
 #define PYFCGI_LOGGER_MSG_BUF_SZ 64
 
@@ -103,35 +107,40 @@
 #define PYFCGI_SYSLOG_LVL(lvl) (((lvl & 0xF0) >> 4)-1)
 
 /**@brief Macro checking if syslog is activated and log a message
- * @params int lvl the PyFCGI log level
- * @param char* fmt the message format
+ * @param lvl the PyFCGI log level
+ * @param fmt the message format
+ * @param ... format arguments
  * @see _vsyslog syslog
  */
-#define _syslog(lvl, ...) if(conf->flags & PYFCGI_LOG_FSYSLOG) { \
-	syslog(PYFCGI_SYSLOG_LVL(lvl), __VA_ARGS__);\
-}
-#define _vsyslog(lvl, fmt, ap) if(conf->flags & PYFCGI_LOG_FSYSLOG) { \
-	vsyslog(PYFCGI_SYSLOG_LVL(lvl), fmt, ap);\
+#define _syslog(lvl, fmt, ...) if(conf->flags & PYFCGI_LOG_FSYSLOG) { \
+	syslog(PYFCGI_SYSLOG_LVL(lvl), fmt,  __VA_ARGS__);\
 }
 
 /**@brief Macro checking if syslog is activated and log a message using PyFCGI
  * loglevels
- * @params int lvl the PyFCGI log level
- * @param char* fmt the message format
+ * @param lvl the PyFCGI log level
+ * @param fmt the message format
+ * @param ap va_list fmt arguments
  * @see vsyslog _syslog
  */
+#define _vsyslog(lvl, fmt, ap) if(conf->flags & PYFCGI_LOG_FSYSLOG) { \
+	vsyslog(PYFCGI_SYSLOG_LVL(lvl), fmt, ap);\
+}
 
 
-/**@defgroup conf_logger_flags Logger confifurations flags
+/**@defgroup conf_logger_flags Logger configurations flags
+ * @brief Constants for logger configuration 
  * @ingroup conf_logger */
-/**@ingroup cong_logger_flags */
+
+/**@brief Indicate if syslog should be used
+ * @ingroup cong_logger_flags */
 #define PYFCGI_LOG_FSYSLOG 1
 /**@brief Indicate if the logger should try to reopen on failure
- * @warn not implemented
+ * @warning not implemented
  * @ingroup cong_logger_flags */
 #define PYFCGI_LOG_FRETRY 2
 /**@brief Exit if failure
- * @warn not implemented
+ * @warning not implemented
  * @ingroup cong_logger_flags */
 #define PYFCGI_LOG_FEXIT_ONFAIL 4
 
@@ -156,7 +165,7 @@ typedef struct strftime_args_s strftime_args_t;
 typedef struct ident_args_s ident_args_t;
 typedef union pyfcgi_logger_field_args pyfcgi_logger_field_args_u;
 
-
+/**@brief Stores log message level's names */
 static const char* PYFCGI_LOGGER_LVLNAME[] __attribute__((unused)) = {
 	" Emerge",
 	"  Alert",
@@ -167,12 +176,19 @@ static const char* PYFCGI_LOGGER_LVLNAME[] __attribute__((unused)) = {
 	"   Info",
 	"  Debug"};
 
+
+/**@brief Stores log message facility's names 
+ * @ingroup log_facility
+ * @see pyfcgi_logger_value_facility */
 static const char* PYFCGI_LOGGER_TYPNAME[] __attribute__((unused)) =
 	{"Global", "Access", "Internal", "Worker", "Master"} ;
 
 
 /**@defgroup conf_logger_format Logline format
+ * @brief Informations about logline format configuration
+ *
  * @ingroup conf_logger
+ *
  * A small description langage allows to describe wanted logline format.
  * A format is a string with special markup indicating fields. Fields markup
  * are surrounded by '{' and '}' chr. This markup can be divided in multiple
@@ -214,18 +230,29 @@ union pyfcgi_logger_field_args
 	ident_args_t ident;
 };
 
-/**@brief Logger format field's type
- * @ingroup conf_logger_format */
+/**@brief Logger field's type
+ * @ingroup conf_logger_format
+ * @see pyfcgi_logger_fmt_field_s
+ */
 enum pyfcgi_logger_field_type
 {
+	/** Null value */
 	pyfcgi_logger_field_null = 0,
+	/** Constant string field */
 	pyfcgi_logger_field_const = -1,
+	/** Datetime field */
 	pyfcgi_logger_field_datetime = 1,
+	/** Loglevel name field */
 	pyfcgi_logger_field_level = 2,
+	/** Log facility name field */
 	pyfcgi_logger_field_facility = 3,
+	/** PID field */
 	pyfcgi_logger_field_pid = 4,
+	/** Parent PID field */
 	pyfcgi_logger_field_ppid = 5,
+	/** Logger identity field */
 	pyfcgi_logger_field_ident = 6,
+	/** Message field */
 	pyfcgi_logger_field_msg = 7,
 };
 
@@ -233,13 +260,17 @@ enum pyfcgi_logger_field_type
  * @ingroup conf_logger_format */
 struct pyfcgi_logger_fmt_field_s
 {
+	/** @brief Field type */
 	pyfcgi_logger_field_type_e type;
 
+	/** @brief Flag indicating if field len is known (may be unused...) */
 	short known_length;
+	/** @brief Field len */
 	size_t len;
 
 	/** @brief pointer on value (interpreted given field type) */
 	void *val;
+	/** @brief Field argument (datetime or ident) */
 	pyfcgi_logger_field_args_u args;
 	/**@brief Points in prefix or sufix buffer */
 	char *buf_ptr;
@@ -267,7 +298,9 @@ struct pyfcgi_logger_format_s
 	/**@brief Message suffix */
 	char *suffix;
 
+	/**@brief Message pointer */
 	char *_msg;
+	/**@brief Message len */
 	size_t _msglen;
 };
 
@@ -276,11 +309,16 @@ struct pyfcgi_logger_format_s
  */
 struct pyfcgi_logger_s
 {
+	/**@brief Logfile name */
 	char *filename;
+	/**@brief Logfile FD */
 	int fd;
+	/**@brief Loglevel mask */
 	logmask_t loglvl;
+	/**@brief Logfacility mask */
 	logmask_t logtyp;
 
+	/**@brief Logline format ID ref @ref pyfcgi_conf_logger_s.formats */
 	size_t fmt_id;
 };
 
@@ -289,27 +327,37 @@ struct pyfcgi_logger_s
  */
 struct pyfcgi_conf_logger_s
 {
-	/**@brief Or combination of @ref PYFCGI_LOG_SYSLOG or
-	 * @ref PYFCGI_LOG_RETRY */
+	/**@brief Or combination of @ref PYFCGI_LOG_FSYSLOG or
+	 * @ref PYFCGI_LOG_FRETRY */
 	short flags;
+	/**@brief Syslog ident string */
 	char *syslog_ident;
+	/**@brief Syslog facility */
 	int syslog_facility;
+	/**@brief Syslog logger minimum loglevel */
 	logmask_t syslog_loglvl;
+	/**@brief Syslog logger PyFCGI facilities */
 	logmask_t syslog_logtyp;
 
 	/**@brief PyFCGI internal ident, prefixes all log messages */
 	char *ident;
+	/**@brief PyFCGI current facility @ref pyfcgi_logger_field_type */
 	logmask_t facility;
 
+	/**@brief List of loggers */
 	pyfcgi_logger_t loggers[PYFCGI_LOGGER_MAX];
+	/**@brief Logger count */
 	unsigned char logger_sz;
 
+	/**@brief List of logger formats */
 	pyfcgi_logger_format_t formats[PYFCGI_LOGGER_MAX];
 	//char **format;
+	/**@brief Logger formats count */
 	unsigned char format_sz;
 
 	/**@brief Buffer for message field formating */
 	char *msg_buf;
+	/**@brief Message buffer len */
 	size_t msg_buf_sz;
 
 	/**@brief Internal pipe to tee(2) the message on loggers (USELESS)*/
@@ -326,80 +374,86 @@ int pyfcgi_logger_init();
 int pyfcgi_logger_stop();
 
 /**@brief Enable syslog logging with given ident
- * @param char* ident if NULL use current ident
+ * @param ident if NULL use current ident
  */
-void pyfcgi_logger_enable_syslog(const char*);
+void pyfcgi_logger_enable_syslog(const char* ident);
 
-/**@brief Stop & free an individual logger */
-void _pyfcgi_logger_free(pyfcgi_logger_t*);
+/**@brief Stop & free an individual logger
+ * @param logger
+ */
+void _pyfcgi_logger_free(pyfcgi_logger_t* logger);
 
 /**@brief Add a new logger
- * @param char* filename or NULL if stderr (fd 2 ) wanted
- * @param logmask_t loglvl a mask indicating wich loglevels should be logged
- * @param logmask_t typemask a mask indicating wich facility should be logged
- * @param char* log format (or NULL for default format)
+ * @param filename or NULL if stderr (fd 2 ) wanted
+ * @param loglvl a mask indicating wich loglevels should be logged
+ * @param logtyp a mask indicating wich facility should be logged
+ * @param format log format (or NULL for default format)
  */
-int pyfcgi_logger_add(const char*, logmask_t, logmask_t, const char*);
+int pyfcgi_logger_add(const char* filename, logmask_t loglvl, logmask_t logtyp,
+	const char* format);
 
 /**@brief Add a new format
- * @param char *format
- * @param size_t* idx if not NULL, will contain the format index
+ * @param format
+ * @param idx if not NULL, will contain the format index
  * @return 0 if OK
  */
-int pyfcgi_logger_format_add(const char*, size_t*);
+int pyfcgi_logger_format_add(const char* format, size_t* idx);
 
 /**@brief Parse a format string and populate corresponding 
- * @ref struct pyfgci_logger_format_s
- * @param const char* fmt string
- * @param pyfcgi_logger_format_t* fmt_data
+ * @ref pyfcgi_logger_format_s
+ * @param fmt_string format string
+ * @param fmt_data
  * @return 0 if no errors
  */
-int pyfcgi_logger_parse_format(const char*, pyfcgi_logger_format_t*);
+int pyfcgi_logger_parse_format(const char* fmt_string,
+	pyfcgi_logger_format_t* fmt_data);
 
 /**@brief Initialize a pyfcgi_logger_format_t.buf attribute (to init the
  * prefix & sufix attributes.
  * @note have to be called when ident is updated
- * @param pyfcgi_logger_format_t* fmt
- * @note called by @ref pyfcgi_logger_add_format but should be called
+ * @param fmt
+ * @note called by @ref pyfcgi_logger_format_add but should be called
  * by @ref pyfcgi_logger_parse_format
  */
-int pyfcgi_logger_format_bufinit(pyfcgi_logger_format_t*);
+int pyfcgi_logger_format_bufinit(pyfcgi_logger_format_t* fmt);
 
 /**@brief Parse a field string and populate corresponding
- * @ret struct pyfcgi_logger_field_s
- * @param const char ** ptr on current format pointer
- * @param char * if not NULL and parse error occurs, this string
+ * @ref pyfcgi_logger_fmt_field_s
+ * @param ptr on current format pointer
+ * @param start if not NULL and parse error occurs, this string
  * will be set
+ * @param cur_field Current field
+ * @param fail_reason stores a parse failure reason on error
  * @return 0 if no errors and 1 if parse error
  */
-int pyfcgi_logger_parse_field(const char**, const char *,
-                              pyfcgi_logger_fmt_field_t*,
-                              char[PYFCGI_LOGGER_FMT_PARSE_ERRSZ]);
+int pyfcgi_logger_parse_field(const char** ptr, const char * start,
+                              pyfcgi_logger_fmt_field_t* cur_field,
+                              char fail_reason[PYFCGI_LOGGER_FMT_PARSE_ERRSZ]);
 
 /**@brief Free allocated memory in given field
- * @param pyfcgi_logger_fmt_field_t* field to free
+ * @param field field to free
  */
-void pyfcgi_logger_field_free(pyfcgi_logger_fmt_field_t*);
+void pyfcgi_logger_field_free(pyfcgi_logger_fmt_field_t* field);
 
 /**@brief Given a field pointer return the size option incrementing
  * ptr
  * @warning do not check if the next character is OK, the caller has to
  * do it
- * @param char** pointer on format
- * @param size_t* size if found will be set to size option. if not found set to
+ * @param ptr pointer on format
+ * @param size if found will be set to size option. if not found set to
  * 0
  * @return 0 if no error
  */
-int pyfcgi_logger_parse_field_sz(const char**, size_t*);
+int pyfcgi_logger_parse_field_sz(const char** ptr, size_t* size);
 
 /**@brief Alloc memory by parsing & strdup the strftime format found
  * in field. If not found use default format
- * @note set the @ref struct pyfcgi_logger_fmt_field_s.args field
- * @param const char** ptr
- * @param char** format
- * @return 
+ * @note set the @ref pyfcgi_logger_fmt_field_s.args field
+ * @param ptr Pointer on current chr
+ * @param format strftime format result
+ * @return 0 or PYFCGI_FATAL
  */
-int pyfcgi_logger_parse_field_dtfmt(const char**, char**);
+int pyfcgi_logger_parse_field_dtfmt(const char** ptr, char** format);
 
 /**@brief Return a str repr of given loglevel
  * @warning returned pointer must NOT be freed or modified
@@ -409,32 +463,42 @@ const char* pyfcgi_logger_value_level(short);
 const char* pyfcgi_logger_value_facility(short);
 
 /**@brief Open a logger
- * @param pyfcgi_logger_t
+ * @param logger The logger to open
  * @return 0 if no errors
  */
-int pyfcgi_logger_open(pyfcgi_logger_t*);
+int pyfcgi_logger_open(pyfcgi_logger_t* logger);
 
 /**@brief Set programm identity for logger
  * @note ident is global to a process
  * @note this function triggers the refresh of the loggers internal
  * buffers if needed (see @ref pyfcgi_logger_format_bufinit() )
- * @param const char* new_ident
+ * @param new_ident new identity
  * @return 0 if no error
  */
-int pyfcgi_logger_set_ident(const char*);
+int pyfcgi_logger_set_ident(const char* new_ident);
 
-/**@brief Format a message using a @ref struct pyfcgi_logger_format_s
+/**@brief Format a message using a @ref pyfcgi_logger_format_s
  * @note alloc and write the logline in the attribute _msg
- * @param pyfcgi_logger_format_t the pyfcgi logger format structure
- * @param loglvl_t the loglevel (see @ref pyfcgi_log() )
- * @param char* message the message sent by user
- * @param size_t len the message len
+ * @param fmt the pyfcgi logger format structure
+ * @param lvl the loglevel (see @ref pyfcgi_log() )
+ * @param message the message sent by user
+ * @param len the message len
  * @return NULL if error
  */
 char* vpyfcgi_logger_format_message(pyfcgi_logger_format_t *fmt,
 	loglvl_t lvl, const char* message, size_t len);
 
-int pyfcgi_log(loglvl_t, const char*, ...);
-int vpyfcgi_log(loglvl_t, const char*, va_list);
+/**@brief Logging function
+ * @param lvl Loglevel
+ * @param fmt Message in printf format
+ * @param ... fmt arguments
+ */
+int pyfcgi_log(loglvl_t lvl, const char* fmt, ...);
+/**@brief Logging function
+ * @param lvl Loglevel
+ * @param fmt Message in printf format
+ * @param ap fmt arguments
+ */
+int vpyfcgi_log(loglvl_t lvl, const char* fmt, va_list ap);
 
 #endif

include/monitor.h

@@ -17,10 +17,20 @@
  * along with PyFCGI.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**@defgroup monitoring Monitoring a running PyFCGI
+/**@defgroup monitor_proc Monitoring process
+ * @brief Collect informations and run a monitoring server providing statistics
+ * @ingroup main_proc
+ */
+/**@defgroup monitoring Monitoring server
+ * @brief A small UDP server for monitoring
  *
  * PyFCGI have the ability to listen on a UDP socket, replying to simple
  * queries (or simple stats).
+ * @ingroup monitor_proc
+ */
+/**@file monitor.h
+ * @brief Monitoring server headers
+ * @ingroup monitoring
  */
 #ifndef _MONITOR__H___
 #define _MONITOR__H___
@@ -86,34 +96,37 @@ void pyfcgi_monitor_stream_loop();
 void pyfcgi_monitor_dgram_loop();
 
 /**@brief Check socket URL validity
- * @param const char* the URL to check
+ * @param sockurl the URL to check
  * @return -1 if error else 0
  * @note Logs error using dprintf(2, ...) because this function will
  * be called when checking configuration
  */
-int pyfcgi_monitor_check_sock(const char*);
+int pyfcgi_monitor_check_sock(const char* sockurl);
 
 /**@brief Parse stored socket URL
- * @param const char* the URL to parse
- * @param int[3] socket creation arguments
- * @param pyfcgi_monitor_addr_t the addr to bind to
+ * @param sockurl the URL to parse
+ * @param sockargs socket creation arguments
+ * @param listen_addr the addr to bind to
  * @return 0 if no error else -1
  * @todo add support for xxx://[IPV6]:port
  */
-int pyfcgi_monitor_parse_sock(const char*, int[3], pyfcgi_monitor_addr_t*);
+int pyfcgi_monitor_parse_sock(const char* sockurl, int sockargs[3],
+	pyfcgi_monitor_addr_t* listen_addr);
 
 /**@brief Parse an addres:port string in a sockaddr_in
- * @param const char* the hostname:port string
- * @param int socket family
- * @param pyfcgi_monitor_addr_t* the addr pointer
- * @param int* if not NULL will be set to choosen domain
+ * @param addr_str the hostname:port string
+ * @param socktype socket family
+ * @param listen_addr the addr pointer
+ * @param domain if not NULL will be set to choosen domain
  * @return 0 if no erro else -1
  * @todo add support for xxx://[IPV6]:port
  */
-int pyfcgi_monitor_parse_inet_addr(const char*, int, pyfcgi_monitor_addr_t*,
-	int*);
+int pyfcgi_monitor_parse_inet_addr(const char* addr_str, int socktype,
+	pyfcgi_monitor_addr_t* listen_addr, int* domain);
 
+/**@brief Monitor process sighandler */
 void pyfcgi_monitor_sighandler(int signum);
+/**@brief Monitor timeout sighandler */
 void pyfcgi_monitor_timeout(int signum);
 
 #endif

include/python_ioin.h

@@ -20,7 +20,7 @@
 /**@defgroup lib_ioin Defines libpyfcgi.IoIn class
  * @brief The IoIn class implement base IO interface allowing python to read
  * HTTP request from FCGI
- * @ingroup libpyfcgo
+ * @ingroup libpyfcgi
  */
 /**@file python_ioin.h
  * @ingroup lib_ioin

include/python_pyfcgi.h

@@ -112,7 +112,7 @@ static inline void libpyfcgi_clean_response()
 void libpyfcgi_send_headers();
 
 /**@brief Send body to fcgi
- * @param PyObject* the body data object (returned by PEP333 app)
+ * @param body_data the body data object (returned by PEP333 app)
  * @return Python None
  */
 PyObject* _pyfcgi_write_body(PyObject *body_data);
@@ -138,26 +138,28 @@ PyMODINIT_FUNC PyInit_libpyfcgi(void);
  * @ingroup libpyfcgi
  * @note This python callable is a fastcall C method of libpyfcgi module.
  * 
- * The python function header is : start_response(status, response_headers, exc_info = None)
- * @param PyObject* self
- * @param PyObject* argv
- * @param Py_ssize_t argc
+ * The python function header is :
+ * start_response(status, response_headers, exc_info = None)
+ * @param self
+ * @param argv
+ * @param argc
  * @return A PyObject* referencing a callable allowing to write data without
  * cache : libpyfcgi.write_body()
  */
-PyObject* pyfcgi_start_response(PyObject*, PyObject**, Py_ssize_t);
+PyObject* pyfcgi_start_response(PyObject* self, PyObject** argv,
+	Py_ssize_t argc);
 
 /**@brief libpyfcgi.write_body() python callable
  * @ingroup libpyfcgi
  * @note This python callable is a fastcall C method of libpyfcgi module.
  *
  * The python function header is : write_body(body_data)
- * @param PyObject* self
- * @param PyObject* argv
- * @param Py_ssize_t argc
+ * @param self
+ * @param argv
+ * @param argc
  * @return ???
  */
-PyObject* pyfcgi_write_body(PyObject*, PyObject**, Py_ssize_t);
+PyObject* pyfcgi_write_body(PyObject* self, PyObject** argv, Py_ssize_t argc);
 
 int _libpyfcgi_stdout_write(const char*, size_t);
 int _libpyfcgi_stderr_write(const char*, size_t);

include/pyutils.h

@@ -45,28 +45,31 @@ void pyinit();
 void update_python_path();
 
 /**@brief Fetch stdout & stderr python flush() function
- * @param PyObject* pystdout_flush
- * @param PyObject* pystderr_flush
+ * @param pystdout_flush will point on &sys.stdout.flush() python function
+ * @param pystderr_flush will point on &sys.stderr.flush() python function
  */
-void fetch_pyflush(PyObject**, PyObject**);
+void fetch_pyflush(PyObject** pystdout_flush, PyObject** pystderr_flush);
 
 /**@brief Create two pipes for stdout & stderr
  * @ingroup worker_process
- * @params int[2] pystdout
- * @params int[2] pystderr
+ * @param pipe_out pipe for stdout
+ * @param pipe_err pipe for stderr
+ * @warning Deprecated behavior. We will us ioin like classes for std & err
+ * output
  */
-void update_python_fd(int[2], int[2]);
+void update_python_fd(int pipe_out[2], int pipe_err[2]);
 
-/**@brief Clear then update python sys.environ using current FCI environ
+/**@brief Clear then update python sys.environ using current FCGI environ
  * @ingroup worker_process
  * @note The environ has to be set without a call to os.putenv, the problem
  * is that the os.environ is a special mapping calling putenv on setitem...
  * For these reason the os.environ will be replaced by a new dict instance for
  * each request...
- * @param PyObject* os module
+ * @param py_osmod Python os module
+ * @param environ The environ string provided by libfcgi
  * @return Python env dict
  */
-PyObject* update_pyenv(PyObject*, char**);
+PyObject* update_pyenv(PyObject* py_osmod, char** environ);
 
 /**@brief Import & return the python entrypoint callable
  * from PyFCGI_conf.py_entrymod & PyFCGI_conf.py_entryfun */
@@ -82,8 +85,8 @@ PyObject* get_start_response();
 void log_expt(int priority);
 
 /**@brief Set python version
- * @param char[16] version buffer */
-void pyfcgi_python_version(char[16]);
+ * @param version version buffer */
+void pyfcgi_python_version(char version[16]);
 
 /**@brief Import os module and exit on error
  * @return Imported module */

include/pyworker.h

@@ -48,7 +48,6 @@
  *
  * @see update_python_path()
  *
- * @ingroup processes
  * @ingroup work_master_proc
  */
 /**@file pyworker.h
@@ -108,24 +107,22 @@ extern PyObject* response_headers;
  * This function handles python worker by running a PEP333 application function.
  * The start_response() function set @ref response_status and
  * @ref response_headers globals.
- * @param char* python_entrypoint a path to a python entrypoint
- * @param int worker uid
+ * @param wrk_id worker id
  * @return 0 if exit avec max requests
  */
-int work333(int);
+int work333(int wrk_id);
 
 /**@brief the function that initialize the alternate python worker
  * @ingroup worker_process
  *
  * This function handles python worker using stdout to communicate with
  * FCGI. This function clones for each request, running worker_piper()
- * @param char* python_entrypoint a path to a python entrypoint
- * @param int worker uid
+ * @param wrk_id worker id
  * @return 0 if exit avec max requests
  */
-int work(int);
+int work(int wrk_id);
 
-/**@brief function for a subprocess designed to read stdin & stdout from
+/*/**@brief function for a subprocess designed to read stdin & stdout from
  * python & forward them to syslog or FCGI
  * @ingroup worker_process
  * @param int worker id
@@ -149,18 +146,18 @@ void worker_piper_sighandler(int);
  * @todo enhance logging : 1 lines per logline + line counter ?
  * @todo sys.stdout & sys.stderr can have an implementation like
  * libpyfcgi.IoIn to avoir useless buffering
- * @param int pipes for stdout
- * @param int pipes for stderr
- * @param PyObject[2] python flush methods
+ * @param pipe_std pipe for stdout
+ * @param pipe_err pipe for stderr
+ * @param flush python flush methods 
  */
-void worker_log_pipes(int, int, PyObject*[2]);
+void worker_log_pipes(int pipe_std, int pipe_err, PyObject* flush[2]);
 
 /**@brief Attempt to read the request size from ctl pipe
- * @param int ctl pipe read fd
- * @param size_t* rep_sz
+ * @param ctl_pipe read fd
+ * @param rep_sz response size
  * @return 0 if no error
  */
-int ctl_get_rep_sz(int, size_t*);
+int ctl_get_rep_sz(int ctl_pipe, size_t* rep_sz);
 
 void worker_sighandler(int);
 void worker_sigalrmhandler(int signum);

include/responder.h

@@ -32,7 +32,6 @@
  * idle. Instead, if the semtimedop returns imediately it means a new worker
  * can be spawned.
  *
- * @ingroup processes
  * @ingroup main_proc
  */
 /**@file responder.h
@@ -67,13 +66,6 @@ pid_t spawn_pool_handler();
 /**@brief The responder loop
  * @ingroup work_master_proc
  * The main function of the fcgi app fork child
- * @param int max_requests : exit normally after this number of requests. If
- * 0 given never exit.
- * @param char* python_entrymodule a python module name
- * @param char* python_entrymodule a python callable name from entry module
- * @param unsigned int max_requests before exiting worker
- * @param unsigned int minimum workers count
- * @param unsigned int maximum wrokers count
  * @return 0 on success
  */
 int responder_loop();
@@ -82,16 +74,16 @@ int responder_loop();
 /**@brief Spawn a worker given an entrypoint
  * @ingroup work_master_proc
  * Spawn a new worker process and prepare ENV & request forwarding
- * @param int worker uid
+ * @param wrk_id worker id
  * @return child PID
  */
-pid_t spawn(int);
+pid_t spawn(int wrk_id);
 
 
 /**@deprecated Not used */
 int pyfcgi_pool_state();
 /**@brief Check if the pool is idle : if not able to timedwait the pool is busy
- * @param const struct timespec timeout
+ * @param timeout
  * @return 1 if busy else 0
  * @note exit on error
  */

include/stats.h

@@ -16,6 +16,10 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with PyFCGI.  If not, see <http://www.gnu.org/licenses/>.
  */
+/**@defgroup stats PyFCGI statistics
+ * @brief Information about statistics collection mechanism
+ * @ingroup monitor_proc
+ */
 /**@file stats.h
  * @ingroup monitoring */
 #ifndef _STATS__H___
@@ -28,7 +32,9 @@
 #include <signal.h>
 #include <string.h>
 
+/**@brief Stats history size (900 = 900s = 15min) */
 #define PYFCGI_STATS_SZ (900)
+/**@brief Signal used to wake up stats server in order to collect stats*/
 #define PYFCGI_STATS_SIGALRM 30
 
 typedef struct pyfcgi_stats_s pyfcgi_stats_t;
@@ -38,7 +44,9 @@ typedef struct pyfcgi_stats_shm_s pyfcgi_stats_shm_t;
 #include "conf.h"
 #include "logger.h"
 
-/**@brief Stores data for stats on 15min (900s) */
+/**@brief Stores data for stats on 15min (900s)
+ * @ingroup stats
+ */
 struct pyfcgi_stats_sample_s
 {
 	/**@brief One sample per seconds */
@@ -47,6 +55,9 @@ struct pyfcgi_stats_sample_s
 	int cur;
 };
 
+/**@brief Stores statistics informations
+ * @ingroup stats
+ */
 struct pyfcgi_stats_s
 {
 	/**@brief Request per seconds on 15 minutes */
@@ -68,9 +79,14 @@ struct pyfcgi_stats_s
 	size_t buff_len;
 };
 
+/**@brief Stores stats information on worker count & load average
+ * @note Data are updated by @ref work_master_proc
+ */
 struct pyfcgi_stats_shm_s
 {
+	/**@brief Workers count */
 	int nworker;
+	/**@brief Load average */
 	int pool_load;
 };
 
@@ -79,13 +95,14 @@ struct pyfcgi_stats_shm_s
  * Set an handler for SIGALRM and set a repeating alarm each seconds
  * @warning designed to be called from monitor server process
  * @return -1 on error else 0
+ * @ingroup stats
  */
 int pyfcgi_stats_init();
 
 /**@brief SIGALRM signal handler
- * @param int signum
+ * @param signum
  */
-void pyfcgi_stats_collector(int);
+void pyfcgi_stats_collector(int signum);
 
 /**@brief Format all stats in a buffer
  * @note uses the pyfcgi_stats.statsbuff buffer */
@@ -97,33 +114,44 @@ size_t pyfcgi_stats_format();
 void pyfcgi_stats_buffprintf(const char *fmt, ...);
 
 /**@brief Allocate the buffer with at least given space
- * @param size_t sz the minimum buffer size
+ * @param sz the minimum buffer size
  * @note allocation size is rounded
  * @return 0 if OK else -1
  */
-int pyfcgi_stats_reqbuff(size_t);
+int pyfcgi_stats_reqbuff(size_t sz);
 
 /**@brief Returns statistics about a 900s ringbuffer
  *
- * @param const int[PYFCGI_STATS_SZ] data : a 900 ringbuffer stats samples
- * @param int* idx_nxt next data index in ring buffer (allow interrupt
+ * @param data a 900 ringbuffer stats samples
+ * @param idx_nxt next data index in ring buffer (allow interrupt
  * detection : when *idx_nxt changes)
- * @param int *last : last sample
- * @param double[4] avgs : average samples on 1, 5, 10 and 15 minutes
+ * @param *last : last sample
+ * @param avgs : average samples on 1, 5, 10 and 15 minutes
  * @return 0 if no error else -1 and set errno to EINTR
  */
-int pyfcgi_stats_avg(const int[PYFCGI_STATS_SZ], int*, int*, double[4]);
+int pyfcgi_stats_avg(const int data[PYFCGI_STATS_SZ], int* idx_nxt, int* last,
+	double avgs[4]);
 /**@brief Same than @ref pyfcgi_stats_avg but normalize average when
  * uptime is bellow 900
  * @see pyfcgi_stats_avg
+ * @param data a 900 ringbuffer stats samples
+ * @param idx_nxt next data index in ring buffer (allow interrupt
+ * detection : when *idx_nxt changes)
+ * @param *last : last sample
+ * @param avgs : average samples on 1, 5, 10 and 15 minutes
+ * @return 0 if no error else -1 and set errno to EINTR
  */
-int pyfcgi_stats_avg_const(const int[PYFCGI_STATS_SZ], int*, int*, double[4]);
+int pyfcgi_stats_avg_const(const int data[PYFCGI_STATS_SZ], int* idx_nxt, int* last,
+	double avgs[4]);
 
 /**@brief Returns the formated buffer
  * @todo make @ref pyfcgi_stats_format() implement this functionnality
  * to remove this function... */
 const char *pyfcgi_stats_buff(const char **, size_t*);
 
+/**@brief Fetch stats informations from dedicated SHM
+ * @see pyfcgi_stats_shm_s
+ */
 int pyfcgi_stats_get_shm(pyfcgi_stats_shm_t*);
 
 #endif

src/main.c

@@ -17,12 +17,16 @@
  * along with PyFCGI.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**@defgroup processes Process organisation of PyFCGI
+/**@defgroup proc_intern Internal process management
+ * @brief Groups all information on internal sub-processes management
+ */
+/**@defgroup processes PyFCGI process hierarchy
  *
  * PyFCGI is organised in three layer : 
  * A @ref main_proc : simple, that keep running and spawn a
  * @ref work_master_proc . This process handles @ref worker_process creation
  * and try to maintain a pool able to reply efficiently to CGI requests.
+ * @ingroup proc_intern
  */
 /**@defgroup main_proc Main process
  * @brief The main process in the @ref main() function
@@ -349,14 +353,11 @@ if ($programname contains 'pyfcgi') then {
 /**@page pyfcgi
  * @brief Python Fast CGI runner
  * @section man_syn SYNOPSIS
- * spawn-fcgi [OPTS] -- pyfcgi [OPTIONS]
+ * pyfcgi [OPTIONS]
  * @section man_desc DESCRIPTION
  * Run WSGI python application in a pool of worker.
  *
  * @section man_opt OPTIONS
- * @subsection man_opt_spawn spawn-fcgi OPTIONS
- * OPTS are @ref spawn-fcgi(1) options.
- *
  * @subsection man_opt_gen General OPTIONS
  * @par -h --help
  * Display help and exit
@@ -430,13 +431,11 @@ if ($programname contains 'pyfcgi') then {
  * @section EXAMPLES 
  * To run foo_pep333.entrypoint() PEP333 application :
  * 
- * spawn-fcgi -d . -n -p 9000 -a 127.0.0.1 -- src/pyfcgi -S
- * -e foo_pep333 -E entrypoint
+ * src/pyfcgi -l '127.0.0.1:9000' -S -e foo_pep333 -E entrypoint
  *
  * Logfile example :
  *
- * spawn-fcgi -d . -n -p 9000 -a 127.0.0.1 -- src/pyfcgi -S
- * -e foo_pep333 -E entrypoint
+ * src/pyfcgi -l '127.0.0.1:9000' -S -e foo_pep333 -E entrypoint
  * -L '/tmp/foo.log;0xff;{datetime} {msg} {ident}'
  *
  * @section AUTHOR
@@ -449,9 +448,6 @@ if ($programname contains 'pyfcgi') then {
  * This is free software: you are free to change and redistribute it.
  * There is NO WARRANTY, to extent permitted by law.
  *
- * @section man_see_also See Also
- * @ref spawn-fcgi(1)
- *
  * PyFCGI git repositorie &lt;https://git.yannweb.net/yannweb/pyfcgi>
  *
  */

src/python_ioin.c

@@ -4,14 +4,15 @@
  */
 
 /**@brief If given object io_stream is NULL set error indicator
+ * @param self The IoIn instance
  * @return 0 if no error else -1 or -2
  */
 static int _check_nullin(PyObject *self);
 
 /**@brief Request a new buffer size.
  * 
- * @param PyObject* self The IoIn instance
- * @param int nreq number of bytes required in buffer
+ * @param self The IoIn instance
+ * @param nreq number of bytes required in buffer
  * @return 0 on error else buffer size
  */
 static int pyfcgi_io__reqbuf(PyObject *self, int nreq);
@@ -698,7 +699,7 @@ static int pyfcgi_io__reqbuf(PyObject *self, int nreq)
 }
 
 /**@brief Concat two bytes/unicode given IoIn configuration flag
- * @warn Py_DECREF both arguments
+ * @warning Py_DECREF both arguments
  */
 static PyObject* IoIn__Concat(PyObject *self, PyObject *left, PyObject *right)
 {

src/pyworker.c

@@ -29,10 +29,10 @@ static inline void worker_set_idle();
 static inline void worker_set_busy();
 
 /**@brief Process results from a pep333 worker
- * @param FCGX_Stream* out stream from libFCGI
- * @param PyObject* application function returned value
+ * @param out out stream from libFCGI
+ * @param ret application function returned value
  */
-static inline int work333_send_result(FCGX_Stream*, PyObject* ret);
+static inline int work333_send_result(FCGX_Stream* out, PyObject* ret);
 
 
 static int worker_piper_sigrcv = 0;