]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
b19ccc9e | 2 | * "$Id: job.h 7883 2008-08-28 20:38:13Z mike $" |
ef416fc2 | 3 | * |
10d09e33 | 4 | * Print job definitions for the CUPS scheduler. |
ef416fc2 | 5 | * |
10d09e33 | 6 | * Copyright 2007-2010 by Apple Inc. |
09a101d6 | 7 | * Copyright 1997-2007 by Easy Software Products, all rights reserved. |
ef416fc2 | 8 | * |
9 | * These coded instructions, statements, and computer programs are the | |
bc44d920 | 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/". | |
ef416fc2 | 14 | */ |
15 | ||
b9faaae1 MS |
16 | /* |
17 | * Constants... | |
18 | */ | |
19 | ||
20 | typedef enum cupsd_jobaction_e /**** Actions for state changes ****/ | |
21 | { | |
22 | CUPSD_JOB_DEFAULT, /* Use default action */ | |
23 | CUPSD_JOB_FORCE, /* Force the change */ | |
24 | CUPSD_JOB_PURGE /* Force the change and purge */ | |
25 | } cupsd_jobaction_t; | |
26 | ||
27 | ||
ef416fc2 | 28 | /* |
29 | * Job request structure... | |
30 | */ | |
31 | ||
178cb736 | 32 | struct cupsd_job_s /**** Job request ****/ |
ef416fc2 | 33 | { |
34 | int id, /* Job ID */ | |
3dfe78b3 MS |
35 | priority, /* Job priority */ |
36 | dirty; /* Do we need to write the "c" file? */ | |
bd7854cb | 37 | ipp_jstate_t state_value; /* Cached job-state */ |
b9faaae1 MS |
38 | int pending_timeout;/* Non-zero if the job was created and |
39 | * waiting on files */ | |
ef416fc2 | 40 | char *username; /* Printing user */ |
41 | char *dest; /* Destination printer or class */ | |
b9faaae1 | 42 | cups_ptype_t dtype; /* Destination type */ |
10d09e33 | 43 | cupsd_printer_t *printer; /* Printer this job is assigned to */ |
ef416fc2 | 44 | int num_files; /* Number of files in job */ |
ef416fc2 | 45 | mime_type_t **filetypes; /* File types */ |
46 | int *compressions; /* Compression status of each file */ | |
bd7854cb | 47 | ipp_attribute_t *sheets; /* job-media-sheets-completed */ |
238c3832 MS |
48 | time_t access_time, /* Last access time */ |
49 | kill_time, /* When to send SIGKILL */ | |
50 | hold_until; /* Hold expiration date/time */ | |
bd7854cb | 51 | ipp_attribute_t *state; /* Job state */ |
52 | ipp_attribute_t *job_sheets; /* Job sheets (NULL if none) */ | |
bc44d920 | 53 | ipp_attribute_t *printer_message, |
54 | /* job-printer-state-message */ | |
55 | *printer_reasons; | |
56 | /* job-printer-state-reasons */ | |
bd7854cb | 57 | int current_file; /* Current file in job */ |
ef416fc2 | 58 | ipp_t *attrs; /* Job attributes */ |
ef416fc2 | 59 | int print_pipes[2], /* Print data pipes */ |
89d46774 | 60 | back_pipes[2], /* Backchannel pipes */ |
f7deaa1a | 61 | side_pipes[2], /* Sidechannel pipes */ |
89d46774 | 62 | status_pipes[2];/* Status pipes */ |
63 | cupsd_statbuf_t *status_buffer; /* Status buffer for this job */ | |
b9faaae1 MS |
64 | int status_level; /* Highest log level in a status |
65 | * message */ | |
ef416fc2 | 66 | int cost; /* Filtering cost */ |
e07d4801 | 67 | int pending_cost; /* Waiting for FilterLimit */ |
ef416fc2 | 68 | int filters[MAX_FILTERS + 1]; |
69 | /* Filter process IDs, 0 terminated */ | |
70 | int backend; /* Backend process ID */ | |
71 | int status; /* Status code from filters */ | |
ef416fc2 | 72 | int tries; /* Number of tries for this job */ |
b9faaae1 MS |
73 | char *auth_username, /* AUTH_USERNAME environment variable, |
74 | * if any */ | |
75 | *auth_domain, /* AUTH_DOMAIN environment variable, | |
76 | * if any */ | |
07ed0e9a MS |
77 | *auth_password, /* AUTH_PASSWORD environment variable, |
78 | * if any */ | |
79 | *auth_uid; /* AUTH_UID environment variable, | |
b9faaae1 | 80 | * if any */ |
a4924f6c | 81 | void *profile; /* Security profile */ |
178cb736 | 82 | cups_array_t *history; /* Debug log history */ |
9a4f8274 | 83 | int progress; /* Printing progress */ |
f11a948a | 84 | }; |
ef416fc2 | 85 | |
178cb736 MS |
86 | typedef struct cupsd_joblog_s /**** Job log message ****/ |
87 | { | |
88 | time_t time; /* Time of message */ | |
89 | char message[1]; /* Message string */ | |
90 | } cupsd_joblog_t; | |
91 | ||
ef416fc2 | 92 | |
93 | /* | |
94 | * Globals... | |
95 | */ | |
96 | ||
97 | VAR int JobHistory VALUE(1); | |
98 | /* Preserve job history? */ | |
99 | VAR int JobFiles VALUE(0); | |
100 | /* Preserve job files? */ | |
101 | VAR int MaxJobs VALUE(0), | |
102 | /* Max number of jobs */ | |
103 | MaxActiveJobs VALUE(0), | |
104 | /* Max number of active jobs */ | |
105 | MaxJobsPerUser VALUE(0), | |
106 | /* Max jobs per user */ | |
107 | MaxJobsPerPrinter VALUE(0); | |
108 | /* Max jobs per printer */ | |
109 | VAR int JobAutoPurge VALUE(0); | |
110 | /* Automatically purge jobs */ | |
111 | VAR cups_array_t *Jobs VALUE(NULL), | |
112 | /* List of current jobs */ | |
3dfe78b3 | 113 | *ActiveJobs VALUE(NULL), |
ef416fc2 | 114 | /* List of active jobs */ |
3dfe78b3 MS |
115 | *PrintingJobs VALUE(NULL); |
116 | /* List of jobs that are printing */ | |
ef416fc2 | 117 | VAR int NextJobId VALUE(1); |
118 | /* Next job ID to use */ | |
238c3832 MS |
119 | VAR int JobKillDelay VALUE(DEFAULT_TIMEOUT), |
120 | /* Delay before killing jobs */ | |
121 | JobRetryLimit VALUE(5), | |
ef416fc2 | 122 | /* Max number of tries */ |
123 | JobRetryInterval VALUE(300); | |
124 | /* Seconds between retries */ | |
125 | ||
126 | ||
127 | /* | |
128 | * Prototypes... | |
129 | */ | |
130 | ||
131 | extern cupsd_job_t *cupsdAddJob(int priority, const char *dest); | |
ef416fc2 | 132 | extern void cupsdCancelJobs(const char *dest, const char *username, |
133 | int purge); | |
134 | extern void cupsdCheckJobs(void); | |
135 | extern void cupsdCleanJobs(void); | |
b9faaae1 MS |
136 | extern void cupsdContinueJob(cupsd_job_t *job); |
137 | extern void cupsdDeleteJob(cupsd_job_t *job, | |
138 | cupsd_jobaction_t action); | |
ef416fc2 | 139 | extern cupsd_job_t *cupsdFindJob(int id); |
ef416fc2 | 140 | extern void cupsdFreeAllJobs(void); |
141 | extern int cupsdGetPrinterJobCount(const char *dest); | |
142 | extern int cupsdGetUserJobCount(const char *username); | |
ef416fc2 | 143 | extern void cupsdLoadAllJobs(void); |
dfd5680b | 144 | extern int cupsdLoadJob(cupsd_job_t *job); |
e53920b9 | 145 | extern void cupsdMoveJob(cupsd_job_t *job, cupsd_printer_t *p); |
ef416fc2 | 146 | extern void cupsdReleaseJob(cupsd_job_t *job); |
147 | extern void cupsdRestartJob(cupsd_job_t *job); | |
bd7854cb | 148 | extern void cupsdSaveAllJobs(void); |
ef416fc2 | 149 | extern void cupsdSaveJob(cupsd_job_t *job); |
b9faaae1 MS |
150 | extern void cupsdSetJobHoldUntil(cupsd_job_t *job, |
151 | const char *when, int update); | |
ef416fc2 | 152 | extern void cupsdSetJobPriority(cupsd_job_t *job, int priority); |
b9faaae1 MS |
153 | extern void cupsdSetJobState(cupsd_job_t *job, |
154 | ipp_jstate_t newstate, | |
155 | cupsd_jobaction_t action, | |
156 | const char *message, ...) | |
157 | #ifdef __GNUC__ | |
158 | __attribute__ ((__format__ (__printf__, 4, 5))) | |
159 | #endif /* __GNUC__ */ | |
160 | ; | |
238c3832 MS |
161 | extern void cupsdStopAllJobs(cupsd_jobaction_t action, |
162 | int kill_delay); | |
91c84a35 | 163 | extern int cupsdTimeoutJob(cupsd_job_t *job); |
bc44d920 | 164 | extern void cupsdUnloadCompletedJobs(void); |
ef416fc2 | 165 | |
166 | ||
167 | /* | |
b19ccc9e | 168 | * End of "$Id: job.h 7883 2008-08-28 20:38:13Z mike $". |
ef416fc2 | 169 | */ |