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

/*
 * "$Id: job.h 6593 2007-06-21 21:30:49Z mike $"
 *
 *   Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
 *
 *   Copyright 1997-2007 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 */
  int			pending_timeout;/* Non-zero if the job was created and waiting on files */
  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 */
  int			print_pipes[2],	/* Print data pipes */
			back_pipes[2],	/* Backchannel pipes */
			side_pipes[2],	/* Sidechannel pipes */
			status_pipes[2];/* Status pipes */
  cupsd_statbuf_t	*status_buffer;	/* Status buffer for this job */
  int			status_level;	/* Highest log level in a status message */
  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 */
  char			*auth_username,	/* AUTH_USERNAME environment variable, if any */
			*auth_domain,	/* AUTH_DOMAIN environment variable, if any */
			*auth_password;	/* AUTH_PASSWORD environment variable, if any */
#ifdef HAVE_GSSAPI
  char			*ccname;	/* KRB5CCNAME environment variable */
#endif /* HAVE_GSSAPI */
} 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,
			               ipp_jstate_t newstate);
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, cupsd_printer_t *p);
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(int force);
extern void		cupsdStopJob(cupsd_job_t *job, int force);
extern void		cupsdTimeoutJob(cupsd_job_t *job);


/*
 * End of "$Id: job.h 6593 2007-06-21 21:30:49Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
09a101d6	2	* "$Id: job.h 6593 2007-06-21 21:30:49Z mike $"
ef416fc2	3	*
	4	* Print job definitions for the Common UNIX Printing System (CUPS) scheduler.
	5	*
09a101d6	6	* Copyright 1997-2007 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 */
09a101d6	34	int pending_timeout;/* Non-zero if the job was created and waiting on files */
ef416fc2	35	char username; / Printing user */
	36	char dest; / Destination printer or class */
	37	cups_ptype_t dtype; /* Destination type (class/remote bits) */
ef416fc2	38	int num_files; /* Number of files in job */
ef416fc2	39	mime_type_t *filetypes; / File types */
ef416fc2	40	int compressions; / Compression status of each file */
bd7854cb	41	time_t access_time; /* Last access time */
	42	ipp_attribute_t sheets; / job-media-sheets-completed */
	43	time_t hold_until; /* Hold expiration date/time */
	44	ipp_attribute_t state; / Job state */
	45	ipp_attribute_t job_sheets; / Job sheets (NULL if none) */
	46	int current_file; /* Current file in job */
ef416fc2	47	ipp_t attrs; / Job attributes */
ef416fc2	48	int print_pipes[2], /* Print data pipes */
89d46774	49	back_pipes[2], /* Backchannel pipes */
f7deaa1a	50	side_pipes[2], /* Sidechannel pipes */
89d46774	51	status_pipes[2];/* Status pipes */
89d46774	52	cupsd_statbuf_t status_buffer; / Status buffer for this job */
09a101d6	53	int status_level; /* Highest log level in a status message */
ef416fc2	54	int cost; /* Filtering cost */
	55	int filters[MAX_FILTERS + 1];
	56	/* Filter process IDs, 0 terminated */
	57	int backend; /* Backend process ID */
	58	int status; /* Status code from filters */
	59	cupsd_printer_t printer; / Printer this job is assigned to */
	60	int tries; /* Number of tries for this job */
09a101d6	61	char auth_username, / AUTH_USERNAME environment variable, if any */
	62	auth_domain, / AUTH_DOMAIN environment variable, if any */
	63	auth_password; / AUTH_PASSWORD environment variable, if any */
f7deaa1a	64	#ifdef HAVE_GSSAPI
	65	char ccname; / KRB5CCNAME environment variable */
	66	#endif /* HAVE_GSSAPI */
ef416fc2	67	} cupsd_job_t;
	68
	69
	70	/*
	71	* Globals...
	72	*/
	73
	74	VAR int JobHistory VALUE(1);
	75	/* Preserve job history? */
	76	VAR int JobFiles VALUE(0);
	77	/* Preserve job files? */
	78	VAR int MaxJobs VALUE(0),
	79	/* Max number of jobs */
	80	MaxActiveJobs VALUE(0),
	81	/* Max number of active jobs */
	82	MaxJobsPerUser VALUE(0),
	83	/* Max jobs per user */
	84	MaxJobsPerPrinter VALUE(0);
	85	/* Max jobs per printer */
	86	VAR int JobAutoPurge VALUE(0);
	87	/* Automatically purge jobs */
	88	VAR cups_array_t *Jobs VALUE(NULL),
	89	/* List of current jobs */
	90	*ActiveJobs VALUE(NULL);
	91	/* List of active jobs */
	92	VAR int NextJobId VALUE(1);
	93	/* Next job ID to use */
	94	VAR int JobRetryLimit VALUE(5),
	95	/* Max number of tries */
	96	JobRetryInterval VALUE(300);
	97	/* Seconds between retries */
	98
	99
	100	/*
	101	* Prototypes...
	102	*/
	103
	104	extern cupsd_job_t cupsdAddJob(int priority, const char dest);
07725fee	105	extern void cupsdCancelJob(cupsd_job_t *job, int purge,
07725fee	106	ipp_jstate_t newstate);
ef416fc2	107	extern void cupsdCancelJobs(const char dest, const char username,
	108	int purge);
	109	extern void cupsdCheckJobs(void);
	110	extern void cupsdCleanJobs(void);
	111	extern void cupsdDeleteJob(cupsd_job_t *job);
	112	extern cupsd_job_t *cupsdFindJob(int id);
	113	extern void cupsdFinishJob(cupsd_job_t *job);
bd7854cb	114	extern void cupsdUnloadCompletedJobs(void);
ef416fc2	115	extern void cupsdFreeAllJobs(void);
	116	extern int cupsdGetPrinterJobCount(const char *dest);
	117	extern int cupsdGetUserJobCount(const char *username);
	118	extern void cupsdHoldJob(cupsd_job_t *job);
	119	extern void cupsdLoadAllJobs(void);
bd7854cb	120	extern void cupsdLoadJob(cupsd_job_t *job);
e53920b9	121	extern void cupsdMoveJob(cupsd_job_t job, cupsd_printer_t p);
ef416fc2	122	extern void cupsdReleaseJob(cupsd_job_t *job);
ef416fc2	123	extern void cupsdRestartJob(cupsd_job_t *job);
bd7854cb	124	extern void cupsdSaveAllJobs(void);
ef416fc2	125	extern void cupsdSaveJob(cupsd_job_t *job);
	126	extern void cupsdSetJobHoldUntil(cupsd_job_t job, const char when);
	127	extern void cupsdSetJobPriority(cupsd_job_t *job, int priority);
d09495fa	128	extern void cupsdStopAllJobs(int force);
ef416fc2	129	extern void cupsdStopJob(cupsd_job_t *job, int force);
09a101d6	130	extern void cupsdTimeoutJob(cupsd_job_t *job);
ef416fc2	131
	132
	133	/*
09a101d6	134	* End of "$Id: job.h 6593 2007-06-21 21:30:49Z mike $".
ef416fc2	135	*/