]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/ipp.h
Load cups into easysw/current.
[thirdparty/cups.git] / cups / ipp.h
CommitLineData
ef416fc2 1/*
f7faf1f5 2 * "$Id: ipp.h 5138 2006-02-21 10:49:06Z mike $"
ef416fc2 3 *
4 * Internet Printing Protocol definitions for the Common UNIX Printing
5 * System (CUPS).
6 *
7 * Copyright 1997-2006 by Easy Software Products.
8 *
9 * These coded instructions, statements, and computer programs are the
10 * property of Easy Software Products and are protected by Federal
11 * copyright law. Distribution and use rights are outlined in the file
12 * "LICENSE.txt" which should have been included with this file. If this
13 * file is missing or damaged please contact Easy Software Products
14 * at:
15 *
16 * Attn: CUPS Licensing Information
17 * Easy Software Products
18 * 44141 Airport View Drive, Suite 204
19 * Hollywood, Maryland 20636 USA
20 *
21 * Voice: (301) 373-9600
22 * EMail: cups-info@cups.org
23 * WWW: http://www.cups.org
24 *
25 * This file is subject to the Apple OS-Developed Software exception.
26 */
27
28#ifndef _CUPS_IPP_H_
29# define _CUPS_IPP_H_
30
31/*
32 * Include necessary headers...
33 */
34
35# include "http.h"
36
37
38/*
39 * C++ magic...
40 */
41
42# ifdef __cplusplus
43extern "C" {
44# endif /* __cplusplus */
45
46
47/*
48 * IPP version string...
49 */
50
51# define IPP_VERSION "\001\001"
52
53/*
54 * IPP registered port number...
55 *
56 * Note: Applications should never use IPP_PORT, but instead use the
57 * ippPort() function to allow overrides via the IPP_PORT environment
58 * variable and services file if needed!
59 */
60
61# define IPP_PORT 631
62
63/*
64 * Common limits...
65 */
66
67# define IPP_MAX_NAME 256
68# define IPP_MAX_VALUES 8 /* Power-of-2 allocation increment */
69
70
71/*
72 * Types and structures...
73 */
74
ecdc0628 75typedef enum ipp_tag_e /**** Format tags for attributes... ****/
ef416fc2 76{
ecdc0628 77 IPP_TAG_ZERO = 0x00, /* Zero tag - used for separators */
78 IPP_TAG_OPERATION, /* Operation group */
79 IPP_TAG_JOB, /* Job group */
80 IPP_TAG_END, /* End-of-attributes */
81 IPP_TAG_PRINTER, /* Printer group */
82 IPP_TAG_UNSUPPORTED_GROUP, /* Unsupported attributes group */
83 IPP_TAG_SUBSCRIPTION, /* Subscription group */
84 IPP_TAG_EVENT_NOTIFICATION, /* Event group */
85 IPP_TAG_UNSUPPORTED_VALUE = 0x10, /* Unsupported value */
86 IPP_TAG_DEFAULT, /* Default value */
87 IPP_TAG_UNKNOWN, /* Unknown value */
88 IPP_TAG_NOVALUE, /* No-value value */
89 IPP_TAG_NOTSETTABLE = 0x15, /* Not-settable value */
90 IPP_TAG_DELETEATTR, /* Delete-attribute value */
91 IPP_TAG_ADMINDEFINE, /* Admin-defined value */
92 IPP_TAG_INTEGER = 0x21, /* Integer value */
93 IPP_TAG_BOOLEAN, /* Boolean value */
94 IPP_TAG_ENUM, /* Enumeration value */
95 IPP_TAG_STRING = 0x30, /* Octet string value */
96 IPP_TAG_DATE, /* Date/time value */
97 IPP_TAG_RESOLUTION, /* Resolution value */
98 IPP_TAG_RANGE, /* Range value */
99 IPP_TAG_BEGIN_COLLECTION, /* Beginning of collection value */
100 IPP_TAG_TEXTLANG, /* Text-with-language value */
101 IPP_TAG_NAMELANG, /* Name-with-language value */
102 IPP_TAG_END_COLLECTION, /* End of collection value */
103 IPP_TAG_TEXT = 0x41, /* Text value */
104 IPP_TAG_NAME, /* Name value */
105 IPP_TAG_KEYWORD = 0x44, /* Keyword value */
106 IPP_TAG_URI, /* URI value */
107 IPP_TAG_URISCHEME, /* URI scheme value */
108 IPP_TAG_CHARSET, /* Character set value */
109 IPP_TAG_LANGUAGE, /* Language value */
110 IPP_TAG_MIMETYPE, /* MIME media type value */
111 IPP_TAG_MEMBERNAME, /* Collection member name value */
fa73b229 112 IPP_TAG_MASK = 0x7fffffff, /* Mask for copied attribute values */
113 IPP_TAG_COPY = -0x7fffffff-1 /* Bitflag for copied attribute values */
ef416fc2 114} ipp_tag_t;
115
ecdc0628 116typedef enum ipp_res_e /**** Resolution units... ****/
ef416fc2 117{
ecdc0628 118 IPP_RES_PER_INCH = 3, /* Pixels per inch */
119 IPP_RES_PER_CM /* Pixels per centimeter */
ef416fc2 120} ipp_res_t;
121
ecdc0628 122typedef enum ipp_finish_e /**** Finishings... ****/
ef416fc2 123{
ecdc0628 124 IPP_FINISHINGS_NONE = 3, /* No finishing */
125 IPP_FINISHINGS_STAPLE, /* Staple (any location) */
126 IPP_FINISHINGS_PUNCH, /* Punch (any location/count) */
127 IPP_FINISHINGS_COVER, /* Add cover */
128 IPP_FINISHINGS_BIND, /* Bind */
129 IPP_FINISHINGS_SADDLE_STITCH, /* Staple interior */
130 IPP_FINISHINGS_EDGE_STITCH, /* Stitch along any side */
131 IPP_FINISHINGS_FOLD, /* Fold (any type) */
132 IPP_FINISHINGS_TRIM, /* Trim (any type) */
133 IPP_FINISHINGS_BALE, /* Bale (any type) */
134 IPP_FINISHINGS_BOOKLET_MAKER, /* Fold to make booklet */
135 IPP_FINISHINGS_JOB_OFFSET, /* Offset for binding (any type) */
136 IPP_FINISHINGS_STAPLE_TOP_LEFT = 20, /* Staple top left corner */
137 IPP_FINISHINGS_STAPLE_BOTTOM_LEFT, /* Staple bottom left corner */
138 IPP_FINISHINGS_STAPLE_TOP_RIGHT, /* Staple top right corner */
139 IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT, /* Staple bottom right corner */
140 IPP_FINISHINGS_EDGE_STITCH_LEFT, /* Stitch along left side */
141 IPP_FINISHINGS_EDGE_STITCH_TOP, /* Stitch along top edge */
142 IPP_FINISHINGS_EDGE_STITCH_RIGHT, /* Stitch along right side */
143 IPP_FINISHINGS_EDGE_STITCH_BOTTOM, /* Stitch along bottom edge */
144 IPP_FINISHINGS_STAPLE_DUAL_LEFT, /* Two staples on left */
145 IPP_FINISHINGS_STAPLE_DUAL_TOP, /* Two staples on top */
146 IPP_FINISHINGS_STAPLE_DUAL_RIGHT, /* Two staples on right */
147 IPP_FINISHINGS_STAPLE_DUAL_BOTTOM, /* Two staples on bottom */
148 IPP_FINISHINGS_BIND_LEFT = 50, /* Bind on left */
149 IPP_FINISHINGS_BIND_TOP, /* Bind on top */
150 IPP_FINISHINGS_BIND_RIGHT, /* Bind on right */
151 IPP_FINISHINGS_BIND_BOTTOM /* Bind on bottom */
ef416fc2 152} ipp_finish_t;
153
ecdc0628 154typedef enum ipp_orient_e /**** Orientation... ****/
ef416fc2 155{
fa73b229 156 IPP_PORTRAIT = 3, /* No rotation */
157 IPP_LANDSCAPE, /* 90 degrees counter-clockwise */
158 IPP_REVERSE_LANDSCAPE, /* 90 degrees clockwise */
159 IPP_REVERSE_PORTRAIT /* 180 degrees */
ef416fc2 160} ipp_orient_t;
161
ecdc0628 162typedef enum ipp_quality_e /**** Qualities... ****/
ef416fc2 163{
ecdc0628 164 IPP_QUALITY_DRAFT = 3, /* Draft quality */
165 IPP_QUALITY_NORMAL, /* Normal quality */
166 IPP_QUALITY_HIGH /* High quality */
ef416fc2 167} ipp_quality_t;
168
ecdc0628 169typedef enum ipp_jstate_e /**** Job States.... */
ef416fc2 170{
ecdc0628 171 IPP_JOB_PENDING = 3, /* Job is waiting to be printed */
172 IPP_JOB_HELD, /* Job is held for printing */
173 IPP_JOB_PROCESSING, /* Job is currently printing */
174 IPP_JOB_STOPPED, /* Job has been stopped */
175 IPP_JOB_CANCELLED, /* Job has been cancelled */
176 IPP_JOB_ABORTED, /* Job has aborted due to error */
177 IPP_JOB_COMPLETED /* Job has completed successfully */
ef416fc2 178} ipp_jstate_t;
179
ecdc0628 180typedef enum ipp_pstate_e /**** Printer States.... */
ef416fc2 181{
ecdc0628 182 IPP_PRINTER_IDLE = 3, /* Printer is idle */
183 IPP_PRINTER_PROCESSING, /* Printer is working */
184 IPP_PRINTER_STOPPED /* Printer is stopped */
ef416fc2 185} ipp_pstate_t;
186
ecdc0628 187typedef enum ipp_state_e /**** IPP states... ****/
ef416fc2 188{
fa73b229 189 IPP_ERROR = -1, /* An error occurred */
190 IPP_IDLE, /* Nothing is happening/request completed */
191 IPP_HEADER, /* The request header needs to be sent/received */
192 IPP_ATTRIBUTE, /* One or more attributes need to be sent/received */
193 IPP_DATA /* IPP request data needs to be sent/received */
ef416fc2 194} ipp_state_t;
195
ecdc0628 196typedef enum ipp_op_e /**** IPP operations... ****/
ef416fc2 197{
ecdc0628 198 IPP_PRINT_JOB = 0x0002, /* Print a single file */
199 IPP_PRINT_URI, /* Print a single URL @private@ */
200 IPP_VALIDATE_JOB, /* Validate job options */
201 IPP_CREATE_JOB, /* Create an empty print job */
202 IPP_SEND_DOCUMENT, /* Add a file to a job */
203 IPP_SEND_URI, /* Add a URL to a job @private@ */
204 IPP_CANCEL_JOB, /* Cancel a job */
205 IPP_GET_JOB_ATTRIBUTES, /* Get job attributes */
206 IPP_GET_JOBS, /* Get a list of jobs */
207 IPP_GET_PRINTER_ATTRIBUTES, /* Get printer attributes */
208 IPP_HOLD_JOB, /* Hold a job for printing */
209 IPP_RELEASE_JOB, /* Release a job for printing */
210 IPP_RESTART_JOB, /* Reprint a job */
211 IPP_PAUSE_PRINTER = 0x0010, /* Stop a printer */
212 IPP_RESUME_PRINTER, /* Start a printer */
213 IPP_PURGE_JOBS, /* Cancel all jobs */
214 IPP_SET_PRINTER_ATTRIBUTES, /* Set printer attributes @private@ */
215 IPP_SET_JOB_ATTRIBUTES, /* Set job attributes */
216 IPP_GET_PRINTER_SUPPORTED_VALUES, /* Get supported attribute values */
217 IPP_CREATE_PRINTER_SUBSCRIPTION, /* Create a printer subscription @since CUPS 1.2@ */
218 IPP_CREATE_JOB_SUBSCRIPTION, /* Create a job subscription @since CUPS 1.2@ */
219 IPP_GET_SUBSCRIPTION_ATTRIBUTES, /* Get subscription attributes @since CUPS 1.2@ */
220 IPP_GET_SUBSCRIPTIONS, /* Get list of subscriptions @since CUPS 1.2@ */
221 IPP_RENEW_SUBSCRIPTION, /* Renew a printer subscription @since CUPS 1.2@ */
222 IPP_CANCEL_SUBSCRIPTION, /* Cancel a subscription @since CUPS 1.2@ */
223 IPP_GET_NOTIFICATIONS, /* Get notification events @since CUPS 1.2@ */
224 IPP_SEND_NOTIFICATIONS, /* Send notification events @private@ */
225 IPP_GET_PRINT_SUPPORT_FILES = 0x0021, /* Get printer support files @private@ */
226 IPP_ENABLE_PRINTER, /* Start a printer */
227 IPP_DISABLE_PRINTER, /* Stop a printer */
228 IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB, /* Stop printer after the current job @private@ */
229 IPP_HOLD_NEW_JOBS, /* Hold new jobs @private@ */
230 IPP_RELEASE_HELD_NEW_JOBS, /* Release new jobs @private@ */
231 IPP_DEACTIVATE_PRINTER, /* Stop a printer @private@ */
232 IPP_ACTIVATE_PRINTER, /* Start a printer @private@ */
233 IPP_RESTART_PRINTER, /* Restart a printer @private@ */
234 IPP_SHUTDOWN_PRINTER, /* Turn a printer off @private@ */
235 IPP_STARTUP_PRINTER, /* Turn a printer on @private@ */
236 IPP_REPROCESS_JOB, /* Reprint a job @private@ */
237 IPP_CANCEL_CURRENT_JOB, /* Cancel the current job @private@ */
238 IPP_SUSPEND_CURRENT_JOB, /* Suspend the current job @private@ */
239 IPP_RESUME_JOB, /* Resume the current job @private@ */
240 IPP_PROMOTE_JOB, /* Promote a job to print sooner @private@ */
241 IPP_SCHEDULE_JOB_AFTER, /* Schedule a job to print after another @private@ */
242 IPP_PRIVATE = 0x4000, /* Reserved @private@ */
243 CUPS_GET_DEFAULT, /* Get the default printer */
244 CUPS_GET_PRINTERS, /* Get a list of printers and/or classes */
245 CUPS_ADD_MODIFY_PRINTER, /* Add or modify a printer */
246 CUPS_DELETE_PRINTER, /* Delete a printer */
247 CUPS_GET_CLASSES, /* Get a list of classes @deprecated@ */
248 CUPS_ADD_MODIFY_CLASS, /* Add or modify a class */
249 CUPS_DELETE_CLASS, /* Delete a class */
250 CUPS_ACCEPT_JOBS, /* Accept new jobs on a printer */
251 CUPS_REJECT_JOBS, /* Reject new jobs on a printer */
252 CUPS_SET_DEFAULT, /* Set the default printer */
253 CUPS_GET_DEVICES, /* Get a list of supported devices */
254 CUPS_GET_PPDS, /* Get a list of supported drivers */
255 CUPS_MOVE_JOB, /* Move a job to a different printer */
256 CUPS_AUTHENTICATE_JOB /* Authenticate a job @since CUPS 1.2@ */
ef416fc2 257} ipp_op_t;
258
fa73b229 259/* Old names for the operations */
260#define CUPS_ADD_PRINTER CUPS_ADD_MODIFY_PRINTER
261#define CUPS_ADD_CLASS CUPS_ADD_MODIFY_CLASS
262
ecdc0628 263typedef enum ipp_status_e /**** IPP status codes... ****/
ef416fc2 264{
ecdc0628 265 IPP_OK = 0x0000, /* successful-ok */
266 IPP_OK_SUBST, /* successful-ok-ignored-or-substituted-attributes */
267 IPP_OK_CONFLICT, /* successful-ok-conflicting-attributes */
268 IPP_OK_IGNORED_SUBSCRIPTIONS, /* successful-ok-ignored-subscriptions */
269 IPP_OK_IGNORED_NOTIFICATIONS, /* successful-ok-ignored-notifications */
270 IPP_OK_TOO_MANY_EVENTS, /* successful-ok-too-many-events */
271 IPP_OK_BUT_CANCEL_SUBSCRIPTION, /* successful-ok-but-cancel-subscription */
272 IPP_OK_EVENTS_COMPLETE, /* successful-ok-events-complete */
273 IPP_REDIRECTION_OTHER_SITE = 0x300, /* */
274 IPP_BAD_REQUEST = 0x0400, /* client-error-bad-request */
275 IPP_FORBIDDEN, /* client-error-forbidden */
276 IPP_NOT_AUTHENTICATED, /* client-error-not-authenticated */
277 IPP_NOT_AUTHORIZED, /* client-error-not-authorized */
278 IPP_NOT_POSSIBLE, /* client-error-not-possible */
279 IPP_TIMEOUT, /* client-error-timeout */
280 IPP_NOT_FOUND, /* client-error-not-found */
281 IPP_GONE, /* client-error-gone */
282 IPP_REQUEST_ENTITY, /* client-error-request-entity-too-large */
283 IPP_REQUEST_VALUE, /* client-error-request-value-too-long */
284 IPP_DOCUMENT_FORMAT, /* client-error-document-format-not-supported */
285 IPP_ATTRIBUTES, /* client-error-attributes-or-values-not-supported */
286 IPP_URI_SCHEME, /* client-error-uri-scheme-not-supported */
287 IPP_CHARSET, /* client-error-charset-not-supported */
288 IPP_CONFLICT, /* client-error-conflicting-attributes */
289 IPP_COMPRESSION_NOT_SUPPORTED, /* client-error-compression-not-supported */
290 IPP_COMPRESSION_ERROR, /* client-error-compression-error */
291 IPP_DOCUMENT_FORMAT_ERROR, /* client-error-document-format-error */
292 IPP_DOCUMENT_ACCESS_ERROR, /* client-error-document-access-error */
293 IPP_ATTRIBUTES_NOT_SETTABLE, /* client-error-attributes-not-settable */
294 IPP_IGNORED_ALL_SUBSCRIPTIONS, /* client-error-ignored-all-subscriptions */
295 IPP_TOO_MANY_SUBSCRIPTIONS, /* client-error-too-many-subscriptions */
296 IPP_IGNORED_ALL_NOTIFICATIONS, /* client-error-ignored-all-notifications */
297 IPP_PRINT_SUPPORT_FILE_NOT_FOUND, /* client-error-print-support-file-not-found */
298
299 IPP_INTERNAL_ERROR = 0x0500, /* server-error-internal-error */
300 IPP_OPERATION_NOT_SUPPORTED, /* server-error-operation-not-supported */
301 IPP_SERVICE_UNAVAILABLE, /* server-error-service-unavailable */
302 IPP_VERSION_NOT_SUPPORTED, /* server-error-version-not-supported */
303 IPP_DEVICE_ERROR, /* server-error-device-error */
304 IPP_TEMPORARY_ERROR, /* server-error-temporary-error */
305 IPP_NOT_ACCEPTING, /* server-error-not-accepting-jobs */
306 IPP_PRINTER_BUSY, /* server-error-busy */
307 IPP_ERROR_JOB_CANCELLED, /* server-error-job-canceled */
308 IPP_MULTIPLE_JOBS_NOT_SUPPORTED, /* server-error-multiple-document-jobs-not-supported */
309 IPP_PRINTER_IS_DEACTIVATED /* server-error-printer-is-deactivated */
ef416fc2 310} ipp_status_t;
311
fa73b229 312typedef unsigned char ipp_uchar_t; /**** Unsigned 8-bit integer/character ****/
ef416fc2 313
a4d04587 314/**** New in CUPS 1.2 ****/
315typedef ssize_t (*ipp_iocb_t)(void *, ipp_uchar_t *, size_t);
316 /**** IPP IO Callback Function @since CUPS 1.2@ ****/
ef416fc2 317
ecdc0628 318typedef union ipp_request_u /**** Request Header ****/
ef416fc2 319{
fa73b229 320 struct /* Any Header */
ef416fc2 321 {
fa73b229 322 ipp_uchar_t version[2]; /* Protocol version number */
323 int op_status; /* Operation ID or status code*/
324 int request_id; /* Request ID */
ef416fc2 325 } any;
326
fa73b229 327 struct /* Operation Header */
ef416fc2 328 {
fa73b229 329 ipp_uchar_t version[2]; /* Protocol version number */
330 ipp_op_t operation_id; /* Operation ID */
331 int request_id; /* Request ID */
ef416fc2 332 } op;
333
fa73b229 334 struct /* Status Header */
ef416fc2 335 {
fa73b229 336 ipp_uchar_t version[2]; /* Protocol version number */
337 ipp_status_t status_code; /* Status code */
338 int request_id; /* Request ID */
ef416fc2 339 } status;
340
341 /**** New in CUPS 1.1.19 ****/
fa73b229 342 struct /* Event Header */
ef416fc2 343 {
fa73b229 344 ipp_uchar_t version[2]; /* Protocol version number */
345 ipp_status_t status_code; /* Status code */
346 int request_id; /* Request ID */
ef416fc2 347 } event;
348} ipp_request_t;
349
350/**** New in CUPS 1.1.19 ****/
ecdc0628 351typedef struct ipp_s ipp_t;
ef416fc2 352
ecdc0628 353typedef union ipp_value_u /**** Attribute Value ****/
ef416fc2 354{
fa73b229 355 int integer; /* Integer/enumerated value */
ef416fc2 356
fa73b229 357 char boolean; /* Boolean value */
ef416fc2 358
fa73b229 359 ipp_uchar_t date[11]; /* Date/time value */
ef416fc2 360
361 struct
362 {
fa73b229 363 int xres, /* Horizontal resolution */
364 yres; /* Vertical resolution */
365 ipp_res_t units; /* Resolution units */
366 } resolution; /* Resolution value */
ef416fc2 367
368 struct
369 {
fa73b229 370 int lower, /* Lower value */
371 upper; /* Upper value */
372 } range; /* Range of integers value */
ef416fc2 373
374 struct
375 {
fa73b229 376 char *charset; /* Character set */
377 char *text; /* String */
378 } string; /* String with language value */
ef416fc2 379
380 struct
381 {
fa73b229 382 int length; /* Length of attribute */
383 void *data; /* Data in attribute */
384 } unknown; /* Unknown attribute type */
ef416fc2 385
386/**** New in CUPS 1.1.19 ****/
fa73b229 387 ipp_t *collection; /* Collection value */
ef416fc2 388} ipp_value_t;
389
fa73b229 390typedef struct ipp_attribute_s /**** Attribute ****/
ef416fc2 391{
fa73b229 392 struct ipp_attribute_s *next; /* Next attribute in list */
393 ipp_tag_t group_tag, /* Job/Printer/Operation group tag */
394 value_tag; /* What type of value is it? */
395 char *name; /* Name of attribute */
396 int num_values; /* Number of values */
397 ipp_value_t values[1]; /* Values */
ef416fc2 398} ipp_attribute_t;
399
ecdc0628 400struct ipp_s /**** IPP Request/Response/Notification ****/
ef416fc2 401{
fa73b229 402 ipp_state_t state; /* State of request */
403 ipp_request_t request; /* Request header */
ecdc0628 404 ipp_attribute_t *attrs; /* Attributes */
405 ipp_attribute_t *last; /* Last attribute in list */
406 ipp_attribute_t *current; /* Current attribute (for read/write) */
fa73b229 407 ipp_tag_t curtag; /* Current attribute group tag */
ef416fc2 408
409/**** New in CUPS 1.2 ****/
fa73b229 410 ipp_attribute_t *prev; /* Previous attribute (for read) */
ef416fc2 411};
412
413
414/*
415 * Prototypes...
416 */
417
fa73b229 418extern ipp_attribute_t *ippAddBoolean(ipp_t *ipp, ipp_tag_t group,
419 const char *name, char value);
420extern ipp_attribute_t *ippAddBooleans(ipp_t *ipp, ipp_tag_t group,
421 const char *name, int num_values,
422 const char *values);
423extern ipp_attribute_t *ippAddDate(ipp_t *ipp, ipp_tag_t group,
424 const char *name, const ipp_uchar_t *value);
425extern ipp_attribute_t *ippAddInteger(ipp_t *ipp, ipp_tag_t group,
426 ipp_tag_t type, const char *name,
427 int value);
428extern ipp_attribute_t *ippAddIntegers(ipp_t *ipp, ipp_tag_t group,
429 ipp_tag_t type, const char *name,
430 int num_values, const int *values);
431extern ipp_attribute_t *ippAddRange(ipp_t *ipp, ipp_tag_t group,
432 const char *name, int lower, int upper);
433extern ipp_attribute_t *ippAddRanges(ipp_t *ipp, ipp_tag_t group,
434 const char *name, int num_values,
435 const int *lower, const int *upper);
436extern ipp_attribute_t *ippAddResolution(ipp_t *ipp, ipp_tag_t group,
437 const char *name, ipp_res_t units,
438 int xres, int yres);
439extern ipp_attribute_t *ippAddResolutions(ipp_t *ipp, ipp_tag_t group,
440 const char *name, int num_values,
441 ipp_res_t units, const int *xres,
442 const int *yres);
ef416fc2 443extern ipp_attribute_t *ippAddSeparator(ipp_t *ipp);
fa73b229 444extern ipp_attribute_t *ippAddString(ipp_t *ipp, ipp_tag_t group,
445 ipp_tag_t type, const char *name,
446 const char *charset, const char *value);
447extern ipp_attribute_t *ippAddStrings(ipp_t *ipp, ipp_tag_t group,
448 ipp_tag_t type, const char *name,
449 int num_values, const char *charset,
450 const char * const *values);
ef416fc2 451extern time_t ippDateToTime(const ipp_uchar_t *date);
452extern void ippDelete(ipp_t *ipp);
453extern const char *ippErrorString(ipp_status_t error);
454extern ipp_attribute_t *ippFindAttribute(ipp_t *ipp, const char *name,
455 ipp_tag_t type);
456extern ipp_attribute_t *ippFindNextAttribute(ipp_t *ipp, const char *name,
457 ipp_tag_t type);
458extern size_t ippLength(ipp_t *ipp);
459extern ipp_t *ippNew(void);
460extern ipp_state_t ippRead(http_t *http, ipp_t *ipp);
461extern const ipp_uchar_t *ippTimeToDate(time_t t);
462extern ipp_state_t ippWrite(http_t *http, ipp_t *ipp);
463extern int ippPort(void);
464extern void ippSetPort(int p);
465
466/**** New in CUPS 1.1.19 ****/
fa73b229 467extern ipp_attribute_t *ippAddCollection(ipp_t *ipp, ipp_tag_t group,
468 const char *name, ipp_t *value);
469extern ipp_attribute_t *ippAddCollections(ipp_t *ipp, ipp_tag_t group,
470 const char *name, int num_values,
471 const ipp_t **values);
ef416fc2 472extern void ippDeleteAttribute(ipp_t *ipp, ipp_attribute_t *attr);
473extern ipp_state_t ippReadFile(int fd, ipp_t *ipp);
ef416fc2 474extern ipp_state_t ippWriteFile(int fd, ipp_t *ipp);
ef416fc2 475
476/**** New in CUPS 1.2 ****/
477extern ipp_attribute_t *ippAddOctetString(ipp_t *ipp, ipp_tag_t group,
478 const char *name,
479 const void *data, int datalen);
480extern ipp_status_t ippErrorValue(const char *name);
481extern ipp_t *ippNewRequest(ipp_op_t op);
482extern const char *ippOpString(ipp_op_t op);
483extern ipp_op_t ippOpValue(const char *name);
a4d04587 484extern ipp_state_t ippReadIO(void *src, ipp_iocb_t cb, int blocking,
485 ipp_t *parent, ipp_t *ipp);
486extern ipp_state_t ippWriteIO(void *dst, ipp_iocb_t cb, int blocking,
487 ipp_t *parent, ipp_t *ipp);
ef416fc2 488
ef416fc2 489
490/*
491 * C++ magic...
492 */
493
494# ifdef __cplusplus
495}
496# endif /* __cplusplus */
497#endif /* !_CUPS_IPP_H_ */
498
499/*
f7faf1f5 500 * End of "$Id: ipp.h 5138 2006-02-21 10:49:06Z mike $".
ef416fc2 501 */