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