2 * "$Id: subscriptions.h 7824 2008-08-01 21:11:55Z mike $"
4 * Subscription definitions for the Common UNIX Printing System (CUPS) scheduler.
6 * Copyright 2007-2008 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
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/".
17 * Event mask enumeration...
22 /* Individual printer events... */
23 CUPSD_EVENT_PRINTER_STATE
= 0x0001, /* Sent after generic printer state change */
24 CUPSD_EVENT_PRINTER_RESTARTED
= 0x0002,
25 /* Sent after printer restarted */
26 CUPSD_EVENT_PRINTER_SHUTDOWN
= 0x0004,/* Sent after printer shutdown */
27 CUPSD_EVENT_PRINTER_STOPPED
= 0x0008, /* Sent after printer stopped */
29 CUPSD_EVENT_PRINTER_CONFIG
= 0x0010, /* Send after add/modify changes attrs */
30 CUPSD_EVENT_PRINTER_FINISHINGS_CHANGED
= 0x0020,
31 /* Sent after finishings-supported changed */
32 CUPSD_EVENT_PRINTER_MEDIA_CHANGED
= 0x0040,
33 /* Sent after media-supported changed */
34 CUPSD_EVENT_PRINTER_ADDED
= 0x0080, /* Sent after printer added */
35 CUPSD_EVENT_PRINTER_DELETED
= 0x0100, /* Sent after printer deleted */
36 CUPSD_EVENT_PRINTER_MODIFIED
= 0x0200,/* Sent after printer modified */
37 CUPSD_EVENT_PRINTER_QUEUE_ORDER_CHANGED
= 0x0400,
38 /* Sent when the order of jobs is changed */
40 /* Convenience printer event groupings... */
41 CUPSD_EVENT_PRINTER_STATE_CHANGED
= 0x000f,
42 /* STATE + RESTARTED + SHUTDOWN + STOPPED */
43 CUPSD_EVENT_PRINTER_CONFIG_CHANGED
= 0x0070,
44 /* CONFIG + FINISHINGS_CHANGED + MEDIA_CHANGED */
45 CUPSD_EVENT_PRINTER_CHANGED
= 0x07ff, /* All of the above */
47 /* Individual job events... */
48 CUPSD_EVENT_JOB_STATE
= 0x0800, /* Any state change */
49 CUPSD_EVENT_JOB_CREATED
= 0x1000, /* Send after job is created */
50 CUPSD_EVENT_JOB_COMPLETED
= 0x2000, /* Sent after job is completed */
51 CUPSD_EVENT_JOB_STOPPED
= 0x4000, /* Sent after job is stopped */
52 CUPSD_EVENT_JOB_CONFIG_CHANGED
= 0x8000,
53 /* Sent after set-job-attributes */
54 CUPSD_EVENT_JOB_PROGRESS
= 0x10000, /* Sent for each page */
56 /* Convenience job event grouping... */
57 CUPSD_EVENT_JOB_STATE_CHANGED
= 0x7800,
58 /* STATE + CREATED + COMPLETED + STOPPED */
60 /* Server events... */
61 CUPSD_EVENT_SERVER_RESTARTED
= 0x20000,/* Sent after server restarts */
62 CUPSD_EVENT_SERVER_STARTED
= 0x40000, /* Sent when server first starts */
63 CUPSD_EVENT_SERVER_STOPPED
= 0x80000, /* Sent when server is stopped */
64 CUPSD_EVENT_SERVER_AUDIT
= 0x100000, /* Security-related stuff */
66 /* Everything and nothing... */
67 CUPSD_EVENT_NONE
= 0, /* Nothing */
68 CUPSD_EVENT_ALL
= 0x1fffff /* Everything */
73 * Notiification support structures...
76 typedef struct cupsd_event_s
/**** Event structure ****/
78 cupsd_eventmask_t event
; /* Event */
79 time_t time
; /* Time of event */
80 ipp_t
*attrs
; /* Notification message */
81 cupsd_printer_t
*dest
; /* Associated printer, if any */
82 cupsd_job_t
*job
; /* Associated job, if any */
85 typedef struct cupsd_subscription_s
/**** Subscription structure ****/
87 int id
; /* subscription-id */
88 unsigned mask
; /* Event mask */
89 char *owner
; /* notify-subscriber-user-name */
90 char *recipient
; /* notify-recipient-uri, if applicable */
91 unsigned char user_data
[64]; /* notify-user-data */
92 int user_data_len
; /* Length of notify-user-data */
93 int lease
; /* notify-lease-duration */
94 int interval
; /* notify-time-interval */
95 cupsd_printer_t
*dest
; /* notify-printer-uri, if any */
96 cupsd_job_t
*job
; /* notify-job-id, if any */
97 int pid
; /* Process ID of notifier */
98 int pipe
; /* Pipe to notifier */
99 int status
; /* Exit status of notifier */
100 time_t last
; /* Time of last notification */
101 time_t expire
; /* Lease expiration time */
102 int first_event_id
, /* First event-id in cache */
103 next_event_id
, /* Next event-id to use */
104 num_events
; /* Number of cached events */
105 cupsd_event_t
**events
; /* Cached events */
106 } cupsd_subscription_t
;
113 VAR
int MaxSubscriptions
VALUE(100),
114 /* Overall subscription limit */
115 MaxSubscriptionsPerJob
VALUE(0),
116 /* Per-job subscription limit */
117 MaxSubscriptionsPerPrinter
VALUE(0),
118 /* Per-printer subscription limit */
119 MaxSubscriptionsPerUser
VALUE(0),
120 /* Per-user subscription limit */
121 NextSubscriptionId
VALUE(1),
122 /* Next subscription ID */
123 DefaultLeaseDuration
VALUE(86400),
124 /* Default notify-lease-duration */
125 MaxLeaseDuration
VALUE(0);
126 /* Maximum notify-lease-duration */
127 VAR cups_array_t
*Subscriptions
VALUE(NULL
);
128 /* Active subscriptions */
130 VAR
int MaxEvents
VALUE(100); /* Maximum number of events */
132 VAR
unsigned LastEvent
VALUE(0); /* Last event(s) processed */
133 VAR
int NotifierPipes
[2] VALUE2(-1, -1);
134 /* Pipes for notifier error/debug output */
135 VAR cupsd_statbuf_t
*NotifierStatusBuffer
VALUE(NULL
);
136 /* Status buffer for pipes */
143 extern void cupsdAddEvent(cupsd_eventmask_t event
, cupsd_printer_t
*dest
,
144 cupsd_job_t
*job
, const char *text
, ...);
145 extern cupsd_subscription_t
*
146 cupsdAddSubscription(unsigned mask
, cupsd_printer_t
*dest
,
147 cupsd_job_t
*job
, const char *uri
,
149 extern void cupsdDeleteAllSubscriptions(void);
150 extern void cupsdDeleteSubscription(cupsd_subscription_t
*sub
, int update
);
152 cupsdEventName(cupsd_eventmask_t event
);
153 extern cupsd_eventmask_t
154 cupsdEventValue(const char *name
);
156 extern cupsd_subscription_t
*
157 cupsdFindSubscription(int id
);
158 extern void cupsdExpireSubscriptions(cupsd_printer_t
*dest
,
160 extern void cupsdLoadAllSubscriptions(void);
161 extern void cupsdSaveAllSubscriptions(void);
162 extern void cupsdStopAllNotifiers(void);
166 * End of "$Id: subscriptions.h 7824 2008-08-01 21:11:55Z mike $".