cups/backend.h

   1 /*
   2  * "$Id$"
   3  *
   4  *   Backend definitions for CUPS.
   5  *
   6  *   Copyright 2007-2011 by Apple Inc.
   7  *   Copyright 1997-2005 by Easy Software Products.
   8  *
   9  *   These coded instructions, statements, and computer programs are the
  10  *   property of Apple Inc. and are protected by Federal copyright
  11  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12  *   which should have been included with this file.  If this file is
  13  *   file is missing or damaged, see the license at "http://www.cups.org/".
  14  *
  15  *   This file is subject to the Apple OS-Developed Software exception.
  16  */
  17
  18 #ifndef _CUPS_BACKEND_H_
  19 #  define _CUPS_BACKEND_H_
  20
  21
  22 /*
  23  * Include necessary headers...
  24  */
  25
  26 #  include "versioning.h"
  27
  28
  29 /*
  30  * C++ magic...
  31  */
  32
  33 #  ifdef __cplusplus
  34 extern "C" {
  35 #  endif /* __cplusplus */
  36
  37 /*
  38  * Constants...
  39  */
  40
  41 enum cups_backend_e                     /**** Backend exit codes ****/
  42 {
  43   CUPS_BACKEND_OK = 0,                  /* Job completed successfully */
  44   CUPS_BACKEND_FAILED = 1,              /* Job failed, use error-policy */
  45   CUPS_BACKEND_AUTH_REQUIRED = 2,       /* Job failed, authentication required */
  46   CUPS_BACKEND_HOLD = 3,                /* Job failed, hold job */
  47   CUPS_BACKEND_STOP = 4,                /* Job failed, stop queue */
  48   CUPS_BACKEND_CANCEL = 5,              /* Job failed, cancel job */
  49   CUPS_BACKEND_RETRY = 6,               /* Job failed, retry this job later */
  50   CUPS_BACKEND_RETRY_CURRENT = 7        /* Job failed, retry this job immediately */
  51 };
  52 typedef enum cups_backend_e cups_backend_t;
  53                                         /**** Backend exit codes ****/
  54
  55
  56 /*
  57  * Prototypes...
  58  */
  59
  60 extern const char       *cupsBackendDeviceURI(char **argv) _CUPS_API_1_2;
  61 extern void             cupsBackendReport(const char *device_scheme,
  62                                           const char *device_uri,
  63                                           const char *device_make_and_model,
  64                                           const char *device_info,
  65                                           const char *device_id,
  66                                           const char *device_location)
  67                                           _CUPS_API_1_4;
  68
  69
  70 #  ifdef __cplusplus
  71 }
  72 #  endif /* __cplusplus */
  73
  74 #endif /* !_CUPS_BACKEND_H_ */
  75
  76 /*
  77  * End of "$Id$".
  78  */