(no commit message)

[oweals/gnunet.git] / src / include / gnunet_os_lib.h

diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h
index 715061161b4714b238642e1e4fb6dd5dc5e73baf..31062bd403535a4210efbd11dd7c084e89db1460 100644 (file)
--- a/src/include/gnunet_os_lib.h
+++ b/src/include/gnunet_os_lib.h
@@ -135,8 +135,8 @@ enum GNUNET_OS_ProcessStatusType
  * @param dirkind what kind of directory is desired?
  * @return a pointer to the dir path (to be freed by the caller)
  */
-char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind
-                                       dirkind);
+char *
+GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind dirkind);
 
 
 /**
@@ -149,8 +149,7 @@ char *GNUNET_OS_installation_get_path (enum GNUNET_OS_InstallationPathKind
  * @param addrlen length of the address
  * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
  */
-typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
-                                                    const char *name,
+typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls, const char *name,
                                                     int isDefault,
                                                     const struct sockaddr *
                                                     addr, socklen_t addrlen);
@@ -161,8 +160,9 @@ typedef int (*GNUNET_OS_NetworkInterfaceProcessor) (void *cls,
  * @param proc the callback function
  * @param proc_cls closure for proc
  */
-void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
-                                        proc, void *proc_cls);
+void
+GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor proc,
+                                   void *proc_cls);
 
 /**
  * @brief Get maximum string length returned by gethostname()
@@ -184,7 +184,8 @@ void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
  *
  * @return pointer to the process sturcutre for this process
  */
-struct GNUNET_OS_Process *GNUNET_OS_process_current (void);
+struct GNUNET_OS_Process *
+GNUNET_OS_process_current (void);
 
 
 /**
@@ -194,7 +195,8 @@ struct GNUNET_OS_Process *GNUNET_OS_process_current (void);
  * @param sig signal
  * @return 0 on success, -1 on error
  */
-int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
+int
+GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
 
 
 /**
@@ -202,7 +204,8 @@ int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
  *
  * @param proc pointer to process structure
  */
-void GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
+void
+GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
 
 /**
  * Get the pid of the process in question
@@ -221,8 +224,9 @@ GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
  * @param prio priority value
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
-int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
-                                    enum GNUNET_SCHEDULER_Priority prio);
+int
+GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
+                                enum GNUNET_SCHEDULER_Priority prio);
 
 
 /**
@@ -235,9 +239,9 @@ int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
  * @return pointer to process structure of the new process, NULL on error
  */
 struct GNUNET_OS_Process *
-GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, 
-                        struct GNUNET_DISK_PipeHandle *pipe_stdout, 
-                        const char *filename, ...);
+GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin,
+                         struct GNUNET_DISK_PipeHandle *pipe_stdout,
+                         const char *filename, ...);
 
 
 /**
@@ -250,10 +254,9 @@ GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin,
  * @return pointer to process structure of the new process, NULL on error
  */
 struct GNUNET_OS_Process *
-GNUNET_OS_start_process_va (struct GNUNET_DISK_PipeHandle *pipe_stdin, 
-                           struct GNUNET_DISK_PipeHandle *pipe_stdout,
-                           const char *filename, 
-                           va_list va);
+GNUNET_OS_start_process_va (struct GNUNET_DISK_PipeHandle *pipe_stdin,
+                            struct GNUNET_DISK_PipeHandle *pipe_stdout,
+                            const char *filename, va_list va);
 
 /**
  * Start a process.
@@ -267,7 +270,7 @@ GNUNET_OS_start_process_va (struct GNUNET_DISK_PipeHandle *pipe_stdin,
  */
 struct GNUNET_OS_Process *
 GNUNET_OS_start_process_v (const int *lsocks, const char *filename,
-                          char *const argv[]);
+                           char *const argv[]);
 
 
 /**
@@ -281,8 +284,7 @@ struct GNUNET_OS_CommandHandle;
  * @param cls closure
  * @param line line of output from a command, NULL for the end
  */
-typedef void (*GNUNET_OS_LineProcessor)(void *cls,
-                                       const char *line);
+typedef void (*GNUNET_OS_LineProcessor) (void *cls, const char *line);
 
 /**
  * Stop/kill a command.
@@ -305,30 +307,37 @@ GNUNET_OS_command_stop (struct GNUNET_OS_CommandHandle *cmd);
  * @return NULL on error
  */
 struct GNUNET_OS_CommandHandle *
-GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc,
-                      void *proc_cls,
-                      struct GNUNET_TIME_Relative timeout,
-                      const char *binary,
-                      ...);
+GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc, void *proc_cls,
+                       struct GNUNET_TIME_Relative timeout, const char *binary,
+                       ...);
 
 
 /**
- * Retrieve the status of a process
+ * Retrieve the status of a process.  Nonblocking version.
+ *
  * @param proc pointer to process structure
  * @param type status type
  * @param code return code/signal number
  * @return GNUNET_OK on success, GNUNET_NO if the process is still running, GNUNET_SYSERR otherwise
  */
-int GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
-                             enum GNUNET_OS_ProcessStatusType *type, unsigned long *code);
+int
+GNUNET_OS_process_status (struct GNUNET_OS_Process *proc,
+                          enum GNUNET_OS_ProcessStatusType *type,
+                          unsigned long *code);
 
 
 /**
- * Wait for a process
+ * Wait for a process to terminate.  The return code is discarded.
+ * You must not use 'GNUNET_OS_process_status' on the same process
+ * after calling this function!  This function is blocking and should
+ * thus only be used if the child process is known to have terminated
+ * or to terminate very soon.
+ *
  * @param proc pointer to process structure of the process to wait for
  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
  */
-int GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
+int
+GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
 
 
 /**
@@ -337,7 +346,7 @@ int GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
 void
 GNUNET_OS_install_parent_control_handler (void *cls,
                                           const struct
-                                          GNUNET_SCHEDULER_TaskContext * tc);
+                                          GNUNET_SCHEDULER_TaskContext *tc);
 
 
 /**
@@ -347,7 +356,7 @@ GNUNET_OS_install_parent_control_handler (void *cls,
  * PATH environment variable as a search path.
  *
  * @param binary the name of the file to check
- * @return GNUNET_YES if the file is SUID, 
+ * @return GNUNET_YES if the file is SUID,
  *         GNUNET_NO if not SUID (but binary exists)
  *         GNUNET_SYSERR on error (no such binary or not executable)
  */