SHUTDOWN
[oweals/gnunet.git] / src / include / gnunet_os_lib.h
index 87d9a8fb1700a438f704b4360a50bee306c3b2bb..7bd65adcbde19279c789c1611446ba59703acb45 100644 (file)
@@ -44,6 +44,11 @@ extern "C"
 #include "gnunet_configuration_lib.h"
 #include "gnunet_scheduler_lib.h"
 
+/**
+ * Process information (OS-dependent)
+ */
+struct GNUNET_OS_Process;
+
 
 /**
  * Possible installation paths to request
@@ -80,7 +85,12 @@ enum GNUNET_OS_InstallationPathKind
    * the one of the overall GNUnet installation (in case they
    * are different).
    */
-  GNUNET_OS_IPK_SELF_PREFIX
+  GNUNET_OS_IPK_SELF_PREFIX,
+
+  /**
+   * Return the prefix of the path with application icons.
+   */
+  GNUNET_OS_IPK_ICONDIR
 };
 
 
@@ -167,34 +177,51 @@ void GNUNET_OS_network_interfaces_list (GNUNET_OS_NetworkInterfaceProcessor
 
 
 /**
- * Get the current CPU load.
+ * Get process structure for current process
  *
- * @param cfg to determine acceptable load level (LOAD::MAXCPULOAD)
- * @return -1 on error, otherwise load value (between 0 and 100,
- *        (100 is equivalent to full load for one CPU)
+ * The pointer it returns points to static memory location and must not be
+ * deallocated/closed
+ *
+ * @return pointer to the process sturcutre for this process
  */
-int GNUNET_OS_load_cpu_get (const struct GNUNET_CONFIGURATION_Handle *cfg);
+struct GNUNET_OS_Process *GNUNET_OS_process_current (void);
 
 
 /**
- * Get the current IO load.
+ * Sends sig to the process
  *
- * @param cfg to determine acceptable load level (LOAD::MAXIOLOAD)
- * @return -1 on error, otherwise load value (between 0 and 100,
- *       100 means that we spend all of our cycles waiting for
- *       the disk)
+ * @param proc pointer to process structure
+ * @param sig signal
+ * @return 0 on success, -1 on error
  */
-int GNUNET_OS_load_disk_get (const struct GNUNET_CONFIGURATION_Handle *cfg);
+int GNUNET_OS_process_kill (struct GNUNET_OS_Process *proc, int sig);
+
 
+/**
+ * Cleans up process structure contents (OS-dependent) and deallocates it
+ *
+ * @param proc pointer to process structure
+ */
+void GNUNET_OS_process_close (struct GNUNET_OS_Process *proc);
+
+/**
+ * Get the pid of the process in question
+ *
+ * @param proc the process to get the pid of
+ *
+ * @return the current process id
+ */
+pid_t
+GNUNET_OS_process_get_pid (struct GNUNET_OS_Process *proc);
 
 /**
  * Set process priority
  *
- * @param proc id of the process
+ * @param proc pointer to process structure
  * @param prio priority value
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
-int GNUNET_OS_set_process_priority (pid_t proc,
+int GNUNET_OS_set_process_priority (struct GNUNET_OS_Process *proc,
                                     enum GNUNET_SCHEDULER_Priority prio);
 
 
@@ -205,9 +232,9 @@ int GNUNET_OS_set_process_priority (pid_t proc,
  * @param pipe_stdout pipe to use to get output from child process (or NULL)
  * @param filename name of the binary
  * @param ... NULL-terminated list of arguments to the process
- * @return process ID of the new process, -1 on error
+ * @return pointer to process structure of the new process, NULL on error
  */
-pid_t
+struct GNUNET_OS_Process *
 GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin, 
                         struct GNUNET_DISK_PipeHandle *pipe_stdout, 
                         const char *filename, ...);
@@ -221,30 +248,39 @@ GNUNET_OS_start_process (struct GNUNET_DISK_PipeHandle *pipe_stdin,
  * @param filename name of the binary
  * @param argv NULL-terminated list of arguments to the process,
  *             including the process name as the first argument
- * @return process ID of the new process, -1 on error
+ * @return pointer to process structure of the new process, NULL on error
  */
-pid_t GNUNET_OS_start_process_v (const int *lsocks,
-                                const char *filename, char *const argv[]);
+struct GNUNET_OS_Process *
+GNUNET_OS_start_process_v (const int *lsocks, const char *filename,
+                          char *const argv[]);
 
 
 /**
  * Retrieve the status of a process
- * @param proc process ID
+ * @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 (pid_t 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
- * @param proc process ID to wait for
+ * @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 (pid_t proc);
+int GNUNET_OS_process_wait (struct GNUNET_OS_Process *proc);
+
 
+/**
+ * Connects this process to its parent via pipe
+ */
+void
+GNUNET_OS_install_parent_control_handler (void *cls,
+                                          const struct
+                                          GNUNET_SCHEDULER_TaskContext * tc);
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 {