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 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: auerr.h,v $
  32  * Revision 1.1  2002/02/02 19:16:28  mdw
  33  * New audio subsystem.
  34  *
  35  */
  36
  37 #ifndef AUERR_H
  38 #define AUERR_H
  39
  40 #ifdef __cplusplus
  41   extern "C" {
  42 #endif
  43
  44 /*----- Functions provided ------------------------------------------------*/
  45
  46 /* --- @auerr@ --- *
  47  *
  48  * Arguments:   @int ctx@ = context code
  49  *              @int reason@ = reason code
  50  *              @unsigned long err@ = error code
  51  *
  52  * Returns:     ---
  53  *
  54  * Use:         Reports an error to the audio output.
  55  */
  56
  57 extern void auerr(int /*ctx*/, int /*reason*/, unsigned long /*err*/);
  58
  59 /* --- @auerr_abort@ --- *
  60  *
  61  * Arguments:   @int reason@ = abort reason code
  62  *              @unsigned long err@ = error code
  63  *
  64  * Returns:     ---
  65  *
  66  * Use:         Reports an abort message to te audio output.
  67  */
  68
  69 extern void auerr_abort(int /*reason*/, unsigned long /*err*/);
  70
  71 /*----- That's all, folks -------------------------------------------------*/
  72
  73 #ifdef __cplusplus
  74   }
  75 #endif
  76
  77 #endif