Update or add comments to files and functions for use by Doxygen.

[mirror_edk2.git] / StdLib / Include / sys / signal.h

/** @file\r
\r
    Implementation and Platform specific portion of <signal.h>.\r
\r
    Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
    This program and the accompanying materials are licensed and made available under\r
    the terms and conditions of the BSD License that accompanies this distribution.\r
    The full text of the license may be found at\r
    http://opensource.org/licenses/bsd-license.\r
\r
    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
**/\r
#ifndef _SYS_SIGNAL_H\r
#define _SYS_SIGNAL_H\r
#include  <sys/EfiCdefs.h>\r
#include  <machine/signal.h>\r
\r
/** The actual (default) signal numbers are assigned using an anonymous enum\r
    so that the compiler can do the work of assigning values.  This helps\r
    ensure that the developer should never have to renumber the signals or\r
    figure out what number to assign to a new signal.\r
\r
    Properly constructed programs will NEVER depend upon signal numbers being\r
    in a particular order or having a particular value.  All that is guaranteed\r
    is that each signal number is distinct, positive, and non-zero.\r
**/\r
enum {\r
  __SigInt    = 1,\r
  __SigIll,\r
  __SigAbrt,\r
  __SigFpe,\r
  __SigSegv,\r
  __SigTerm,\r
  __SigBreak,\r
  __SigAlrm,\r
  __SigVtAlrm,\r
  __SigProf,\r
  __SigUsr1,\r
  __SigUsr2,\r
  __SigWinch,\r
  __SigPipe,\r
  __SigQuit,\r
  __Sig_Last\r
};\r
\r
/** The type of a signal handler function. **/\r
typedef void __sighandler_t(int);\r
\r
__BEGIN_DECLS\r
/** The signal function associates a "signal handler" with a signal number.\r
\r
    For historical reasons; programs expect signal to be declared\r
    in <sys/signal.h>.\r
\r
    @param[in]  sig       Signal number that function is to be associated with.\r
    @param[in]  function  The "handler" function to be associated with signal sig.\r
\r
    @return     If the request can be honored, the signal function returns the\r
                value of func for the most recent successful call to signal for\r
                the specified signal sig. Otherwise, a value of SIG_ERR is\r
                returned and a positive value is stored in errno.\r
 */\r
__sighandler_t  *signal(int sig, __sighandler_t *func);\r
\r
__END_DECLS\r
\r
#endif    /* _SYS_SIGNAL_H */\r