]>
git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/job.h
2 * "$Id: job.h 7883 2008-08-28 20:38:13Z mike $"
4 * Print job definitions for the CUPS scheduler.
6 * Copyright 2007-2011 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/".
20 typedef enum cupsd_jobaction_e
/**** Actions for state changes ****/
22 CUPSD_JOB_DEFAULT
, /* Use default action */
23 CUPSD_JOB_FORCE
, /* Force the change */
24 CUPSD_JOB_PURGE
/* Force the change and purge */
29 * Job request structure...
32 struct cupsd_job_s
/**** Job request ****/
35 priority
, /* Job priority */
36 dirty
; /* Do we need to write the "c" file? */
37 ipp_jstate_t state_value
; /* Cached job-state */
38 int pending_timeout
;/* Non-zero if the job was created and
40 char *username
; /* Printing user */
41 char *dest
; /* Destination printer or class */
42 cups_ptype_t dtype
; /* Destination type */
43 cupsd_printer_t
*printer
; /* Printer this job is assigned to */
44 int num_files
; /* Number of files in job */
45 mime_type_t
**filetypes
; /* File types */
46 int *compressions
; /* Compression status of each file */
47 ipp_attribute_t
*sheets
; /* job-media-sheets-completed */
48 time_t access_time
, /* Last access time */
49 cancel_time
, /* When to cancel/send SIGTERM */
50 file_time
, /* Job file retain time */
51 history_time
, /* Job history retain time */
52 hold_until
, /* Hold expiration date/time */
53 kill_time
; /* When to send SIGKILL */
54 ipp_attribute_t
*state
; /* Job state */
55 ipp_attribute_t
*reasons
; /* Job state reasons */
56 ipp_attribute_t
*job_sheets
; /* Job sheets (NULL if none) */
57 ipp_attribute_t
*printer_message
,
58 /* job-printer-state-message */
60 /* job-printer-state-reasons */
61 int current_file
; /* Current file in job */
62 ipp_t
*attrs
; /* Job attributes */
63 int print_pipes
[2], /* Print data pipes */
64 back_pipes
[2], /* Backchannel pipes */
65 side_pipes
[2], /* Sidechannel pipes */
66 status_pipes
[2];/* Status pipes */
67 cupsd_statbuf_t
*status_buffer
; /* Status buffer for this job */
68 int status_level
; /* Highest log level in a status
70 int cost
; /* Filtering cost */
71 int pending_cost
; /* Waiting for FilterLimit */
72 int filters
[MAX_FILTERS
+ 1];
73 /* Filter process IDs, 0 terminated */
74 int backend
; /* Backend process ID */
75 int status
; /* Status code from filters */
76 int tries
; /* Number of tries for this job */
77 char *auth_env
[3], /* AUTH_xxx environment variables,
79 *auth_uid
; /* AUTH_UID environment variable */
80 void *profile
; /* Security profile */
81 cups_array_t
*history
; /* Debug log history */
82 int progress
; /* Printing progress */
83 int num_keywords
; /* Number of PPD keywords */
84 cups_option_t
*keywords
; /* PPD keywords */
87 typedef struct cupsd_joblog_s
/**** Job log message ****/
89 time_t time
; /* Time of message */
90 char message
[1]; /* Message string */
98 VAR
int JobHistory
VALUE(INT_MAX
);
99 /* Preserve job history? */
100 VAR
int JobFiles
VALUE(86400);
101 /* Preserve job files? */
102 VAR
time_t JobHistoryUpdate
VALUE(0);
103 /* Time for next job history update */
104 VAR
int MaxJobs
VALUE(0),
105 /* Max number of jobs */
106 MaxActiveJobs
VALUE(0),
107 /* Max number of active jobs */
108 MaxHoldTime
VALUE(0),
109 /* Max time for indefinite hold */
110 MaxJobsPerUser
VALUE(0),
111 /* Max jobs per user */
112 MaxJobsPerPrinter
VALUE(0),
113 /* Max jobs per printer */
114 MaxJobTime
VALUE(3 * 60 * 60);
115 /* Max time for a job */
116 VAR
int JobAutoPurge
VALUE(0);
117 /* Automatically purge jobs */
118 VAR cups_array_t
*Jobs
VALUE(NULL
),
119 /* List of current jobs */
120 *ActiveJobs
VALUE(NULL
),
121 /* List of active jobs */
122 *PrintingJobs
VALUE(NULL
);
123 /* List of jobs that are printing */
124 VAR
int NextJobId
VALUE(1);
125 /* Next job ID to use */
126 VAR
int JobKillDelay
VALUE(DEFAULT_TIMEOUT
),
127 /* Delay before killing jobs */
128 JobRetryLimit
VALUE(5),
129 /* Max number of tries */
130 JobRetryInterval
VALUE(300);
131 /* Seconds between retries */
138 extern cupsd_job_t
*cupsdAddJob(int priority
, const char *dest
);
139 extern void cupsdCancelJobs(const char *dest
, const char *username
,
141 extern void cupsdCheckJobs(void);
142 extern void cupsdCleanJobs(void);
143 extern void cupsdContinueJob(cupsd_job_t
*job
);
144 extern void cupsdDeleteJob(cupsd_job_t
*job
,
145 cupsd_jobaction_t action
);
146 extern cupsd_job_t
*cupsdFindJob(int id
);
147 extern void cupsdFreeAllJobs(void);
148 extern int cupsdGetPrinterJobCount(const char *dest
);
149 extern int cupsdGetUserJobCount(const char *username
);
150 extern void cupsdLoadAllJobs(void);
151 extern int cupsdLoadJob(cupsd_job_t
*job
);
152 extern void cupsdMoveJob(cupsd_job_t
*job
, cupsd_printer_t
*p
);
153 extern void cupsdReleaseJob(cupsd_job_t
*job
);
154 extern void cupsdRestartJob(cupsd_job_t
*job
);
155 extern void cupsdSaveAllJobs(void);
156 extern void cupsdSaveJob(cupsd_job_t
*job
);
157 extern void cupsdSetJobHoldUntil(cupsd_job_t
*job
,
158 const char *when
, int update
);
159 extern void cupsdSetJobPriority(cupsd_job_t
*job
, int priority
);
160 extern void cupsdSetJobState(cupsd_job_t
*job
,
161 ipp_jstate_t newstate
,
162 cupsd_jobaction_t action
,
163 const char *message
, ...)
164 __attribute__((__format__(__printf__
,
166 extern void cupsdStopAllJobs(cupsd_jobaction_t action
,
168 extern int cupsdTimeoutJob(cupsd_job_t
*job
);
169 extern void cupsdUnloadCompletedJobs(void);
170 extern void cupsdUpdateJobs(void);
174 * End of "$Id: job.h 7883 2008-08-28 20:38:13Z mike $".