2 * "$Id: ipp.h 7847 2008-08-19 04:22:14Z mike $"
4 * Internet Printing Protocol definitions for CUPS.
6 * Copyright 2007-2013 by Apple Inc.
7 * Copyright 1997-2006 by Easy Software Products.
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
22 * Include necessary headers...
35 # endif /* __cplusplus */
39 * IPP version string...
42 # define IPP_VERSION "\002\001"
45 * IPP registered port number...
47 * Note: Applications should never use IPP_PORT, but instead use the
48 * ippPort() function to allow overrides via the IPP_PORT environment
49 * variable and services file if needed!
58 # define IPP_MAX_CHARSET 64 /* Maximum length of charset values w/nul */
59 # define IPP_MAX_KEYWORD 256 /* Maximum length of keyword values w/nul */
60 # define IPP_MAX_LANGUAGE 64 /* Maximum length of naturalLanguage values w/nul */
61 # define IPP_MAX_LENGTH 32767 /* Maximum size of any single value */
62 # define IPP_MAX_MIMETYPE 256 /* Maximum length of mimeMediaType values w/nul */
63 # define IPP_MAX_NAME 256 /* Maximum length of common name values w/nul */
64 # define IPP_MAX_OCTETSTRING 1023 /* Maximum length of octetString values w/o nul */
65 # define IPP_MAX_TEXT 1024 /* Maximum length of text values w/nul */
66 # define IPP_MAX_URI 1024 /* Maximum length of uri values w/nul */
67 # define IPP_MAX_URISCHEME 64 /* Maximum length of uriScheme values w/nul */
68 # define IPP_MAX_VALUES 8 /* Power-of-2 allocation increment */
72 * Types and structures...
75 typedef enum ipp_dstate_e
/**** Document states ****/
77 IPP_DOCUMENT_PENDING
= 3, /* Document is pending */
78 IPP_DOCUMENT_PROCESSING
= 5, /* Document is processing */
79 IPP_DOCUMENT_CANCELED
= 7, /* Document is canceled */
80 IPP_DOCUMENT_ABORTED
, /* Document is aborted */
81 IPP_DOCUMENT_COMPLETED
/* Document is completed */
83 # ifndef _CUPS_NO_DEPRECATED
84 # define IPP_DOCUMENT_PENDING IPP_DSTATE_PENDING
85 # define IPP_DOCUMENT_PROCESSING IPP_DSTATE_PROCESSING
86 # define IPP_DOCUMENT_CANCELED IPP_DSTATE_CANCELED
87 # define IPP_DOCUMENT_ABORTED IPP_DSTATE_ABORTED
88 # define IPP_DOCUMENT_COMPLETED IPP_DSTATE_COMPLETED
89 # endif /* !_CUPS_NO_DEPRECATED */
92 typedef enum ipp_finishings_e
/**** Finishings ****/
94 IPP_FINISHINGS_NONE
= 3, /* No finishing */
95 IPP_FINISHINGS_STAPLE
, /* Staple (any location) */
96 IPP_FINISHINGS_PUNCH
, /* Punch (any location/count) */
97 IPP_FINISHINGS_COVER
, /* Add cover */
98 IPP_FINISHINGS_BIND
, /* Bind */
99 IPP_FINISHINGS_SADDLE_STITCH
, /* Staple interior */
100 IPP_FINISHINGS_EDGE_STITCH
, /* Stitch along any side */
101 IPP_FINISHINGS_FOLD
, /* Fold (any type) */
102 IPP_FINISHINGS_TRIM
, /* Trim (any type) */
103 IPP_FINISHINGS_BALE
, /* Bale (any type) */
104 IPP_FINISHINGS_BOOKLET_MAKER
, /* Fold to make booklet */
105 IPP_FINISHINGS_JOB_OFFSET
, /* Offset for binding (any type) */
106 IPP_FINISHINGS_STAPLE_TOP_LEFT
= 20, /* Staple top left corner */
107 IPP_FINISHINGS_STAPLE_BOTTOM_LEFT
, /* Staple bottom left corner */
108 IPP_FINISHINGS_STAPLE_TOP_RIGHT
, /* Staple top right corner */
109 IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT
, /* Staple bottom right corner */
110 IPP_FINISHINGS_EDGE_STITCH_LEFT
, /* Stitch along left side */
111 IPP_FINISHINGS_EDGE_STITCH_TOP
, /* Stitch along top edge */
112 IPP_FINISHINGS_EDGE_STITCH_RIGHT
, /* Stitch along right side */
113 IPP_FINISHINGS_EDGE_STITCH_BOTTOM
, /* Stitch along bottom edge */
114 IPP_FINISHINGS_STAPLE_DUAL_LEFT
, /* Two staples on left */
115 IPP_FINISHINGS_STAPLE_DUAL_TOP
, /* Two staples on top */
116 IPP_FINISHINGS_STAPLE_DUAL_RIGHT
, /* Two staples on right */
117 IPP_FINISHINGS_STAPLE_DUAL_BOTTOM
, /* Two staples on bottom */
118 IPP_FINISHINGS_BIND_LEFT
= 50, /* Bind on left */
119 IPP_FINISHINGS_BIND_TOP
, /* Bind on top */
120 IPP_FINISHINGS_BIND_RIGHT
, /* Bind on right */
121 IPP_FINISHINGS_BIND_BOTTOM
, /* Bind on bottom */
122 IPP_FINISHINGS_TRIM_AFTER_PAGES
= 60, /* Trim output after each page */
123 IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS
, /* Trim output after each document */
124 IPP_FINISHINGS_TRIM_AFTER_COPIES
, /* Trim output after each copy */
125 IPP_FINISHINGS_TRIM_AFTER_JOB
, /* Trim output after job */
127 /* Proposed extensions for finishings */
128 IPP_FINISHINGS_CUPS_PUNCH_TOP_LEFT
= 0x40000046,
129 /* Punch 1 hole top left */
130 IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT
,/* Punch 1 hole bottom left */
131 IPP_FINISHINGS_CUPS_PUNCH_TOP_RIGHT
, /* Punch 1 hole top right */
132 IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT
,
133 /* Punch 1 hole bottom right */
134 IPP_FINISHINGS_CUPS_PUNCH_DUAL_LEFT
, /* Punch 2 holes left side */
135 IPP_FINISHINGS_CUPS_PUNCH_DUAL_TOP
, /* Punch 2 holes top edge */
136 IPP_FINISHINGS_CUPS_PUNCH_DUAL_RIGHT
, /* Punch 2 holes right side */
137 IPP_FINISHINGS_CUPS_PUNCH_DUAL_BOTTOM
,/* Punch 2 holes bottom edge */
138 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_LEFT
,/* Punch 3 holes left side */
139 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_TOP
, /* Punch 3 holes top edge */
140 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_RIGHT
,
141 /* Punch 3 holes right side */
142 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_BOTTOM
,
143 /* Punch 3 holes bottom edge */
144 IPP_FINISHINGS_CUPS_PUNCH_QUAD_LEFT
, /* Punch 4 holes left side */
145 IPP_FINISHINGS_CUPS_PUNCH_QUAD_TOP
, /* Punch 4 holes top edge */
146 IPP_FINISHINGS_CUPS_PUNCH_QUAD_RIGHT
, /* Punch 4 holes right side */
147 IPP_FINISHINGS_CUPS_PUNCH_QUAD_BOTTOM
/* Punch 4 holes bottom edge */
149 # ifndef _CUPS_NO_DEPRECATED
150 typedef enum ipp_finishings_e ipp_finish_t
;
151 # endif /* !_CUPS_NO_DEPRECATED */
153 typedef enum ipp_jcollate_e
/**** Job collation types ****/
155 IPP_JCOLLATE_UNCOLLATED_SHEETS
= 3,
156 IPP_JCOLLATE_COLLATED_DOCUMENTS
,
157 IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
159 # ifndef _CUPS_NO_DEPRECATED
160 # define IPP_JOB_UNCOLLATED_SHEETS IPP_JCOLLATE_UNCOLLATED_SHEETS
161 # define IPP_JOB_COLLATED_DOCUMENTS IPP_JCOLLATE_COLLATED_DOCUMENTS
162 # define IPP_JOB_UNCOLLATED_DOCUMENTS IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
163 # endif /* !_CUPS_NO_DEPRECATED */
166 typedef enum ipp_jstate_e
/**** Job states ****/
168 IPP_JSTATE_PENDING
= 3, /* Job is waiting to be printed */
169 IPP_JSTATE_HELD
, /* Job is held for printing */
170 IPP_JSTATE_PROCESSING
, /* Job is currently printing */
171 IPP_JSTATE_STOPPED
, /* Job has been stopped */
172 IPP_JSTATE_CANCELED
, /* Job has been canceled */
173 IPP_JSTATE_ABORTED
, /* Job has aborted due to error */
174 IPP_JSTATE_COMPLETED
/* Job has completed successfully */
176 # ifndef _CUPS_NO_DEPRECATED
177 # define IPP_JOB_PENDING IPP_JSTATE_PENDING
178 # define IPP_JOB_HELD IPP_JSTATE_HELD
179 # define IPP_JOB_PROCESSING IPP_JSTATE_PROCESSING
180 # define IPP_JOB_STOPPED IPP_JSTATE_STOPPED
181 # define IPP_JOB_CANCELED IPP_JSTATE_CANCELED
182 # define IPP_JOB_ABORTED IPP_JSTATE_ABORTED
183 # define IPP_JOB_COMPLETED IPP_JSTATE_COMPLETED
184 /* Legacy name for canceled state */
185 # define IPP_JOB_CANCELLED IPP_JSTATE_CANCELED
186 # endif /* !_CUPS_NO_DEPRECATED */
189 typedef enum ipp_op_e
/**** IPP operations ****/
191 IPP_OP_CUPS_INVALID
= -1, /* Invalid operation name for @link ippOpValue@ */
192 IPP_OP_CUPS_NONE
= 0, /* No operation @private@ */
193 IPP_OP_PRINT_JOB
= 0x0002, /* Print a single file */
194 IPP_OP_PRINT_URI
, /* Print a single URL @private@ */
195 IPP_OP_VALIDATE_JOB
, /* Validate job options */
196 IPP_OP_CREATE_JOB
, /* Create an empty print job */
197 IPP_OP_SEND_DOCUMENT
, /* Add a file to a job */
198 IPP_OP_SEND_URI
, /* Add a URL to a job @private@ */
199 IPP_OP_CANCEL_JOB
, /* Cancel a job */
200 IPP_OP_GET_JOB_ATTRIBUTES
, /* Get job attributes */
201 IPP_OP_GET_JOBS
, /* Get a list of jobs */
202 IPP_OP_GET_PRINTER_ATTRIBUTES
, /* Get printer attributes */
203 IPP_OP_HOLD_JOB
, /* Hold a job for printing */
204 IPP_OP_RELEASE_JOB
, /* Release a job for printing */
205 IPP_OP_RESTART_JOB
, /* Reprint a job */
206 IPP_OP_PAUSE_PRINTER
= 0x0010, /* Stop a printer */
207 IPP_OP_RESUME_PRINTER
, /* Start a printer */
208 IPP_OP_PURGE_JOBS
, /* Cancel all jobs */
209 IPP_OP_SET_PRINTER_ATTRIBUTES
, /* Set printer attributes @private@ */
210 IPP_OP_SET_JOB_ATTRIBUTES
, /* Set job attributes */
211 IPP_OP_GET_PRINTER_SUPPORTED_VALUES
, /* Get supported attribute values */
212 IPP_OP_CREATE_PRINTER_SUBSCRIPTION
, /* Create a printer subscription @since CUPS 1.2/OS X 10.5@ */
213 IPP_OP_CREATE_JOB_SUBSCRIPTION
, /* Create a job subscription @since CUPS 1.2/OS X 10.5@ */
214 IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES
, /* Get subscription attributes @since CUPS 1.2/OS X 10.5@ */
215 IPP_OP_GET_SUBSCRIPTIONS
, /* Get list of subscriptions @since CUPS 1.2/OS X 10.5@ */
216 IPP_OP_RENEW_SUBSCRIPTION
, /* Renew a printer subscription @since CUPS 1.2/OS X 10.5@ */
217 IPP_OP_CANCEL_SUBSCRIPTION
, /* Cancel a subscription @since CUPS 1.2/OS X 10.5@ */
218 IPP_OP_GET_NOTIFICATIONS
, /* Get notification events @since CUPS 1.2/OS X 10.5@ */
219 IPP_OP_SEND_NOTIFICATIONS
, /* Send notification events @private@ */
220 IPP_OP_GET_RESOURCE_ATTRIBUTES
, /* Get resource attributes @private@ */
221 IPP_OP_GET_RESOURCE_DATA
, /* Get resource data @private@ */
222 IPP_OP_GET_RESOURCES
, /* Get list of resources @private@ */
223 IPP_OP_GET_PRINT_SUPPORT_FILES
, /* Get printer support files @private@ */
224 IPP_OP_ENABLE_PRINTER
, /* Start a printer */
225 IPP_OP_DISABLE_PRINTER
, /* Stop a printer */
226 IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB
,
227 /* Stop printer after the current job @private@ */
228 IPP_OP_HOLD_NEW_JOBS
, /* Hold new jobs @private@ */
229 IPP_OP_RELEASE_HELD_NEW_JOBS
, /* Release new jobs @private@ */
230 IPP_OP_DEACTIVATE_PRINTER
, /* Stop a printer @private@ */
231 IPP_OP_ACTIVATE_PRINTER
, /* Start a printer @private@ */
232 IPP_OP_RESTART_PRINTER
, /* Restart a printer @private@ */
233 IPP_OP_SHUTDOWN_PRINTER
, /* Turn a printer off @private@ */
234 IPP_OP_STARTUP_PRINTER
, /* Turn a printer on @private@ */
235 IPP_OP_REPROCESS_JOB
, /* Reprint a job @private@ */
236 IPP_OP_CANCEL_CURRENT_JOB
, /* Cancel the current job @private@ */
237 IPP_OP_SUSPEND_CURRENT_JOB
, /* Suspend the current job @private@ */
238 IPP_OP_RESUME_JOB
, /* Resume the current job @private@ */
239 IPP_OP_PROMOTE_JOB
, /* Promote a job to print sooner @private@ */
240 IPP_OP_SCHEDULE_JOB_AFTER
, /* Schedule a job to print after another @private@ */
241 IPP_OP_CANCEL_DOCUMENT
= 0x0033, /* Cancel-Document @private@ */
242 IPP_OP_GET_DOCUMENT_ATTRIBUTES
, /* Get-Document-Attributes @private@ */
243 IPP_OP_GET_DOCUMENTS
, /* Get-Documents @private@ */
244 IPP_OP_DELETE_DOCUMENT
, /* Delete-Document @private@ */
245 IPP_OP_SET_DOCUMENT_ATTRIBUTES
, /* Set-Document-Attributes @private@ */
246 IPP_OP_CANCEL_JOBS
, /* Cancel-Jobs */
247 IPP_OP_CANCEL_MY_JOBS
, /* Cancel-My-Jobs */
248 IPP_OP_RESUBMIT_JOB
, /* Resubmit-Job */
249 IPP_OP_CLOSE_JOB
, /* Close-Job */
250 IPP_OP_IDENTIFY_PRINTER
, /* Identify-Printer (proposed IPP JPS3) */
251 IPP_OP_VALIDATE_DOCUMENT
, /* Validate-Document (proposed IPP JPS3) */
252 IPP_OP_PRIVATE
= 0x4000, /* Reserved @private@ */
253 IPP_OP_CUPS_GET_DEFAULT
, /* Get the default printer */
254 IPP_OP_CUPS_GET_PRINTERS
, /* Get a list of printers and/or classes */
255 IPP_OP_CUPS_ADD_MODIFY_PRINTER
, /* Add or modify a printer */
256 IPP_OP_CUPS_DELETE_PRINTER
, /* Delete a printer */
257 IPP_OP_CUPS_GET_CLASSES
, /* Get a list of classes @deprecated@ */
258 IPP_OP_CUPS_ADD_MODIFY_CLASS
, /* Add or modify a class */
259 IPP_OP_CUPS_DELETE_CLASS
, /* Delete a class */
260 IPP_OP_CUPS_ACCEPT_JOBS
, /* Accept new jobs on a printer */
261 IPP_OP_CUPS_REJECT_JOBS
, /* Reject new jobs on a printer */
262 IPP_OP_CUPS_SET_DEFAULT
, /* Set the default printer */
263 IPP_OP_CUPS_GET_DEVICES
, /* Get a list of supported devices */
264 IPP_OP_CUPS_GET_PPDS
, /* Get a list of supported drivers */
265 IPP_OP_CUPS_MOVE_JOB
, /* Move a job to a different printer */
266 IPP_OP_CUPS_AUTHENTICATE_JOB
, /* Authenticate a job @since CUPS 1.2/OS X 10.5@ */
267 IPP_OP_CUPS_GET_PPD
, /* Get a PPD file @since CUPS 1.3/OS X 10.5@ */
268 IPP_OP_CUPS_GET_DOCUMENT
= 0x4027 /* Get a document file @since CUPS 1.4/OS X 10.6@ */
270 # ifndef _CUPS_NO_DEPRECATED
271 # define IPP_PRINT_JOB IPP_OP_PRINT_JOB
272 # define IPP_PRINT_URI IPP_OP_PRINT_URI
273 # define IPP_VALIDATE_JOB IPP_OP_VALIDATE_JOB
274 # define IPP_CREATE_JOB IPP_OP_CREATE_JOB
275 # define IPP_SEND_DOCUMENT IPP_OP_SEND_DOCUMENT
276 # define IPP_SEND_URI IPP_OP_SEND_URI
277 # define IPP_CANCEL_JOB IPP_OP_CANCEL_JOB
278 # define IPP_GET_JOB_ATTRIBUTES IPP_OP_GET_JOB_ATTRIBUTES
279 # define IPP_GET_JOBS IPP_OP_GET_JOBS
280 # define IPP_GET_PRINTER_ATTRIBUTES IPP_OP_GET_PRINTER_ATTRIBUTES
281 # define IPP_HOLD_JOB IPP_OP_HOLD_JOB
282 # define IPP_RELEASE_JOB IPP_OP_RELEASE_JOB
283 # define IPP_RESTART_JOB IPP_OP_RESTART_JOB
284 # define IPP_PAUSE_PRINTER IPP_OP_PAUSE_PRINTER
285 # define IPP_RESUME_PRINTER IPP_OP_RESUME_PRINTER
286 # define IPP_PURGE_JOBS IPP_OP_PURGE_JOBS
287 # define IPP_SET_PRINTER_ATTRIBUTES IPP_OP_SET_PRINTER_ATTRIBUTES
288 # define IPP_SET_JOB_ATTRIBUTES IPP_OP_SET_JOB_ATTRIBUTES
289 # define IPP_GET_PRINTER_SUPPORTED_VALUES IPP_OP_GET_PRINTER_SUPPORTED_VALUES
290 # define IPP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTION
291 # define IPP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTION
292 # define IPP_GET_SUBSCRIPTION_ATTRIBUTES IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES
293 # define IPP_GET_SUBSCRIPTIONS IPP_OP_GET_SUBSCRIPTIONS
294 # define IPP_RENEW_SUBSCRIPTION IPP_OP_RENEW_SUBSCRIPTION
295 # define IPP_CANCEL_SUBSCRIPTION IPP_OP_CANCEL_SUBSCRIPTION
296 # define IPP_GET_NOTIFICATIONS IPP_OP_GET_NOTIFICATIONS
297 # define IPP_SEND_NOTIFICATIONS IPP_OP_SEND_NOTIFICATIONS
298 # define IPP_GET_RESOURCE_ATTRIBUTES IPP_OP_GET_RESOURCE_ATTRIBUTES
299 # define IPP_GET_RESOURCE_DATA IPP_OP_GET_RESOURCE_DATA
300 # define IPP_GET_RESOURCES IPP_OP_GET_RESOURCES
301 # define IPP_GET_PRINT_SUPPORT_FILES IPP_OP_GET_PRINT_SUPPORT_FILES
302 # define IPP_ENABLE_PRINTER IPP_OP_ENABLE_PRINTER
303 # define IPP_DISABLE_PRINTER IPP_OP_DISABLE_PRINTER
304 # define IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB
305 # define IPP_HOLD_NEW_JOBS IPP_OP_HOLD_NEW_JOBS
306 # define IPP_RELEASE_HELD_NEW_JOBS IPP_OP_RELEASE_HELD_NEW_JOBS
307 # define IPP_DEACTIVATE_PRINTER IPP_OP_DEACTIVATE_PRINTER
308 # define IPP_ACTIVATE_PRINTER IPP_OP_ACTIVATE_PRINTER
309 # define IPP_RESTART_PRINTER IPP_OP_RESTART_PRINTER
310 # define IPP_SHUTDOWN_PRINTER IPP_OP_SHUTDOWN_PRINTER
311 # define IPP_STARTUP_PRINTER IPP_OP_STARTUP_PRINTER
312 # define IPP_REPROCESS_JOB IPP_OP_REPROCESS_JOB
313 # define IPP_CANCEL_CURRENT_JOB IPP_OP_CANCEL_CURRENT_JOB
314 # define IPP_SUSPEND_CURRENT_JOB IPP_OP_SUSPEND_CURRENT_JOB
315 # define IPP_RESUME_JOB IPP_OP_RESUME_JOB
316 # define IPP_PROMOTE_JOB IPP_OP_PROMOTE_JOB
317 # define IPP_SCHEDULE_JOB_AFTER IPP_OP_SCHEDULE_JOB_AFTER
318 # define IPP_CANCEL_DOCUMENT IPP_OP_CANCEL_DOCUMENT
319 # define IPP_GET_DOCUMENT_ATTRIBUTES IPP_OP_GET_DOCUMENT_ATTRIBUTES
320 # define IPP_GET_DOCUMENTS IPP_OP_GET_DOCUMENTS
321 # define IPP_DELETE_DOCUMENT IPP_OP_DELETE_DOCUMENT
322 # define IPP_SET_DOCUMENT_ATTRIBUTES IPP_OP_SET_DOCUMENT_ATTRIBUTES
323 # define IPP_CANCEL_JOBS IPP_OP_CANCEL_JOBS
324 # define IPP_CANCEL_MY_JOBS IPP_OP_CANCEL_MY_JOBS
325 # define IPP_RESUBMIT_JOB IPP_OP_RESUBMIT_JOB
326 # define IPP_CLOSE_JOB IPP_OP_CLOSE_JOB
327 # define IPP_IDENTIFY_PRINTER IPP_OP_IDENTIFY_PRINTER
328 # define IPP_VALIDATE_DOCUMENT IPP_OP_VALIDATE_DOCUMENT
329 # define IPP_PRIVATE IPP_OP_PRIVATE
330 # define CUPS_GET_DEFAULT IPP_OP_CUPS_GET_DEFAULT
331 # define CUPS_GET_PRINTERS IPP_OP_CUPS_GET_PRINTERS
332 # define CUPS_ADD_MODIFY_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
333 # define CUPS_DELETE_PRINTER IPP_OP_CUPS_DELETE_PRINTER
334 # define CUPS_GET_CLASSES IPP_OP_CUPS_GET_CLASSES
335 # define CUPS_ADD_MODIFY_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
336 # define CUPS_DELETE_CLASS IPP_OP_CUPS_DELETE_CLASS
337 # define CUPS_ACCEPT_JOBS IPP_OP_CUPS_ACCEPT_JOBS
338 # define CUPS_REJECT_JOBS IPP_OP_CUPS_REJECT_JOBS
339 # define CUPS_SET_DEFAULT IPP_OP_CUPS_SET_DEFAULT
340 # define CUPS_GET_DEVICES IPP_OP_CUPS_GET_DEVICES
341 # define CUPS_GET_PPDS IPP_OP_CUPS_GET_PPDS
342 # define CUPS_MOVE_JOB IPP_OP_CUPS_MOVE_JOB
343 # define CUPS_AUTHENTICATE_JOB IPP_OP_CUPS_AUTHENTICATE_JOB
344 # define CUPS_GET_PPD IPP_OP_CUPS_GET_PPD
345 # define CUPS_GET_DOCUMENT IPP_OP_CUPS_GET_DOCUMENT
347 # define CUPS_ADD_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
348 # define CUPS_ADD_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
349 # endif /* !_CUPS_NO_DEPRECATED */
352 typedef enum ipp_orient_e
/**** Orientation values ****/
354 IPP_ORIENT_PORTRAIT
= 3, /* No rotation */
355 IPP_ORIENT_LANDSCAPE
, /* 90 degrees counter-clockwise */
356 IPP_ORIENT_REVERSE_LANDSCAPE
, /* 90 degrees clockwise */
357 IPP_ORIENT_REVERSE_PORTRAIT
/* 180 degrees */
359 # ifndef _CUPS_NO_DEPRECATED
360 # define IPP_PORTRAIT IPP_ORIENT_PORTRAIT
361 # define IPP_LANDSCAPE IPP_ORIENT_LANDSCAPE
362 # define IPP_REVERSE_LANDSCAPE IPP_ORIENT_REVERSE_LANDSCAPE
363 # define IPP_REVERSE_PORTRAIT IPP_ORIENT_REVERSE_PORTRAIT
364 # endif /* !_CUPS_NO_DEPRECATED */
367 typedef enum ipp_pstate_e
/**** Printer states ****/
369 IPP_PSTATE_IDLE
= 3, /* Printer is idle */
370 IPP_PSTATE_PROCESSING
, /* Printer is working */
371 IPP_PSTATE_STOPPED
/* Printer is stopped */
373 # ifndef _CUPS_NO_DEPRECATED
374 # define IPP_PRINTER_IDLE IPP_PSTATE_IDLE
375 # define IPP_PRINTER_PROCESSING IPP_PSTATE_PROCESSING
376 # define IPP_PRINTER_STOPPED IPP_PSTATE_STOPPED
377 # endif /* _CUPS_NO_DEPRECATED */
380 typedef enum ipp_quality_e
/**** Qualities ****/
382 IPP_QUALITY_DRAFT
= 3, /* Draft quality */
383 IPP_QUALITY_NORMAL
, /* Normal quality */
384 IPP_QUALITY_HIGH
/* High quality */
387 typedef enum ipp_res_e
/**** Resolution units ****/
389 IPP_RES_PER_INCH
= 3, /* Pixels per inch */
390 IPP_RES_PER_CM
/* Pixels per centimeter */
393 typedef enum ipp_state_e
/**** IPP states ****/
395 IPP_STATE_ERROR
= -1, /* An error occurred */
396 IPP_STATE_IDLE
, /* Nothing is happening/request completed */
397 IPP_STATE_HEADER
, /* The request header needs to be sent/received */
398 IPP_STATE_ATTRIBUTE
, /* One or more attributes need to be sent/received */
399 IPP_STATE_DATA
/* IPP request data needs to be sent/received */
401 # ifndef _CUPS_NO_DEPRECATED
402 # define IPP_ERROR IPP_STATE_ERROR
403 # define IPP_IDLE IPP_STATE_IDLE
404 # define IPP_HEADER IPP_STATE_HEADER
405 # define IPP_ATTRIBUTE IPP_STATE_ATTRIBUTE
406 # define IPP_DATA IPP_STATE_DATA
407 # endif /* !_CUPS_NO_DEPRECATED */
410 typedef enum ipp_status_e
/**** IPP status codes ****/
412 IPP_STATUS_CUPS_INVALID
= -1, /* Invalid status name for @link ippErrorValue@ */
413 IPP_STATUS_OK
= 0x0000, /* successful-ok */
414 IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
, /* successful-ok-ignored-or-substituted-attributes */
415 IPP_STATUS_OK_CONFLICTING
, /* successful-ok-conflicting-attributes */
416 IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS
, /* successful-ok-ignored-subscriptions */
417 IPP_STATUS_OK_IGNORED_NOTIFICATIONS
, /* successful-ok-ignored-notifications @private@ */
418 IPP_STATUS_OK_TOO_MANY_EVENTS
, /* successful-ok-too-many-events */
419 IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION
,/* successful-ok-but-cancel-subscription @private@ */
420 IPP_STATUS_OK_EVENTS_COMPLETE
, /* successful-ok-events-complete */
421 IPP_STATUS_REDIRECTION_OTHER_SITE
= 0x0200,
422 /* redirection-other-site @private@ */
423 IPP_STATUS_CUPS_SEE_OTHER
= 0x0280, /* cups-see-other */
424 IPP_STATUS_ERROR_BAD_REQUEST
= 0x0400,/* client-error-bad-request */
425 IPP_STATUS_ERROR_FORBIDDEN
, /* client-error-forbidden */
426 IPP_STATUS_ERROR_NOT_AUTHENTICATED
, /* client-error-not-authenticated */
427 IPP_STATUS_ERROR_NOT_AUTHORIZED
, /* client-error-not-authorized */
428 IPP_STATUS_ERROR_NOT_POSSIBLE
, /* client-error-not-possible */
429 IPP_STATUS_ERROR_TIMEOUT
, /* client-error-timeout */
430 IPP_STATUS_ERROR_NOT_FOUND
, /* client-error-not-found */
431 IPP_STATUS_ERROR_GONE
, /* client-error-gone */
432 IPP_STATUS_ERROR_REQUEST_ENTITY
, /* client-error-request-entity-too-large */
433 IPP_STATUS_ERROR_REQUEST_VALUE
, /* client-error-request-value-too-long */
434 IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
,
435 /* client-error-document-format-not-supported */
436 IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
,/* client-error-attributes-or-values-not-supported */
437 IPP_STATUS_ERROR_URI_SCHEME
, /* client-error-uri-scheme-not-supported */
438 IPP_STATUS_ERROR_CHARSET
, /* client-error-charset-not-supported */
439 IPP_STATUS_ERROR_CONFLICTING
, /* client-error-conflicting-attributes */
440 IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED
,
441 /* client-error-compression-not-supported */
442 IPP_STATUS_ERROR_COMPRESSION_ERROR
, /* client-error-compression-error */
443 IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
,
444 /* client-error-document-format-error */
445 IPP_STATUS_ERROR_DOCUMENT_ACCESS
, /* client-error-document-access-error */
446 IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE
,
447 /* client-error-attributes-not-settable */
448 IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS
,
449 /* client-error-ignored-all-subscriptions */
450 IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS
,
451 /* client-error-too-many-subscriptions */
452 IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS
,
453 /* client-error-ignored-all-notifications @private@ */
454 IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND
,
455 /* client-error-print-support-file-not-found @private@ */
456 IPP_STATUS_ERROR_DOCUMENT_PASSWORD
, /* client-error-document-password-error */
457 IPP_STATUS_ERROR_DOCUMENT_PERMISSION
, /* client-error-document-permission-error */
458 IPP_STATUS_ERROR_DOCUMENT_SECURITY
, /* client-error-document-security-error */
459 IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
,/* client-error-document-unprintable-error */
461 /* Proposed extensions for paid printing */
462 IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
= 0x049C,
463 /* cups-error-account-info-needed @since CUPS 1.7@ */
464 IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
, /* cups-error-account-closed @since CUPS 1.7@ */
465 IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
,
466 /* cups-error-account-limit-reached @since CUPS 1.7@ */
467 IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
,
468 /* cups-error-account-authorization-failed @since CUPS 1.7@ */
470 IPP_STATUS_ERROR_INTERNAL
= 0x0500, /* server-error-internal-error */
471 IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
,
472 /* server-error-operation-not-supported */
473 IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
, /* server-error-service-unavailable */
474 IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
,
475 /* server-error-version-not-supported */
476 IPP_STATUS_ERROR_DEVICE
, /* server-error-device-error */
477 IPP_STATUS_ERROR_TEMPORARY
, /* server-error-temporary-error */
478 IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS
, /* server-error-not-accepting-jobs */
479 IPP_STATUS_ERROR_BUSY
, /* server-error-busy */
480 IPP_STATUS_ERROR_JOB_CANCELED
, /* server-error-job-canceled */
481 IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED
,
482 /* server-error-multiple-document-jobs-not-supported */
483 IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED
,
484 /* server-error-printer-is-deactivated */
485 IPP_STATUS_ERROR_TOO_MANY_JOBS
, /* server-error-too-many-jobs */
486 IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS
, /* server-error-too-many-documents */
488 /* These are internal and never sent over the wire... */
489 IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
= 0x1000,
490 /* cups-authentication-canceled - Authentication canceled by user @since CUPS 1.5/OS X 10.7@ */
491 IPP_STATUS_ERROR_CUPS_PKI
, /* cups-pki-error - Error negotiating a secure connection @since CUPS 1.5/OS X 10.7@ */
492 IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
/* cups-upgrade-required - TLS upgrade required */
494 # ifndef _CUPS_NO_DEPRECATED
495 # define IPP_OK IPP_STATUS_OK
496 # define IPP_OK_SUBST IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
497 # define IPP_OK_CONFLICT IPP_STATUS_OK_CONFLICTING
498 # define IPP_OK_IGNORED_SUBSCRIPTIONS IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS
499 # define IPP_OK_IGNORED_NOTIFICATIONS IPP_STATUS_OK_IGNORED_NOTIFICATIONS
500 # define IPP_OK_TOO_MANY_EVENTS IPP_STATUS_OK_TOO_MANY_EVENTS
501 # define IPP_OK_BUT_CANCEL_SUBSCRIPTION IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION
502 # define IPP_OK_EVENTS_COMPLETE IPP_STATUS_OK_EVENTS_COMPLETE
503 # define IPP_REDIRECTION_OTHER_SITE IPP_STATUS_REDIRECTION_OTHER_SITE
504 # define CUPS_SEE_OTHER IPP_STATUS_CUPS_SEE_OTHER
505 # define IPP_BAD_REQUEST IPP_STATUS_ERROR_BAD_REQUEST
506 # define IPP_FORBIDDEN IPP_STATUS_ERROR_FORBIDDEN
507 # define IPP_NOT_AUTHENTICATED IPP_STATUS_ERROR_NOT_AUTHENTICATED
508 # define IPP_NOT_AUTHORIZED IPP_STATUS_ERROR_NOT_AUTHORIZED
509 # define IPP_NOT_POSSIBLE IPP_STATUS_ERROR_NOT_POSSIBLE
510 # define IPP_TIMEOUT IPP_STATUS_ERROR_TIMEOUT
511 # define IPP_NOT_FOUND IPP_STATUS_ERROR_NOT_FOUND
512 # define IPP_GONE IPP_STATUS_ERROR_GONE
513 # define IPP_REQUEST_ENTITY IPP_STATUS_ERROR_REQUEST_ENTITY
514 # define IPP_REQUEST_VALUE IPP_STATUS_ERROR_REQUEST_VALUE
515 # define IPP_DOCUMENT_FORMAT IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
516 # define IPP_ATTRIBUTES IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
517 # define IPP_URI_SCHEME IPP_STATUS_ERROR_URI_SCHEME
518 # define IPP_CHARSET IPP_STATUS_ERROR_CHARSET
519 # define IPP_CONFLICT IPP_STATUS_ERROR_CONFLICTING
520 # define IPP_COMPRESSION_NOT_SUPPORTED IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED
521 # define IPP_COMPRESSION_ERROR IPP_STATUS_ERROR_COMPRESSION_ERROR
522 # define IPP_DOCUMENT_FORMAT_ERROR IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
523 # define IPP_DOCUMENT_ACCESS_ERROR IPP_STATUS_ERROR_DOCUMENT_ACCESS
524 # define IPP_ATTRIBUTES_NOT_SETTABLE IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE
525 # define IPP_IGNORED_ALL_SUBSCRIPTIONS IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS
526 # define IPP_TOO_MANY_SUBSCRIPTIONS IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS
527 # define IPP_IGNORED_ALL_NOTIFICATIONS IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS
528 # define IPP_PRINT_SUPPORT_FILE_NOT_FOUND IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND
529 # define IPP_DOCUMENT_PASSWORD_ERROR IPP_STATUS_ERROR_DOCUMENT_PASSWORD
530 # define IPP_DOCUMENT_PERMISSION_ERROR IPP_STATUS_ERROR_DOCUMENT_PERMISSION
531 # define IPP_DOCUMENT_SECURITY_ERROR IPP_STATUS_ERROR_DOCUMENT_SECURITY
532 # define IPP_DOCUMENT_UNPRINTABLE_ERROR IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
533 # define IPP_INTERNAL_ERROR IPP_STATUS_ERROR_INTERNAL
534 # define IPP_OPERATION_NOT_SUPPORTED IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
535 # define IPP_SERVICE_UNAVAILABLE IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
536 # define IPP_VERSION_NOT_SUPPORTED IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
537 # define IPP_DEVICE_ERROR IPP_STATUS_ERROR_DEVICE
538 # define IPP_TEMPORARY_ERROR IPP_STATUS_ERROR_TEMPORARY
539 # define IPP_NOT_ACCEPTING IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS
540 # define IPP_PRINTER_BUSY IPP_STATUS_ERROR_BUSY
541 # define IPP_ERROR_JOB_CANCELED IPP_STATUS_ERROR_JOB_CANCELED
542 # define IPP_MULTIPLE_JOBS_NOT_SUPPORTED IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED
543 # define IPP_PRINTER_IS_DEACTIVATED IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED
544 # define IPP_TOO_MANY_JOBS IPP_STATUS_ERROR_TOO_MANY_JOBS
545 # define IPP_TOO_MANY_DOCUMENTS IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS
546 # define IPP_AUTHENTICATION_CANCELED IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
547 # define IPP_PKI_ERROR IPP_STATUS_ERROR_CUPS_PKI
548 # define IPP_UPGRADE_REQUIRED IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
549 /* Legacy name for canceled status */
550 # define IPP_ERROR_JOB_CANCELLED IPP_STATUS_ERROR_JOB_CANCELED
551 # endif /* _CUPS_NO_DEPRECATED */
554 typedef enum ipp_tag_e
/**** Format tags for attributes ****/
556 IPP_TAG_CUPS_INVALID
= -1, /* Invalid tag name for @link ippTagValue@ */
557 IPP_TAG_ZERO
= 0x00, /* Zero tag - used for separators */
558 IPP_TAG_OPERATION
, /* Operation group */
559 IPP_TAG_JOB
, /* Job group */
560 IPP_TAG_END
, /* End-of-attributes */
561 IPP_TAG_PRINTER
, /* Printer group */
562 IPP_TAG_UNSUPPORTED_GROUP
, /* Unsupported attributes group */
563 IPP_TAG_SUBSCRIPTION
, /* Subscription group */
564 IPP_TAG_EVENT_NOTIFICATION
, /* Event group */
565 IPP_TAG_RESOURCE
, /* Resource group @private@ */
566 IPP_TAG_DOCUMENT
, /* Document group */
567 IPP_TAG_UNSUPPORTED_VALUE
= 0x10, /* Unsupported value */
568 IPP_TAG_DEFAULT
, /* Default value */
569 IPP_TAG_UNKNOWN
, /* Unknown value */
570 IPP_TAG_NOVALUE
, /* No-value value */
571 IPP_TAG_NOTSETTABLE
= 0x15, /* Not-settable value */
572 IPP_TAG_DELETEATTR
, /* Delete-attribute value */
573 IPP_TAG_ADMINDEFINE
, /* Admin-defined value */
574 IPP_TAG_INTEGER
= 0x21, /* Integer value */
575 IPP_TAG_BOOLEAN
, /* Boolean value */
576 IPP_TAG_ENUM
, /* Enumeration value */
577 IPP_TAG_STRING
= 0x30, /* Octet string value */
578 IPP_TAG_DATE
, /* Date/time value */
579 IPP_TAG_RESOLUTION
, /* Resolution value */
580 IPP_TAG_RANGE
, /* Range value */
581 IPP_TAG_BEGIN_COLLECTION
, /* Beginning of collection value */
582 IPP_TAG_TEXTLANG
, /* Text-with-language value */
583 IPP_TAG_NAMELANG
, /* Name-with-language value */
584 IPP_TAG_END_COLLECTION
, /* End of collection value */
585 IPP_TAG_TEXT
= 0x41, /* Text value */
586 IPP_TAG_NAME
, /* Name value */
587 IPP_TAG_RESERVED_STRING
, /* Reserved for future string value @private@ */
588 IPP_TAG_KEYWORD
, /* Keyword value */
589 IPP_TAG_URI
, /* URI value */
590 IPP_TAG_URISCHEME
, /* URI scheme value */
591 IPP_TAG_CHARSET
, /* Character set value */
592 IPP_TAG_LANGUAGE
, /* Language value */
593 IPP_TAG_MIMETYPE
, /* MIME media type value */
594 IPP_TAG_MEMBERNAME
, /* Collection member name value */
595 IPP_TAG_EXTENSION
= 0x7f, /* Extension point for 32-bit tags */
596 IPP_TAG_CUPS_MASK
= 0x7fffffff, /* Mask for copied attribute values @private@ */
597 /* The following expression is used to avoid compiler warnings with +/-0x80000000 */
598 IPP_TAG_CUPS_CONST
= -0x7fffffff-1 /* Bitflag for copied/const attribute values @private@ */
600 # ifndef _CUPS_NO_DEPRECATED
601 # define IPP_TAG_MASK IPP_TAG_CUPS_MASK
602 # define IPP_TAG_COPY IPP_TAG_CUPS_CONST
603 # endif /* !_CUPS_NO_DEPRECATED */
606 typedef unsigned char ipp_uchar_t
; /**** Unsigned 8-bit integer/character ****/
607 typedef struct _ipp_s ipp_t
; /**** IPP request/response data ****/
608 typedef struct _ipp_attribute_s ipp_attribute_t
;
609 /**** IPP attribute ****/
611 /**** New in CUPS 1.2/OS X 10.5 ****/
612 typedef ssize_t (*ipp_iocb_t
)(void *context
, ipp_uchar_t
*buffer
, size_t bytes
);
613 /**** IPP IO Callback Function @since CUPS 1.2/OS X 10.5@ ****/
615 /**** New in CUPS 1.6/OS X 10.8 ****/
616 typedef int (*ipp_copycb_t
)(void *context
, ipp_t
*dst
, ipp_attribute_t
*attr
);
620 * The following structures are PRIVATE starting with CUPS 1.6/OS X 10.8.
621 * Please use the new accessor functions available in CUPS 1.6 and later, as
622 * these definitions will be moved to a private header file in a future release.
624 * Define _IPP_PRIVATE_STRUCTURES to 1 to cause the private IPP structures to be
625 * exposed in CUPS 1.6. This happens automatically on OS X when compiling for
626 * a deployment target of 10.7 or earlier.
628 * Define _IPP_PRIVATE_STRUCTURES to 0 to prevent the private IPP structures
629 * from being exposed. This is useful when migrating existing code to the new
633 # ifdef _IPP_PRIVATE_STRUCTURES
634 /* Somebody has overridden the value */
635 # elif defined(_CUPS_SOURCE) || defined(_CUPS_IPP_PRIVATE_H_)
637 # define _IPP_PRIVATE_STRUCTURES 1
638 # elif defined(__APPLE__)
639 # if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8
640 /* Building for 10.7 and earlier */
641 # define _IPP_PRIVATE_STRUCTURES 1
642 # elif !defined(MAC_OS_X_VERSION_10_8)
643 /* Building for 10.7 and earlier */
644 # define _IPP_PRIVATE_STRUCTURES 1
645 # endif /* MAC_OS_X_VERSION_10_8 && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8 */
647 # define _IPP_PRIVATE_STRUCTURES 0
648 # endif /* _CUPS_SOURCE || _CUPS_IPP_PRIVATE_H_ */
650 # if _IPP_PRIVATE_STRUCTURES
651 typedef union _ipp_request_u
/**** Request Header ****/
653 struct /* Any Header */
655 ipp_uchar_t version
[2]; /* Protocol version number */
656 int op_status
; /* Operation ID or status code*/
657 int request_id
; /* Request ID */
660 struct /* Operation Header */
662 ipp_uchar_t version
[2]; /* Protocol version number */
663 ipp_op_t operation_id
; /* Operation ID */
664 int request_id
; /* Request ID */
667 struct /* Status Header */
669 ipp_uchar_t version
[2]; /* Protocol version number */
670 ipp_status_t status_code
; /* Status code */
671 int request_id
; /* Request ID */
674 /**** New in CUPS 1.1.19 ****/
675 struct /* Event Header @since CUPS 1.1.19/OS X 10.3@ */
677 ipp_uchar_t version
[2]; /* Protocol version number */
678 ipp_status_t status_code
; /* Status code */
679 int request_id
; /* Request ID */
683 /**** New in CUPS 1.1.19 ****/
685 typedef union _ipp_value_u
/**** Attribute Value ****/
687 int integer
; /* Integer/enumerated value */
689 char boolean
; /* Boolean value */
691 ipp_uchar_t date
[11]; /* Date/time value */
695 int xres
, /* Horizontal resolution */
696 yres
; /* Vertical resolution */
697 ipp_res_t units
; /* Resolution units */
698 } resolution
; /* Resolution value */
702 int lower
, /* Lower value */
703 upper
; /* Upper value */
704 } range
; /* Range of integers value */
708 char *language
; /* Language code */
709 char *text
; /* String */
710 } string
; /* String with language value */
714 int length
; /* Length of attribute */
715 void *data
; /* Data in attribute */
716 } unknown
; /* Unknown attribute type */
718 /**** New in CUPS 1.1.19 ****/
719 ipp_t
*collection
; /* Collection value @since CUPS 1.1.19/OS X 10.3@ */
721 typedef _ipp_value_t ipp_value_t
; /**** Convenience typedef that will be removed @private@ ****/
723 struct _ipp_attribute_s
/**** Attribute ****/
725 ipp_attribute_t
*next
; /* Next attribute in list */
726 ipp_tag_t group_tag
, /* Job/Printer/Operation group tag */
727 value_tag
; /* What type of value is it? */
728 char *name
; /* Name of attribute */
729 int num_values
; /* Number of values */
730 _ipp_value_t values
[1]; /* Values */
733 struct _ipp_s
/**** IPP Request/Response/Notification ****/
735 ipp_state_t state
; /* State of request */
736 _ipp_request_t request
; /* Request header */
737 ipp_attribute_t
*attrs
; /* Attributes */
738 ipp_attribute_t
*last
; /* Last attribute in list */
739 ipp_attribute_t
*current
; /* Current attribute (for read/write) */
740 ipp_tag_t curtag
; /* Current attribute group tag */
742 /**** New in CUPS 1.2 ****/
743 ipp_attribute_t
*prev
; /* Previous attribute (for read) @since CUPS 1.2/OS X 10.5@ */
745 /**** New in CUPS 1.4.4 ****/
746 int use
; /* Use count @since CUPS 1.4.4/OS X 10.6.?@ */
748 # endif /* _IPP_PRIVATE_STRUCTURES */
755 extern ipp_attribute_t
*ippAddBoolean(ipp_t
*ipp
, ipp_tag_t group
,
756 const char *name
, char value
);
757 extern ipp_attribute_t
*ippAddBooleans(ipp_t
*ipp
, ipp_tag_t group
,
758 const char *name
, int num_values
,
760 extern ipp_attribute_t
*ippAddDate(ipp_t
*ipp
, ipp_tag_t group
,
761 const char *name
, const ipp_uchar_t
*value
);
762 extern ipp_attribute_t
*ippAddInteger(ipp_t
*ipp
, ipp_tag_t group
,
763 ipp_tag_t value_tag
, const char *name
,
765 extern ipp_attribute_t
*ippAddIntegers(ipp_t
*ipp
, ipp_tag_t group
,
766 ipp_tag_t value_tag
, const char *name
,
767 int num_values
, const int *values
);
768 extern ipp_attribute_t
*ippAddRange(ipp_t
*ipp
, ipp_tag_t group
,
769 const char *name
, int lower
, int upper
);
770 extern ipp_attribute_t
*ippAddRanges(ipp_t
*ipp
, ipp_tag_t group
,
771 const char *name
, int num_values
,
772 const int *lower
, const int *upper
);
773 extern ipp_attribute_t
*ippAddResolution(ipp_t
*ipp
, ipp_tag_t group
,
774 const char *name
, ipp_res_t units
,
776 extern ipp_attribute_t
*ippAddResolutions(ipp_t
*ipp
, ipp_tag_t group
,
777 const char *name
, int num_values
,
778 ipp_res_t units
, const int *xres
,
780 extern ipp_attribute_t
*ippAddSeparator(ipp_t
*ipp
);
781 extern ipp_attribute_t
*ippAddString(ipp_t
*ipp
, ipp_tag_t group
,
782 ipp_tag_t value_tag
, const char *name
,
783 const char *language
, const char *value
);
784 extern ipp_attribute_t
*ippAddStrings(ipp_t
*ipp
, ipp_tag_t group
,
785 ipp_tag_t value_tag
, const char *name
,
786 int num_values
, const char *language
,
787 const char * const *values
);
788 extern time_t ippDateToTime(const ipp_uchar_t
*date
);
789 extern void ippDelete(ipp_t
*ipp
);
790 extern const char *ippErrorString(ipp_status_t error
);
791 extern ipp_attribute_t
*ippFindAttribute(ipp_t
*ipp
, const char *name
,
792 ipp_tag_t value_tag
);
793 extern ipp_attribute_t
*ippFindNextAttribute(ipp_t
*ipp
, const char *name
,
794 ipp_tag_t value_tag
);
795 extern size_t ippLength(ipp_t
*ipp
);
796 extern ipp_t
*ippNew(void);
797 extern ipp_state_t
ippRead(http_t
*http
, ipp_t
*ipp
);
798 extern const ipp_uchar_t
*ippTimeToDate(time_t t
);
799 extern ipp_state_t
ippWrite(http_t
*http
, ipp_t
*ipp
);
800 extern int ippPort(void);
801 extern void ippSetPort(int p
);
803 /**** New in CUPS 1.1.19 ****/
804 extern ipp_attribute_t
*ippAddCollection(ipp_t
*ipp
, ipp_tag_t group
,
805 const char *name
, ipp_t
*value
) _CUPS_API_1_1_19
;
806 extern ipp_attribute_t
*ippAddCollections(ipp_t
*ipp
, ipp_tag_t group
,
807 const char *name
, int num_values
,
808 const ipp_t
**values
) _CUPS_API_1_1_19
;
809 extern void ippDeleteAttribute(ipp_t
*ipp
, ipp_attribute_t
*attr
) _CUPS_API_1_1_19
;
810 extern ipp_state_t
ippReadFile(int fd
, ipp_t
*ipp
) _CUPS_API_1_1_19
;
811 extern ipp_state_t
ippWriteFile(int fd
, ipp_t
*ipp
) _CUPS_API_1_1_19
;
813 /**** New in CUPS 1.2/OS X 10.5 ****/
814 extern ipp_attribute_t
*ippAddOctetString(ipp_t
*ipp
, ipp_tag_t group
,
816 const void *data
, int datalen
) _CUPS_API_1_2
;
817 extern ipp_status_t
ippErrorValue(const char *name
) _CUPS_API_1_2
;
818 extern ipp_t
*ippNewRequest(ipp_op_t op
) _CUPS_API_1_2
;
819 extern const char *ippOpString(ipp_op_t op
) _CUPS_API_1_2
;
820 extern ipp_op_t
ippOpValue(const char *name
) _CUPS_API_1_2
;
821 extern ipp_state_t
ippReadIO(void *src
, ipp_iocb_t cb
, int blocking
,
822 ipp_t
*parent
, ipp_t
*ipp
) _CUPS_API_1_2
;
823 extern ipp_state_t
ippWriteIO(void *dst
, ipp_iocb_t cb
, int blocking
,
824 ipp_t
*parent
, ipp_t
*ipp
) _CUPS_API_1_2
;
826 /**** New in CUPS 1.4/OS X 10.6 ****/
827 extern const char *ippTagString(ipp_tag_t tag
) _CUPS_API_1_4
;
828 extern ipp_tag_t
ippTagValue(const char *name
) _CUPS_API_1_4
;
830 /**** New in CUPS 1.6/OS X 10.8 ****/
831 extern ipp_attribute_t
*ippAddOutOfBand(ipp_t
*ipp
, ipp_tag_t group
,
832 ipp_tag_t value_tag
, const char *name
)
834 extern size_t ippAttributeString(ipp_attribute_t
*attr
, char *buffer
,
835 size_t bufsize
) _CUPS_API_1_6
;
836 extern ipp_attribute_t
*ippCopyAttribute(ipp_t
*dst
, ipp_attribute_t
*attr
,
837 int quickcopy
) _CUPS_API_1_6
;
838 extern int ippCopyAttributes(ipp_t
*dst
, ipp_t
*src
,
839 int quickcopy
, ipp_copycb_t cb
,
840 void *context
) _CUPS_API_1_6
;
841 extern int ippDeleteValues(ipp_t
*ipp
, ipp_attribute_t
**attr
,
842 int element
, int count
) _CUPS_API_1_6
;
843 extern const char *ippEnumString(const char *attrname
, int enumvalue
)
845 extern int ippEnumValue(const char *attrname
,
846 const char *enumstring
) _CUPS_API_1_6
;
847 extern ipp_attribute_t
*ippFirstAttribute(ipp_t
*ipp
) _CUPS_API_1_6
;
848 extern int ippGetBoolean(ipp_attribute_t
*attr
, int element
)
850 extern ipp_t
*ippGetCollection(ipp_attribute_t
*attr
,
851 int element
) _CUPS_API_1_6
;
852 extern int ippGetCount(ipp_attribute_t
*attr
) _CUPS_API_1_6
;
853 extern const ipp_uchar_t
*ippGetDate(ipp_attribute_t
*attr
, int element
)
855 extern ipp_tag_t
ippGetGroupTag(ipp_attribute_t
*attr
) _CUPS_API_1_6
;
856 extern int ippGetInteger(ipp_attribute_t
*attr
, int element
)
858 extern const char *ippGetName(ipp_attribute_t
*attr
) _CUPS_API_1_6
;
859 extern ipp_op_t
ippGetOperation(ipp_t
*ipp
) _CUPS_API_1_6
;
860 extern int ippGetRange(ipp_attribute_t
*attr
, int element
,
861 int *upper
) _CUPS_API_1_6
;
862 extern int ippGetRequestId(ipp_t
*ipp
) _CUPS_API_1_6
;
863 extern int ippGetResolution(ipp_attribute_t
*attr
, int element
,
864 int *yres
, ipp_res_t
*units
)
866 extern ipp_state_t
ippGetState(ipp_t
*ipp
) _CUPS_API_1_6
;
867 extern ipp_status_t
ippGetStatusCode(ipp_t
*ipp
) _CUPS_API_1_6
;
868 extern const char *ippGetString(ipp_attribute_t
*attr
, int element
,
869 const char **language
) _CUPS_API_1_6
;
870 extern ipp_tag_t
ippGetValueTag(ipp_attribute_t
*attr
) _CUPS_API_1_6
;
871 extern int ippGetVersion(ipp_t
*ipp
, int *minor
) _CUPS_API_1_6
;
872 extern ipp_attribute_t
*ippNextAttribute(ipp_t
*ipp
) _CUPS_API_1_6
;
873 extern int ippSetBoolean(ipp_t
*ipp
, ipp_attribute_t
**attr
,
874 int element
, int boolvalue
) _CUPS_API_1_6
;
875 extern int ippSetCollection(ipp_t
*ipp
, ipp_attribute_t
**attr
,
876 int element
, ipp_t
*colvalue
)
878 extern int ippSetDate(ipp_t
*ipp
, ipp_attribute_t
**attr
,
879 int element
, const ipp_uchar_t
*datevalue
)
881 extern int ippSetGroupTag(ipp_t
*ipp
, ipp_attribute_t
**attr
,
882 ipp_tag_t group_tag
) _CUPS_API_1_6
;
883 extern int ippSetInteger(ipp_t
*ipp
, ipp_attribute_t
**attr
,
884 int element
, int intvalue
) _CUPS_API_1_6
;
885 extern int ippSetName(ipp_t
*ipp
, ipp_attribute_t
**attr
,
886 const char *name
) _CUPS_API_1_6
;
887 extern int ippSetOperation(ipp_t
*ipp
, ipp_op_t op
) _CUPS_API_1_6
;
888 extern int ippSetRange(ipp_t
*ipp
, ipp_attribute_t
**attr
,
889 int element
, int lowervalue
, int uppervalue
)
891 extern int ippSetRequestId(ipp_t
*ipp
, int request_id
)
893 extern int ippSetResolution(ipp_t
*ipp
, ipp_attribute_t
**attr
,
894 int element
, ipp_res_t unitsvalue
,
895 int xresvalue
, int yresvalue
)
897 extern int ippSetState(ipp_t
*ipp
, ipp_state_t state
)
899 extern int ippSetStatusCode(ipp_t
*ipp
, ipp_status_t status
)
901 extern int ippSetString(ipp_t
*ipp
, ipp_attribute_t
**attr
,
902 int element
, const char *strvalue
)
904 extern int ippSetValueTag(ipp_t
*ipp
, ipp_attribute_t
**attr
,
905 ipp_tag_t value_tag
) _CUPS_API_1_6
;
906 extern int ippSetVersion(ipp_t
*ipp
, int major
, int minor
)
909 /**** New in CUPS 1.7 ****/
910 extern ipp_attribute_t
*ippAddStringf(ipp_t
*ipp
, ipp_tag_t group
,
911 ipp_tag_t value_tag
, const char *name
,
912 const char *language
, const char *format
,
914 extern ipp_attribute_t
*ippAddStringfv(ipp_t
*ipp
, ipp_tag_t group
,
915 ipp_tag_t value_tag
, const char *name
,
916 const char *language
,
917 const char *format
, va_list ap
)
919 extern int ippContainsInteger(ipp_attribute_t
*attr
, int value
)
921 extern int ippContainsString(ipp_attribute_t
*attr
,
922 const char *value
) _CUPS_API_1_7
;
923 extern cups_array_t
*ippCreateRequestedArray(ipp_t
*request
) _CUPS_API_1_7
;
924 extern ipp_t
*ippNewResponse(ipp_t
*request
) _CUPS_API_1_7
;
925 extern int ippSetStringf(ipp_t
*ipp
, ipp_attribute_t
**attr
,
926 int element
, const char *format
,
928 extern int ippSetStringfv(ipp_t
*ipp
, ipp_attribute_t
**attr
,
929 int element
, const char *format
,
930 va_list ap
) _CUPS_API_1_7
;
931 extern int ippValidateAttribute(ipp_attribute_t
*attr
)
933 extern int ippValidateAttributes(ipp_t
*ipp
) _CUPS_API_1_7
;
942 # endif /* __cplusplus */
943 #endif /* !_CUPS_IPP_H_ */
946 * End of "$Id: ipp.h 7847 2008-08-19 04:22:14Z mike $".