chiark - git - mdw - jog/blob - auerr.h

   1 /* -*-c-*-
   2  *
   3  * $Id: auerr.h,v 1.1 2002/02/02 19:16:28 mdw Exp $
   4  *
   5  * Audio error reporting
   6  *
   7  * (c) 2002 Mark Wooding
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Jog: Programming for a jogging machine.
  13  *
  14  * Jog is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * Jog is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Jog; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef AUERR_H
  30 #define AUERR_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Functions provided ------------------------------------------------*/
  37
  38 /* --- @auerr@ --- *
  39  *
  40  * Arguments:   @int ctx@ = context code
  41  *              @int reason@ = reason code
  42  *              @unsigned long err@ = error code
  43  *
  44  * Returns:     ---
  45  *
  46  * Use:         Reports an error to the audio output.
  47  */
  48
  49 extern void auerr(int /*ctx*/, int /*reason*/, unsigned long /*err*/);
  50
  51 /* --- @auerr_abort@ --- *
  52  *
  53  * Arguments:   @int reason@ = abort reason code
  54  *              @unsigned long err@ = error code
  55  *
  56  * Returns:     ---
  57  *
  58  * Use:         Reports an abort message to te audio output.
  59  */
  60
  61 extern void auerr_abort(int /*reason*/, unsigned long /*err*/);
  62
  63 /*----- That's all, folks -------------------------------------------------*/
  64
  65 #ifdef __cplusplus
  66   }
  67 #endif
  68
  69 #endif