client_manager: add API for async operations

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

diff --git a/src/include/gnunet_signal_lib.h b/src/include/gnunet_signal_lib.h
index af1ec0de4aafe45bbdb04fe343c3f96b47ce0f8b..32655dd4e4ffacdaf66d3a3eef83e6d3883797f9 100644 (file)
--- a/src/include/gnunet_signal_lib.h
+++ b/src/include/gnunet_signal_lib.h
@@ -1,10 +1,10 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
@@ -35,6 +35,10 @@ extern "C"
 #endif
 #endif
 
+/**
+ * Context created when a signal handler is installed;
+ * can be used to restore it to the previous state later.
+ */
 struct GNUNET_SIGNAL_Context;
 
 /**
@@ -50,15 +54,33 @@ typedef void (*GNUNET_SIGNAL_Handler) (void);
 /**
  * Install a signal handler that will be run if the
  * given signal is received.
+ *
+ * @param signal the number of the signal
+ * @param handler the function to call
+ * @return context that can be used to restore, NULL on error
  */
-struct GNUNET_SIGNAL_Context *GNUNET_SIGNAL_handler_install (int signal,
-                                                             GNUNET_SIGNAL_Handler
-                                                             handler);
+struct GNUNET_SIGNAL_Context *
+GNUNET_SIGNAL_handler_install (int signal, GNUNET_SIGNAL_Handler handler);
 
 /**
  * Uninstall a previously installed signal hander.
+ *
+ * @param ctx context that was returned when the
+ *            signal handler was installed
+ */
+void
+GNUNET_SIGNAL_handler_uninstall (struct GNUNET_SIGNAL_Context *ctx);
+
+
+/**
+ * Raise the given signal by calling the installed signal handlers.  This will
+ * not use the @em raise() system call but only calls the handlers registered
+ * through GNUNET_SIGNAL_handler_install().
+ *
+ * @param sig the signal to raise
  */
-void GNUNET_SIGNAL_handler_uninstall (struct GNUNET_SIGNAL_Context *ctx);
+void
+GNUNET_SIGNAL_raise (const int sig);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */