convert fs publish to MQ

[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 1597c76d026a5760648b9fc7c19728e8874a1f37..08c72fb3a1bb0c3f21bee015ff1596fbf217f4c6 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 GNUnet e.V.
 
      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
@@ -14,14 +14,19 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
- * @file include/gnunet_signal_lib.h
- * @brief functions related to signals
  * @author Christian Grothoff
+ *
+ * @file
+ * Functions related to signals
+ *
+ * @defgroup signal  Signal library
+ * Manage signal handlers.
+ * @{
  */
 
 #ifndef GNUNET_SIGNAL_LIB_H
@@ -41,6 +46,7 @@ extern "C"
  */
 struct GNUNET_SIGNAL_Context;
 
+
 /**
  * A signal handler.  Since different OSes have different signatures
  * for their handlers, the API only gives the most restrictive
@@ -49,7 +55,9 @@ struct GNUNET_SIGNAL_Context;
  * the implementation must guarantee that this handler is not called
  * for signals other than the one that it has been registered for.
  */
-typedef void (*GNUNET_SIGNAL_Handler) (void);
+typedef void
+(*GNUNET_SIGNAL_Handler) (void);
+
 
 /**
  * Install a signal handler that will be run if the
@@ -60,7 +68,9 @@ typedef void (*GNUNET_SIGNAL_Handler) (void);
  * @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);
+GNUNET_SIGNAL_handler_install (int signal,
+                               GNUNET_SIGNAL_Handler handler);
+
 
 /**
  * Uninstall a previously installed signal hander.
@@ -72,6 +82,17 @@ 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_raise (const int sig);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif
@@ -81,4 +102,7 @@ GNUNET_SIGNAL_handler_uninstall (struct GNUNET_SIGNAL_Context *ctx);
 
 /* ifndef GNUNET_SIGNAL_LIB_H */
 #endif
+
+/** @} */  /* end of group */
+
 /* end of gnunet_signal_lib.h */