]>
git.ipfire.org Git - thirdparty/cups.git/blob - scheduler/job.h
2 * "$Id: job.h 6376 2007-03-21 06:39:10Z mike $"
4 * Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
6 * Copyright 1997-2006 by Easy Software Products, all rights reserved.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE.txt" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
26 * Job request structure...
29 typedef struct cupsd_job_s
32 priority
; /* Job priority */
33 ipp_jstate_t state_value
; /* Cached job-state */
34 char *username
; /* Printing user */
35 char *dest
; /* Destination printer or class */
36 cups_ptype_t dtype
; /* Destination type (class/remote bits) */
37 int num_files
; /* Number of files in job */
38 mime_type_t
**filetypes
; /* File types */
39 int *compressions
; /* Compression status of each file */
40 time_t access_time
; /* Last access time */
41 ipp_attribute_t
*sheets
; /* job-media-sheets-completed */
42 time_t hold_until
; /* Hold expiration date/time */
43 ipp_attribute_t
*state
; /* Job state */
44 ipp_attribute_t
*job_sheets
; /* Job sheets (NULL if none) */
45 int current_file
; /* Current file in job */
46 ipp_t
*attrs
; /* Job attributes */
47 int print_pipes
[2], /* Print data pipes */
48 back_pipes
[2], /* Backchannel pipes */
49 side_pipes
[2], /* Sidechannel pipes */
50 status_pipes
[2];/* Status pipes */
51 cupsd_statbuf_t
*status_buffer
; /* Status buffer for this job */
52 int cost
; /* Filtering cost */
53 int filters
[MAX_FILTERS
+ 1];
54 /* Filter process IDs, 0 terminated */
55 int backend
; /* Backend process ID */
56 int status
; /* Status code from filters */
57 cupsd_printer_t
*printer
; /* Printer this job is assigned to */
58 int tries
; /* Number of tries for this job */
60 char *ccname
; /* KRB5CCNAME environment variable */
61 #endif /* HAVE_GSSAPI */
69 VAR
int JobHistory
VALUE(1);
70 /* Preserve job history? */
71 VAR
int JobFiles
VALUE(0);
72 /* Preserve job files? */
73 VAR
int MaxJobs
VALUE(0),
74 /* Max number of jobs */
75 MaxActiveJobs
VALUE(0),
76 /* Max number of active jobs */
77 MaxJobsPerUser
VALUE(0),
78 /* Max jobs per user */
79 MaxJobsPerPrinter
VALUE(0);
80 /* Max jobs per printer */
81 VAR
int JobAutoPurge
VALUE(0);
82 /* Automatically purge jobs */
83 VAR cups_array_t
*Jobs
VALUE(NULL
),
84 /* List of current jobs */
85 *ActiveJobs
VALUE(NULL
);
86 /* List of active jobs */
87 VAR
int NextJobId
VALUE(1);
88 /* Next job ID to use */
89 VAR
int JobRetryLimit
VALUE(5),
90 /* Max number of tries */
91 JobRetryInterval
VALUE(300);
92 /* Seconds between retries */
99 extern cupsd_job_t
*cupsdAddJob(int priority
, const char *dest
);
100 extern void cupsdCancelJob(cupsd_job_t
*job
, int purge
,
101 ipp_jstate_t newstate
);
102 extern void cupsdCancelJobs(const char *dest
, const char *username
,
104 extern void cupsdCheckJobs(void);
105 extern void cupsdCleanJobs(void);
106 extern void cupsdDeleteJob(cupsd_job_t
*job
);
107 extern cupsd_job_t
*cupsdFindJob(int id
);
108 extern void cupsdFinishJob(cupsd_job_t
*job
);
109 extern void cupsdUnloadCompletedJobs(void);
110 extern void cupsdFreeAllJobs(void);
111 extern int cupsdGetPrinterJobCount(const char *dest
);
112 extern int cupsdGetUserJobCount(const char *username
);
113 extern void cupsdHoldJob(cupsd_job_t
*job
);
114 extern void cupsdLoadAllJobs(void);
115 extern void cupsdLoadJob(cupsd_job_t
*job
);
116 extern void cupsdMoveJob(cupsd_job_t
*job
, cupsd_printer_t
*p
);
117 extern void cupsdReleaseJob(cupsd_job_t
*job
);
118 extern void cupsdRestartJob(cupsd_job_t
*job
);
119 extern void cupsdSaveAllJobs(void);
120 extern void cupsdSaveJob(cupsd_job_t
*job
);
121 extern void cupsdSetJobHoldUntil(cupsd_job_t
*job
, const char *when
);
122 extern void cupsdSetJobPriority(cupsd_job_t
*job
, int priority
);
123 extern void cupsdStopAllJobs(int force
);
124 extern void cupsdStopJob(cupsd_job_t
*job
, int force
);
128 * End of "$Id: job.h 6376 2007-03-21 06:39:10Z mike $".