[thirdparty/cups.git] / scheduler / job.h

/*
 * "$Id: job.h 5305 2006-03-18 03:05:12Z mike $"
 *
 *   Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
 *
 *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products and are protected by Federal
 *   copyright law.  Distribution and use rights are outlined in the file
 *   "LICENSE.txt" which should have been included with this file.  If this
 *   file is missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 */

/*
 * Job request structure...
 */

typedef struct cupsd_job_s
{
  int			id,		/* Job ID */
			priority;	/* Job priority */
  ipp_jstate_t		state_value;	/* Cached job-state */
  char			*username;	/* Printing user */
  char			*dest;		/* Destination printer or class */
  cups_ptype_t		dtype;		/* Destination type (class/remote bits) */
  int			num_files;	/* Number of files in job */
  mime_type_t		**filetypes;	/* File types */
  int			*compressions;	/* Compression status of each file */
  time_t		access_time;	/* Last access time */
  ipp_attribute_t	*sheets;	/* job-media-sheets-completed */
  time_t		hold_until;	/* Hold expiration date/time */
  ipp_attribute_t	*state;		/* Job state */
  ipp_attribute_t	*job_sheets;	/* Job sheets (NULL if none) */
  int			current_file;	/* Current file in job */
  ipp_t			*attrs;		/* Job attributes */
  cupsd_statbuf_t	*status_buffer;	/* Status buffer for this job */
  int			print_pipes[2],	/* Print data pipes */
			back_pipes[2];	/* Backchannel pipes */
  int			cost;		/* Filtering cost */
  int			filters[MAX_FILTERS + 1];
					/* Filter process IDs, 0 terminated */
  int			backend;	/* Backend process ID */
  int			status;		/* Status code from filters */
  cupsd_printer_t	*printer;	/* Printer this job is assigned to */
  int			tries;		/* Number of tries for this job */
} cupsd_job_t;


/*
 * Globals...
 */

VAR int			JobHistory	VALUE(1);
					/* Preserve job history? */
VAR int			JobFiles	VALUE(0);
					/* Preserve job files? */
VAR int			MaxJobs		VALUE(0),
					/* Max number of jobs */
			MaxActiveJobs	VALUE(0),
					/* Max number of active jobs */
			MaxJobsPerUser	VALUE(0),
					/* Max jobs per user */
			MaxJobsPerPrinter VALUE(0);
					/* Max jobs per printer */
VAR int			JobAutoPurge	VALUE(0);
					/* Automatically purge jobs */
VAR cups_array_t	*Jobs		VALUE(NULL),
					/* List of current jobs */
			*ActiveJobs	VALUE(NULL);
					/* List of active jobs */
VAR int			NextJobId	VALUE(1);
					/* Next job ID to use */
VAR int			JobRetryLimit	VALUE(5),
					/* Max number of tries */
			JobRetryInterval VALUE(300);
					/* Seconds between retries */


/*
 * Prototypes...
 */

extern cupsd_job_t	*cupsdAddJob(int priority, const char *dest);
extern void		cupsdCancelJob(cupsd_job_t *job, int purge);
extern void		cupsdCancelJobs(const char *dest, const char *username,
			                int purge);
extern void		cupsdCheckJobs(void);
extern void		cupsdCleanJobs(void);
extern void		cupsdDeleteJob(cupsd_job_t *job);
extern cupsd_job_t	*cupsdFindJob(int id);
extern void		cupsdFinishJob(cupsd_job_t *job);
extern void		cupsdUnloadCompletedJobs(void);
extern void		cupsdFreeAllJobs(void);
extern int		cupsdGetPrinterJobCount(const char *dest);
extern int		cupsdGetUserJobCount(const char *username);
extern void		cupsdHoldJob(cupsd_job_t *job);
extern void		cupsdLoadAllJobs(void);
extern void		cupsdLoadJob(cupsd_job_t *job);
extern void		cupsdMoveJob(cupsd_job_t *job, const char *dest);
extern void		cupsdReleaseJob(cupsd_job_t *job);
extern void		cupsdRestartJob(cupsd_job_t *job);
extern void		cupsdSaveAllJobs(void);
extern void		cupsdSaveJob(cupsd_job_t *job);
extern void		cupsdSetJobHoldUntil(cupsd_job_t *job, const char *when);
extern void		cupsdSetJobPriority(cupsd_job_t *job, int priority);
extern void		cupsdStopAllJobs(void);
extern void		cupsdStopJob(cupsd_job_t *job, int force);
extern void		cupsdUpdateJob(cupsd_job_t *job);


