cups/sidechannel.h

   1 /*
   2  * "$Id: sidechannel.h 6649 2007-07-11 21:46:42Z mike $"
   3  *
   4  *   Side-channel API definitions for the Common UNIX Printing System (CUPS).
   5  *
   6  *   Copyright 2007 by Apple Inc.
   7  *   Copyright 2006 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_SIDECHANNEL_H_
  19 #  define _CUPS_SIDECHANNEL_H_
  20
  21 /*
  22  * Include necessary headers...
  23  */
  24
  25 #  include "versioning.h"
  26
  27
  28 /*
  29  * C++ magic...
  30  */
  31
  32 #  ifdef __cplusplus
  33 extern "C" {
  34 #  endif /* __cplusplus */
  35
  36
  37 /*
  38  * Constants...
  39  */
  40
  41 #define CUPS_SC_FD      4               /* File descriptor for select/poll */
  42
  43
  44 /*
  45  * Enumerations...
  46  */
  47
  48 typedef enum                            /**** Bidirectional capabilities ****/
  49 {
  50   CUPS_SC_BIDI_NOT_SUPPORTED = 0,       /* Bidirectional I/O is not supported */
  51   CUPS_SC_BIDI_SUPPORTED = 1            /* Bidirectional I/O is supported */
  52 } cups_sc_bidi_t;
  53
  54 typedef enum                            /**** Request command codes ****/
  55 {
  56   CUPS_SC_CMD_SOFT_RESET = 1,           /* Do a soft reset */
  57   CUPS_SC_CMD_DRAIN_OUTPUT = 2,         /* Drain all pending output */
  58   CUPS_SC_CMD_GET_BIDI = 3,             /* Return bidirectional capabilities */
  59   CUPS_SC_CMD_GET_DEVICE_ID = 4,        /* Return the IEEE-1284 device ID */
  60   CUPS_SC_CMD_GET_STATE = 5             /* Return the device state */
  61 } cups_sc_command_t;
  62
  63 typedef enum                            /**** Printer state bits ****/
  64 {
  65   CUPS_SC_STATE_OFFLINE = 0,            /* Device is off-line */
  66   CUPS_SC_STATE_ONLINE = 1,             /* Device is on-line */
  67   CUPS_SC_STATE_BUSY = 2,               /* Device is busy */
  68   CUPS_SC_STATE_ERROR = 4,              /* Other error condition */
  69   CUPS_SC_STATE_MEDIA_LOW = 16,         /* Paper low condition */
  70   CUPS_SC_STATE_MEDIA_EMPTY = 32,       /* Paper out condition */
  71   CUPS_SC_STATE_MARKER_LOW = 64,        /* Toner/ink low condition */
  72   CUPS_SC_STATE_MARKER_EMPTY = 128      /* Toner/ink out condition */
  73 } cups_sc_state_t;
  74
  75 typedef enum                            /**** Response status codes ****/
  76 {
  77   CUPS_SC_STATUS_NONE,                  /* No status */
  78   CUPS_SC_STATUS_OK,                    /* Operation succeeded */
  79   CUPS_SC_STATUS_IO_ERROR,              /* An I/O error occurred */
  80   CUPS_SC_STATUS_TIMEOUT,               /* The backend did not respond */
  81   CUPS_SC_STATUS_NO_RESPONSE,           /* The device did not respond */
  82   CUPS_SC_STATUS_BAD_MESSAGE,           /* The command/response message was invalid */
  83   CUPS_SC_STATUS_TOO_BIG,               /* Response too big */
  84   CUPS_SC_STATUS_NOT_IMPLEMENTED        /* Command not implemented */
  85 } cups_sc_status_t;
  86
  87
  88 /*
  89  * Prototypes...
  90  */
  91
  92 extern cups_sc_status_t cupsSideChannelDoRequest(cups_sc_command_t command,
  93                                                  char *data, int *datalen,
  94                                                  double timeout) _CUPS_API_1_3;
  95 extern int              cupsSideChannelRead(cups_sc_command_t *command,
  96                                             cups_sc_status_t *status,
  97                                             char *data, int *datalen,
  98                                             double timeout) _CUPS_API_1_3;
  99 extern int              cupsSideChannelWrite(cups_sc_command_t command,
 100                                              cups_sc_status_t status,
 101                                              const char *data, int datalen,
 102                                              double timeout) _CUPS_API_1_3;
 103
 104
 105 #  ifdef __cplusplus
 106 }
 107 #  endif /* __cplusplus */
 108
 109 #endif /* !_CUPS_SIDECHANNEL_H_ */
 110
 111 /*
 112  * End of "$Id: sidechannel.h 6649 2007-07-11 21:46:42Z mike $".
 113  */