/*
 * End of "$Id: job.h 5305 2006-03-18 03:05:12Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
e1d6a774	2	* "$Id: job.h 5305 2006-03-18 03:05:12Z mike $"
ef416fc2	3	*
	4	* Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
	5	*
bd7854cb	6	* Copyright 1997-2006 by Easy Software Products, all rights reserved.
ef416fc2	7	*
	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
	13	* at:
	14	*
	15	* Attn: CUPS Licensing Information
	16	* Easy Software Products
	17	* 44141 Airport View Drive, Suite 204
	18	* Hollywood, Maryland 20636 USA
	19	*
	20	* Voice: (301) 373-9600
	21	* EMail: cups-info@cups.org
	22	* WWW: http://www.cups.org
	23	*/
	24
	25	/*
	26	* Job request structure...
	27	*/
	28
	29	typedef struct cupsd_job_s
	30	{
	31	int id, /* Job ID */
	32	priority; /* Job priority */
bd7854cb	33	ipp_jstate_t state_value; /* Cached job-state */
ef416fc2	34	char username; / Printing user */
	35	char dest; / Destination printer or class */
	36	cups_ptype_t dtype; /* Destination type (class/remote bits) */
ef416fc2	37	int num_files; /* Number of files in job */
ef416fc2	38	mime_type_t *filetypes; / File types */
ef416fc2	39	int compressions; / Compression status of each file */
bd7854cb	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 */
ef416fc2	46	ipp_t attrs; / Job attributes */
	47	cupsd_statbuf_t status_buffer; / Status buffer for this job */
	48	int print_pipes[2], /* Print data pipes */
	49	back_pipes[2]; /* Backchannel pipes */
	50	int cost; /* Filtering cost */
	51	int filters[MAX_FILTERS + 1];
	52	/* Filter process IDs, 0 terminated */
	53	int backend; /* Backend process ID */
	54	int status; /* Status code from filters */
	55	cupsd_printer_t printer; / Printer this job is assigned to */
	56	int tries; /* Number of tries for this job */
	57	} cupsd_job_t;
	58
	59
	60	/*
	61	* Globals...
	62	*/
	63
	64	VAR int JobHistory VALUE(1);
	65	/* Preserve job history? */
	66	VAR int JobFiles VALUE(0);
	67	/* Preserve job files? */
	68	VAR int MaxJobs VALUE(0),
	69	/* Max number of jobs */
	70	MaxActiveJobs VALUE(0),
	71	/* Max number of active jobs */
	72	MaxJobsPerUser VALUE(0),
	73	/* Max jobs per user */
	74	MaxJobsPerPrinter VALUE(0);
	75	/* Max jobs per printer */
	76	VAR int JobAutoPurge VALUE(0);
	77	/* Automatically purge jobs */
	78	VAR cups_array_t *Jobs VALUE(NULL),
	79	/* List of current jobs */
	80	*ActiveJobs VALUE(NULL);
	81	/* List of active jobs */
	82	VAR int NextJobId VALUE(1);
	83	/* Next job ID to use */
	84	VAR int JobRetryLimit VALUE(5),
	85	/* Max number of tries */
	86	JobRetryInterval VALUE(300);
	87	/* Seconds between retries */
	88
	89
	90	/*
	91	* Prototypes...
	92	*/
	93
	94	extern cupsd_job_t cupsdAddJob(int priority, const char dest);
	95	extern void cupsdCancelJob(cupsd_job_t *job, int purge);
	96	extern void cupsdCancelJobs(const char dest, const char username,
	97	int purge);
	98	extern void cupsdCheckJobs(void);
	99	extern void cupsdCleanJobs(void);
	100	extern void cupsdDeleteJob(cupsd_job_t *job);
	101	extern cupsd_job_t *cupsdFindJob(int id);
	102	extern void cupsdFinishJob(cupsd_job_t *job);
bd7854cb	103	extern void cupsdUnloadCompletedJobs(void);
ef416fc2	104	extern void cupsdFreeAllJobs(void);
	105	extern int cupsdGetPrinterJobCount(const char *dest);
	106	extern int cupsdGetUserJobCount(const char *username);
	107	extern void cupsdHoldJob(cupsd_job_t *job);
	108	extern void cupsdLoadAllJobs(void);
bd7854cb	109	extern void cupsdLoadJob(cupsd_job_t *job);
ef416fc2	110	extern void cupsdMoveJob(cupsd_job_t job, const char dest);
	111	extern void cupsdReleaseJob(cupsd_job_t *job);
	112	extern void cupsdRestartJob(cupsd_job_t *job);
bd7854cb	113	extern void cupsdSaveAllJobs(void);
ef416fc2	114	extern void cupsdSaveJob(cupsd_job_t *job);
	115	extern void cupsdSetJobHoldUntil(cupsd_job_t job, const char when);
	116	extern void cupsdSetJobPriority(cupsd_job_t *job, int priority);
ef416fc2	117	extern void cupsdStopAllJobs(void);
	118	extern void cupsdStopJob(cupsd_job_t *job, int force);
	119	extern void cupsdUpdateJob(cupsd_job_t *job);
	120
	121
	122	/*
e1d6a774	123	* End of "$Id: job.h 5305 2006-03-18 03:05:12Z mike $".
ef416fc2	124	*/