Clarify expectations with error codes like G_IO_ERROR_FAILED
[platform/upstream/glib.git] / gio / gioenums.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2006-2007 Red Hat, Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17  *
18  * Author: Alexander Larsson <alexl@redhat.com>
19  */
20
21 #ifndef __GIO_ENUMS_H__
22 #define __GIO_ENUMS_H__
23
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
27
28 #include <glib-object.h>
29
30 G_BEGIN_DECLS
31
32
33 /**
34  * GAppInfoCreateFlags:
35  * @G_APP_INFO_CREATE_NONE: No flags.
36  * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens in a terminal window.
37  * @G_APP_INFO_CREATE_SUPPORTS_URIS: Application supports URI arguments.
38  * @G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION: Application supports startup notification. Since 2.26
39  *
40  * Flags used when creating a #GAppInfo.
41  */
42 typedef enum {
43   G_APP_INFO_CREATE_NONE                           = 0,         /*< nick=none >*/
44   G_APP_INFO_CREATE_NEEDS_TERMINAL                 = (1 << 0),  /*< nick=needs-terminal >*/
45   G_APP_INFO_CREATE_SUPPORTS_URIS                  = (1 << 1),  /*< nick=supports-uris >*/
46   G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION  = (1 << 2)   /*< nick=supports-startup-notification >*/
47 } GAppInfoCreateFlags;
48
49 /**
50  * GConverterFlags:
51  * @G_CONVERTER_NO_FLAGS: No flags.
52  * @G_CONVERTER_INPUT_AT_END: At end of input data
53  * @G_CONVERTER_FLUSH: Flush data
54  *
55  * Flags used when calling a g_converter_convert().
56  *
57  * Since: 2.24
58  */
59 typedef enum {
60   G_CONVERTER_NO_FLAGS     = 0,         /*< nick=none >*/
61   G_CONVERTER_INPUT_AT_END = (1 << 0),  /*< nick=input-at-end >*/
62   G_CONVERTER_FLUSH        = (1 << 1)   /*< nick=flush >*/
63 } GConverterFlags;
64
65 /**
66  * GConverterResult:
67  * @G_CONVERTER_ERROR: There was an error during conversion.
68  * @G_CONVERTER_CONVERTED: Some data was consumed or produced
69  * @G_CONVERTER_FINISHED: The conversion is finished
70  * @G_CONVERTER_FLUSHED: Flushing is finished
71  *
72  * Results returned from g_converter_convert().
73  *
74  * Since: 2.24
75  */
76 typedef enum {
77   G_CONVERTER_ERROR     = 0,  /*< nick=error >*/
78   G_CONVERTER_CONVERTED = 1,  /*< nick=converted >*/
79   G_CONVERTER_FINISHED  = 2,  /*< nick=finished >*/
80   G_CONVERTER_FLUSHED   = 3   /*< nick=flushed >*/
81 } GConverterResult;
82
83
84 /**
85  * GDataStreamByteOrder:
86  * @G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN: Selects Big Endian byte order.
87  * @G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN: Selects Little Endian byte order.
88  * @G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN: Selects endianness based on host machine's architecture.
89  *
90  * #GDataStreamByteOrder is used to ensure proper endianness of streaming data sources
91  * across various machine architectures.
92  *
93  **/
94 typedef enum {
95   G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN,
96   G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN,
97   G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN
98 } GDataStreamByteOrder;
99
100
101 /**
102  * GDataStreamNewlineType:
103  * @G_DATA_STREAM_NEWLINE_TYPE_LF: Selects "LF" line endings, common on most modern UNIX platforms.
104  * @G_DATA_STREAM_NEWLINE_TYPE_CR: Selects "CR" line endings.
105  * @G_DATA_STREAM_NEWLINE_TYPE_CR_LF: Selects "CR, LF" line ending, common on Microsoft Windows.
106  * @G_DATA_STREAM_NEWLINE_TYPE_ANY: Automatically try to handle any line ending type.
107  *
108  * #GDataStreamNewlineType is used when checking for or setting the line endings for a given file.
109  **/
110 typedef enum {
111   G_DATA_STREAM_NEWLINE_TYPE_LF,
112   G_DATA_STREAM_NEWLINE_TYPE_CR,
113   G_DATA_STREAM_NEWLINE_TYPE_CR_LF,
114   G_DATA_STREAM_NEWLINE_TYPE_ANY
115 } GDataStreamNewlineType;
116
117
118 /**
119  * GFileAttributeType:
120  * @G_FILE_ATTRIBUTE_TYPE_INVALID: indicates an invalid or uninitalized type.
121  * @G_FILE_ATTRIBUTE_TYPE_STRING: a null terminated UTF8 string.
122  * @G_FILE_ATTRIBUTE_TYPE_BYTE_STRING: a zero terminated string of non-zero bytes.
123  * @G_FILE_ATTRIBUTE_TYPE_BOOLEAN: a boolean value.
124  * @G_FILE_ATTRIBUTE_TYPE_UINT32: an unsigned 4-byte/32-bit integer.
125  * @G_FILE_ATTRIBUTE_TYPE_INT32: a signed 4-byte/32-bit integer.
126  * @G_FILE_ATTRIBUTE_TYPE_UINT64: an unsigned 8-byte/64-bit integer.
127  * @G_FILE_ATTRIBUTE_TYPE_INT64: a signed 8-byte/64-bit integer.
128  * @G_FILE_ATTRIBUTE_TYPE_OBJECT: a #GObject.
129  * @G_FILE_ATTRIBUTE_TYPE_STRINGV: a %NULL terminated char **. Since 2.22
130  *
131  * The data types for file attributes.
132  **/
133 typedef enum {
134   G_FILE_ATTRIBUTE_TYPE_INVALID = 0,
135   G_FILE_ATTRIBUTE_TYPE_STRING,
136   G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, /* zero terminated string of non-zero bytes */
137   G_FILE_ATTRIBUTE_TYPE_BOOLEAN,
138   G_FILE_ATTRIBUTE_TYPE_UINT32,
139   G_FILE_ATTRIBUTE_TYPE_INT32,
140   G_FILE_ATTRIBUTE_TYPE_UINT64,
141   G_FILE_ATTRIBUTE_TYPE_INT64,
142   G_FILE_ATTRIBUTE_TYPE_OBJECT,
143   G_FILE_ATTRIBUTE_TYPE_STRINGV
144 } GFileAttributeType;
145
146
147 /**
148  * GFileAttributeInfoFlags:
149  * @G_FILE_ATTRIBUTE_INFO_NONE: no flags set.
150  * @G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE: copy the attribute values when the file is copied.
151  * @G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED: copy the attribute values when the file is moved.
152  *
153  * Flags specifying the behaviour of an attribute.
154  **/
155 typedef enum {
156   G_FILE_ATTRIBUTE_INFO_NONE            = 0,
157   G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE  = (1 << 0),
158   G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED = (1 << 1)
159 } GFileAttributeInfoFlags;
160
161
162 /**
163  * GFileAttributeStatus:
164  * @G_FILE_ATTRIBUTE_STATUS_UNSET: Attribute value is unset (empty).
165  * @G_FILE_ATTRIBUTE_STATUS_SET: Attribute value is set.
166  * @G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING: Indicates an error in setting the value.
167  *
168  * Used by g_file_set_attributes_from_info() when setting file attributes.
169  **/
170 typedef enum {
171   G_FILE_ATTRIBUTE_STATUS_UNSET = 0,
172   G_FILE_ATTRIBUTE_STATUS_SET,
173   G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING
174 } GFileAttributeStatus;
175
176
177 /**
178  * GFileQueryInfoFlags:
179  * @G_FILE_QUERY_INFO_NONE: No flags set.
180  * @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks.
181  *
182  * Flags used when querying a #GFileInfo.
183  */
184 typedef enum {
185   G_FILE_QUERY_INFO_NONE              = 0,
186   G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS = (1 << 0)   /*< nick=nofollow-symlinks >*/
187 } GFileQueryInfoFlags;
188
189
190 /**
191  * GFileCreateFlags:
192  * @G_FILE_CREATE_NONE: No flags set.
193  * @G_FILE_CREATE_PRIVATE: Create a file that can only be
194  *    accessed by the current user.
195  * @G_FILE_CREATE_REPLACE_DESTINATION: Replace the destination
196  *    as if it didn't exist before. Don't try to keep any old
197  *    permissions, replace instead of following links. This
198  *    is generally useful if you're doing a "copy over"
199  *    rather than a "save new version of" replace operation.
200  *    You can think of it as "unlink destination" before
201  *    writing to it, although the implementation may not
202  *    be exactly like that. Since 2.20
203  *
204  * Flags used when an operation may create a file.
205  */
206 typedef enum {
207   G_FILE_CREATE_NONE    = 0,
208   G_FILE_CREATE_PRIVATE = (1 << 0),
209   G_FILE_CREATE_REPLACE_DESTINATION = (1 << 1)
210 } GFileCreateFlags;
211
212 /**
213  * GFileMeasureFlags:
214  * @G_FILE_MEASURE_NONE: No flags set.
215  * @G_FILE_MEASURE_REPORT_ANY_ERROR: Report any error encountered
216  *   while traversing the directory tree.  Normally errors are only
217  *   reported for the toplevel file.
218  * @G_FILE_MEASURE_APPARENT_SIZE: Tally usage based on apparent file
219  *   sizes.  Normally, the block-size is used, if available, as this is a
220  *   more accurate representation of disk space used.
221  *   Compare with `du --apparent-size`.
222  * @G_FILE_MEASURE_NO_XDEV: Do not cross mount point boundaries.
223  *   Compare with `du -x`.
224  *
225  * Flags that can be used with g_file_measure_disk_usage().
226  *
227  * Since: 2.38
228  **/
229 typedef enum {
230   G_FILE_MEASURE_NONE                 = 0,
231   G_FILE_MEASURE_REPORT_ANY_ERROR     = (1 << 1),
232   G_FILE_MEASURE_APPARENT_SIZE        = (1 << 2),
233   G_FILE_MEASURE_NO_XDEV              = (1 << 3)
234 } GFileMeasureFlags;
235
236 /**
237  * GMountMountFlags:
238  * @G_MOUNT_MOUNT_NONE: No flags set.
239  *
240  * Flags used when mounting a mount.
241  */
242 typedef enum /*< flags >*/ {
243   G_MOUNT_MOUNT_NONE = 0
244 } GMountMountFlags;
245
246
247 /**
248  * GMountUnmountFlags:
249  * @G_MOUNT_UNMOUNT_NONE: No flags set.
250  * @G_MOUNT_UNMOUNT_FORCE: Unmount even if there are outstanding
251  *  file operations on the mount.
252  *
253  * Flags used when an unmounting a mount.
254  */
255 typedef enum {
256   G_MOUNT_UNMOUNT_NONE  = 0,
257   G_MOUNT_UNMOUNT_FORCE = (1 << 0)
258 } GMountUnmountFlags;
259
260 /**
261  * GDriveStartFlags:
262  * @G_DRIVE_START_NONE: No flags set.
263  *
264  * Flags used when starting a drive.
265  *
266  * Since: 2.22
267  */
268 typedef enum /*< flags >*/ {
269   G_DRIVE_START_NONE = 0
270 } GDriveStartFlags;
271
272 /**
273  * GDriveStartStopType:
274  * @G_DRIVE_START_STOP_TYPE_UNKNOWN: Unknown or drive doesn't support
275  *    start/stop.
276  * @G_DRIVE_START_STOP_TYPE_SHUTDOWN: The stop method will physically
277  *    shut down the drive and e.g. power down the port the drive is
278  *    attached to.
279  * @G_DRIVE_START_STOP_TYPE_NETWORK: The start/stop methods are used
280  *    for connecting/disconnect to the drive over the network.
281  * @G_DRIVE_START_STOP_TYPE_MULTIDISK: The start/stop methods will
282  *    assemble/disassemble a virtual drive from several physical
283  *    drives.
284  * @G_DRIVE_START_STOP_TYPE_PASSWORD: The start/stop methods will
285  *    unlock/lock the disk (for example using the ATA <quote>SECURITY
286  *    UNLOCK DEVICE</quote> command)
287  *
288  * Enumeration describing how a drive can be started/stopped.
289  *
290  * Since: 2.22
291  */
292 typedef enum {
293   G_DRIVE_START_STOP_TYPE_UNKNOWN,
294   G_DRIVE_START_STOP_TYPE_SHUTDOWN,
295   G_DRIVE_START_STOP_TYPE_NETWORK,
296   G_DRIVE_START_STOP_TYPE_MULTIDISK,
297   G_DRIVE_START_STOP_TYPE_PASSWORD
298 } GDriveStartStopType;
299
300 /**
301  * GFileCopyFlags:
302  * @G_FILE_COPY_NONE: No flags set.
303  * @G_FILE_COPY_OVERWRITE: Overwrite any existing files
304  * @G_FILE_COPY_BACKUP: Make a backup of any existing files.
305  * @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks.
306  * @G_FILE_COPY_ALL_METADATA: Copy all file metadata instead of just default set used for copy (see #GFileInfo).
307  * @G_FILE_COPY_NO_FALLBACK_FOR_MOVE: Don't use copy and delete fallback if native move not supported.
308  * @G_FILE_COPY_TARGET_DEFAULT_PERMS: Leaves target file with default perms, instead of setting the source file perms.
309  *
310  * Flags used when copying or moving files.
311  */
312 typedef enum {
313   G_FILE_COPY_NONE                 = 0,          /*< nick=none >*/
314   G_FILE_COPY_OVERWRITE            = (1 << 0),
315   G_FILE_COPY_BACKUP               = (1 << 1),
316   G_FILE_COPY_NOFOLLOW_SYMLINKS    = (1 << 2),
317   G_FILE_COPY_ALL_METADATA         = (1 << 3),
318   G_FILE_COPY_NO_FALLBACK_FOR_MOVE = (1 << 4),
319   G_FILE_COPY_TARGET_DEFAULT_PERMS = (1 << 5)
320 } GFileCopyFlags;
321
322
323 /**
324  * GFileMonitorFlags:
325  * @G_FILE_MONITOR_NONE: No flags set.
326  * @G_FILE_MONITOR_WATCH_MOUNTS: Watch for mount events.
327  * @G_FILE_MONITOR_SEND_MOVED: Pair DELETED and CREATED events caused
328  *   by file renames (moves) and send a single G_FILE_MONITOR_EVENT_MOVED
329  *   event instead (NB: not supported on all backends; the default
330  *   behaviour -without specifying this flag- is to send single DELETED
331  *   and CREATED events).
332  * @G_FILE_MONITOR_WATCH_HARD_LINKS: Watch for changes to the file made
333  *   via another hard link. Since 2.36.
334  *
335  * Flags used to set what a #GFileMonitor will watch for.
336  */
337 typedef enum {
338   G_FILE_MONITOR_NONE             = 0,
339   G_FILE_MONITOR_WATCH_MOUNTS     = (1 << 0),
340   G_FILE_MONITOR_SEND_MOVED       = (1 << 1),
341   G_FILE_MONITOR_WATCH_HARD_LINKS = (1 << 2)
342 } GFileMonitorFlags;
343
344
345 /**
346  * GFileType:
347  * @G_FILE_TYPE_UNKNOWN: File's type is unknown.
348  * @G_FILE_TYPE_REGULAR: File handle represents a regular file.
349  * @G_FILE_TYPE_DIRECTORY: File handle represents a directory.
350  * @G_FILE_TYPE_SYMBOLIC_LINK: File handle represents a symbolic link
351  *    (Unix systems).
352  * @G_FILE_TYPE_SPECIAL: File is a "special" file, such as a socket, fifo,
353  *    block device, or character device.
354  * @G_FILE_TYPE_SHORTCUT: File is a shortcut (Windows systems).
355  * @G_FILE_TYPE_MOUNTABLE: File is a mountable location.
356  *
357  * Indicates the file's on-disk type.
358  **/
359 typedef enum {
360   G_FILE_TYPE_UNKNOWN = 0,
361   G_FILE_TYPE_REGULAR,
362   G_FILE_TYPE_DIRECTORY,
363   G_FILE_TYPE_SYMBOLIC_LINK,
364   G_FILE_TYPE_SPECIAL, /* socket, fifo, blockdev, chardev */
365   G_FILE_TYPE_SHORTCUT,
366   G_FILE_TYPE_MOUNTABLE
367 } GFileType;
368
369
370 /**
371  * GFilesystemPreviewType:
372  * @G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS: Only preview files if user has explicitly requested it.
373  * @G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL: Preview files if user has requested preview of "local" files.
374  * @G_FILESYSTEM_PREVIEW_TYPE_NEVER: Never preview files.
375  *
376  * Indicates a hint from the file system whether files should be
377  * previewed in a file manager. Returned as the value of the key
378  * #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW.
379  **/
380 typedef enum {
381   G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS = 0,
382   G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL,
383   G_FILESYSTEM_PREVIEW_TYPE_NEVER
384 } GFilesystemPreviewType;
385
386
387 /**
388  * GFileMonitorEvent:
389  * @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
390  * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
391  * @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
392  * @G_FILE_MONITOR_EVENT_CREATED: a file was created.
393  * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
394  * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
395  * @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was unmounted.
396  * @G_FILE_MONITOR_EVENT_MOVED: the file was moved.
397  *
398  * Specifies what type of event a monitor event is.
399  **/
400 typedef enum {
401   G_FILE_MONITOR_EVENT_CHANGED,
402   G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
403   G_FILE_MONITOR_EVENT_DELETED,
404   G_FILE_MONITOR_EVENT_CREATED,
405   G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
406   G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
407   G_FILE_MONITOR_EVENT_UNMOUNTED,
408   G_FILE_MONITOR_EVENT_MOVED
409 } GFileMonitorEvent;
410
411
412 /* This enumeration conflicts with GIOError in giochannel.h. However,
413  * that is only used as a return value in some deprecated functions.
414  * So, we reuse the same prefix for the enumeration values, but call
415  * the actual enumeration (which is rarely used) GIOErrorEnum.
416  */
417 /**
418  * GIOErrorEnum:
419  * @G_IO_ERROR_FAILED: Generic error condition for when an operation fails
420  *     and no more specific #GIOErrorEnum value is defined.
421  * @G_IO_ERROR_NOT_FOUND: File not found.
422  * @G_IO_ERROR_EXISTS: File already exists.
423  * @G_IO_ERROR_IS_DIRECTORY: File is a directory.
424  * @G_IO_ERROR_NOT_DIRECTORY: File is not a directory.
425  * @G_IO_ERROR_NOT_EMPTY: File is a directory that isn't empty.
426  * @G_IO_ERROR_NOT_REGULAR_FILE: File is not a regular file.
427  * @G_IO_ERROR_NOT_SYMBOLIC_LINK: File is not a symbolic link.
428  * @G_IO_ERROR_NOT_MOUNTABLE_FILE: File cannot be mounted.
429  * @G_IO_ERROR_FILENAME_TOO_LONG: Filename is too many characters.
430  * @G_IO_ERROR_INVALID_FILENAME: Filename is invalid or contains invalid characters.
431  * @G_IO_ERROR_TOO_MANY_LINKS: File contains too many symbolic links.
432  * @G_IO_ERROR_NO_SPACE: No space left on drive.
433  * @G_IO_ERROR_INVALID_ARGUMENT: Invalid argument.
434  * @G_IO_ERROR_PERMISSION_DENIED: Permission denied.
435  * @G_IO_ERROR_NOT_SUPPORTED: Operation not supported for the current backend.
436  * @G_IO_ERROR_NOT_MOUNTED: File isn't mounted.
437  * @G_IO_ERROR_ALREADY_MOUNTED: File is already mounted.
438  * @G_IO_ERROR_CLOSED: File was closed.
439  * @G_IO_ERROR_CANCELLED: Operation was cancelled. See #GCancellable.
440  * @G_IO_ERROR_PENDING: Operations are still pending.
441  * @G_IO_ERROR_READ_ONLY: File is read only.
442  * @G_IO_ERROR_CANT_CREATE_BACKUP: Backup couldn't be created.
443  * @G_IO_ERROR_WRONG_ETAG: File's Entity Tag was incorrect.
444  * @G_IO_ERROR_TIMED_OUT: Operation timed out.
445  * @G_IO_ERROR_WOULD_RECURSE: Operation would be recursive.
446  * @G_IO_ERROR_BUSY: File is busy.
447  * @G_IO_ERROR_WOULD_BLOCK: Operation would block.
448  * @G_IO_ERROR_HOST_NOT_FOUND: Host couldn't be found (remote operations).
449  * @G_IO_ERROR_WOULD_MERGE: Operation would merge files.
450  * @G_IO_ERROR_FAILED_HANDLED: Operation failed and a helper program has
451  *     already interacted with the user. Do not display any error dialog.
452  * @G_IO_ERROR_TOO_MANY_OPEN_FILES: The current process has too many files
453  *     open and can't open any more. Duplicate descriptors do count toward
454  *     this limit. Since 2.20
455  * @G_IO_ERROR_NOT_INITIALIZED: The object has not been initialized. Since 2.22
456  * @G_IO_ERROR_ADDRESS_IN_USE: The requested address is already in use. Since 2.22
457  * @G_IO_ERROR_PARTIAL_INPUT: Need more input to finish operation. Since 2.24
458  * @G_IO_ERROR_INVALID_DATA: The input data was invalid. Since 2.24
459  * @G_IO_ERROR_DBUS_ERROR: A remote object generated an error that
460  *     doesn't correspond to a locally registered #GError error
461  *     domain. Use g_dbus_error_get_remote_error() to extract the D-Bus
462  *     error name and g_dbus_error_strip_remote_error() to fix up the
463  *     message so it matches what was received on the wire. Since 2.26.
464  * @G_IO_ERROR_HOST_UNREACHABLE: Host unreachable. Since 2.26
465  * @G_IO_ERROR_NETWORK_UNREACHABLE: Network unreachable. Since 2.26
466  * @G_IO_ERROR_CONNECTION_REFUSED: Connection refused. Since 2.26
467  * @G_IO_ERROR_PROXY_FAILED: Connection to proxy server failed. Since 2.26
468  * @G_IO_ERROR_PROXY_AUTH_FAILED: Proxy authentication failed. Since 2.26
469  * @G_IO_ERROR_PROXY_NEED_AUTH: Proxy server needs authentication. Since 2.26
470  * @G_IO_ERROR_PROXY_NOT_ALLOWED: Proxy connection is not allowed by ruleset.
471  *     Since 2.26
472  * @G_IO_ERROR_BROKEN_PIPE: Broken pipe. Since 2.36
473  *
474  * Error codes returned by GIO functions.
475  *
476  * Note that this domain may be extended in future GLib releases. In
477  * general, new error codes either only apply to new APIs, or else
478  * replace #G_IO_ERROR_FAILED in cases that were not explicitly
479  * distinguished before. You should therefore avoid writing code like
480  * |[<!-- language="C" -->
481  * if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_FAILED))
482  *   {
483  *     // Assume that this is EPRINTERONFIRE
484  *     ...
485  *   }
486  * ]|
487  * but should instead treat all unrecognized error codes the same as
488  * #G_IO_ERROR_FAILED.
489  **/
490 typedef enum {
491   G_IO_ERROR_FAILED,
492   G_IO_ERROR_NOT_FOUND,
493   G_IO_ERROR_EXISTS,
494   G_IO_ERROR_IS_DIRECTORY,
495   G_IO_ERROR_NOT_DIRECTORY,
496   G_IO_ERROR_NOT_EMPTY,
497   G_IO_ERROR_NOT_REGULAR_FILE,
498   G_IO_ERROR_NOT_SYMBOLIC_LINK,
499   G_IO_ERROR_NOT_MOUNTABLE_FILE,
500   G_IO_ERROR_FILENAME_TOO_LONG,
501   G_IO_ERROR_INVALID_FILENAME,
502   G_IO_ERROR_TOO_MANY_LINKS,
503   G_IO_ERROR_NO_SPACE,
504   G_IO_ERROR_INVALID_ARGUMENT,
505   G_IO_ERROR_PERMISSION_DENIED,
506   G_IO_ERROR_NOT_SUPPORTED,
507   G_IO_ERROR_NOT_MOUNTED,
508   G_IO_ERROR_ALREADY_MOUNTED,
509   G_IO_ERROR_CLOSED,
510   G_IO_ERROR_CANCELLED,
511   G_IO_ERROR_PENDING,
512   G_IO_ERROR_READ_ONLY,
513   G_IO_ERROR_CANT_CREATE_BACKUP,
514   G_IO_ERROR_WRONG_ETAG,
515   G_IO_ERROR_TIMED_OUT,
516   G_IO_ERROR_WOULD_RECURSE,
517   G_IO_ERROR_BUSY,
518   G_IO_ERROR_WOULD_BLOCK,
519   G_IO_ERROR_HOST_NOT_FOUND,
520   G_IO_ERROR_WOULD_MERGE,
521   G_IO_ERROR_FAILED_HANDLED,
522   G_IO_ERROR_TOO_MANY_OPEN_FILES,
523   G_IO_ERROR_NOT_INITIALIZED,
524   G_IO_ERROR_ADDRESS_IN_USE,
525   G_IO_ERROR_PARTIAL_INPUT,
526   G_IO_ERROR_INVALID_DATA,
527   G_IO_ERROR_DBUS_ERROR,
528   G_IO_ERROR_HOST_UNREACHABLE,
529   G_IO_ERROR_NETWORK_UNREACHABLE,
530   G_IO_ERROR_CONNECTION_REFUSED,
531   G_IO_ERROR_PROXY_FAILED,
532   G_IO_ERROR_PROXY_AUTH_FAILED,
533   G_IO_ERROR_PROXY_NEED_AUTH,
534   G_IO_ERROR_PROXY_NOT_ALLOWED,
535   G_IO_ERROR_BROKEN_PIPE
536 } GIOErrorEnum;
537
538
539 /**
540  * GAskPasswordFlags:
541  * @G_ASK_PASSWORD_NEED_PASSWORD: operation requires a password.
542  * @G_ASK_PASSWORD_NEED_USERNAME: operation requires a username.
543  * @G_ASK_PASSWORD_NEED_DOMAIN: operation requires a domain.
544  * @G_ASK_PASSWORD_SAVING_SUPPORTED: operation supports saving settings.
545  * @G_ASK_PASSWORD_ANONYMOUS_SUPPORTED: operation supports anonymous users.
546  *
547  * #GAskPasswordFlags are used to request specific information from the
548  * user, or to notify the user of their choices in an authentication
549  * situation.
550  **/
551 typedef enum {
552   G_ASK_PASSWORD_NEED_PASSWORD       = (1 << 0),
553   G_ASK_PASSWORD_NEED_USERNAME       = (1 << 1),
554   G_ASK_PASSWORD_NEED_DOMAIN         = (1 << 2),
555   G_ASK_PASSWORD_SAVING_SUPPORTED    = (1 << 3),
556   G_ASK_PASSWORD_ANONYMOUS_SUPPORTED = (1 << 4)
557 } GAskPasswordFlags;
558
559
560 /**
561  * GPasswordSave:
562  * @G_PASSWORD_SAVE_NEVER: never save a password.
563  * @G_PASSWORD_SAVE_FOR_SESSION: save a password for the session.
564  * @G_PASSWORD_SAVE_PERMANENTLY: save a password permanently.
565  *
566  * #GPasswordSave is used to indicate the lifespan of a saved password.
567  *
568  * #Gvfs stores passwords in the Gnome keyring when this flag allows it
569  * to, and later retrieves it again from there.
570  **/
571 typedef enum {
572   G_PASSWORD_SAVE_NEVER,
573   G_PASSWORD_SAVE_FOR_SESSION,
574   G_PASSWORD_SAVE_PERMANENTLY
575 } GPasswordSave;
576
577
578 /**
579  * GMountOperationResult:
580  * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the
581  *     user specified data is now available
582  * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation
583  *     to be aborted
584  * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not
585  *     implemented)
586  *
587  * #GMountOperationResult is returned as a result when a request for
588  * information is send by the mounting operation.
589  **/
590 typedef enum {
591   G_MOUNT_OPERATION_HANDLED,
592   G_MOUNT_OPERATION_ABORTED,
593   G_MOUNT_OPERATION_UNHANDLED
594 } GMountOperationResult;
595
596
597 /**
598  * GOutputStreamSpliceFlags:
599  * @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream.
600  * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after
601  *     the splice.
602  * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after
603  *     the splice.
604  *
605  * GOutputStreamSpliceFlags determine how streams should be spliced.
606  **/
607 typedef enum {
608   G_OUTPUT_STREAM_SPLICE_NONE         = 0,
609   G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE = (1 << 0),
610   G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET = (1 << 1)
611 } GOutputStreamSpliceFlags;
612
613
614 /**
615  * GIOStreamSpliceFlags:
616  * @G_IO_STREAM_SPLICE_NONE: Do not close either stream.
617  * @G_IO_STREAM_SPLICE_CLOSE_STREAM1: Close the first stream after
618  *     the splice.
619  * @G_IO_STREAM_SPLICE_CLOSE_STREAM2: Close the second stream after
620  *     the splice.
621  * @G_IO_STREAM_SPLICE_WAIT_FOR_BOTH: Wait for both splice operations to finish
622  *     before calling the callback.
623  *
624  * GIOStreamSpliceFlags determine how streams should be spliced.
625  *
626  * Since: 2.28
627  **/
628 typedef enum {
629   G_IO_STREAM_SPLICE_NONE          = 0,
630   G_IO_STREAM_SPLICE_CLOSE_STREAM1 = (1 << 0),
631   G_IO_STREAM_SPLICE_CLOSE_STREAM2 = (1 << 1),
632   G_IO_STREAM_SPLICE_WAIT_FOR_BOTH = (1 << 2)
633 } GIOStreamSpliceFlags;
634
635 /**
636  * GEmblemOrigin:
637  * @G_EMBLEM_ORIGIN_UNKNOWN: Emblem of unknown origin
638  * @G_EMBLEM_ORIGIN_DEVICE: Emblem adds device-specific information
639  * @G_EMBLEM_ORIGIN_LIVEMETADATA: Emblem depicts live metadata, such as "readonly"
640  * @G_EMBLEM_ORIGIN_TAG: Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)
641  *
642  * GEmblemOrigin is used to add information about the origin of the emblem
643  * to #GEmblem.
644  *
645  * Since: 2.18
646  */
647 typedef enum  {
648   G_EMBLEM_ORIGIN_UNKNOWN,
649   G_EMBLEM_ORIGIN_DEVICE,
650   G_EMBLEM_ORIGIN_LIVEMETADATA,
651   G_EMBLEM_ORIGIN_TAG
652 } GEmblemOrigin;
653
654 /**
655  * GResolverError:
656  * @G_RESOLVER_ERROR_NOT_FOUND: the requested name/address/service was not
657  *     found
658  * @G_RESOLVER_ERROR_TEMPORARY_FAILURE: the requested information could not
659  *     be looked up due to a network error or similar problem
660  * @G_RESOLVER_ERROR_INTERNAL: unknown error
661  *
662  * An error code used with %G_RESOLVER_ERROR in a #GError returned
663  * from a #GResolver routine.
664  *
665  * Since: 2.22
666  */
667 typedef enum {
668   G_RESOLVER_ERROR_NOT_FOUND,
669   G_RESOLVER_ERROR_TEMPORARY_FAILURE,
670   G_RESOLVER_ERROR_INTERNAL
671 } GResolverError;
672
673 /**
674  * GResolverRecordType:
675  * @G_RESOLVER_RECORD_SRV: lookup DNS SRV records for a domain
676  * @G_RESOLVER_RECORD_MX: lookup DNS MX records for a domain
677  * @G_RESOLVER_RECORD_TXT: lookup DNS TXT records for a name
678  * @G_RESOLVER_RECORD_SOA: lookup DNS SOA records for a zone
679  * @G_RESOLVER_RECORD_NS: lookup DNS NS records for a domain
680  *
681  * The type of record that g_resolver_lookup_records() or
682  * g_resolver_lookup_records_async() should retrieve. The records are returned
683  * as lists of #GVariant tuples. Each record type has different values in
684  * the variant tuples returned.
685  *
686  * %G_RESOLVER_RECORD_SRV records are returned as variants with the signature
687  * '(qqqs)', containing a guint16 with the priority, a guint16 with the
688  * weight, a guint16 with the port, and a string of the hostname.
689  *
690  * %G_RESOLVER_RECORD_MX records are returned as variants with the signature
691  * '(qs)', representing a guint16 with the preference, and a string containing
692  * the mail exchanger hostname.
693  *
694  * %G_RESOLVER_RECORD_TXT records are returned as variants with the signature
695  * '(as)', representing an array of the strings in the text record.
696  *
697  * %G_RESOLVER_RECORD_SOA records are returned as variants with the signature
698  * '(ssuuuuu)', representing a string containing the primary name server, a
699  * string containing the administrator, the serial as a guint32, the refresh
700  * interval as guint32, the retry interval as a guint32, the expire timeout
701  * as a guint32, and the ttl as a guint32.
702  *
703  * %G_RESOLVER_RECORD_NS records are returned as variants with the signature
704  * '(s)', representing a string of the hostname of the name server.
705  *
706  * Since: 2.34
707  */
708 typedef enum {
709   G_RESOLVER_RECORD_SRV = 1,
710   G_RESOLVER_RECORD_MX,
711   G_RESOLVER_RECORD_TXT,
712   G_RESOLVER_RECORD_SOA,
713   G_RESOLVER_RECORD_NS
714 } GResolverRecordType;
715
716 /**
717  * GResourceError:
718  * @G_RESOURCE_ERROR_NOT_FOUND: no file was found at the requested path
719  * @G_RESOURCE_ERROR_INTERNAL: unknown error
720  *
721  * An error code used with %G_RESOURCE_ERROR in a #GError returned
722  * from a #GResource routine.
723  *
724  * Since: 2.32
725  */
726 typedef enum {
727   G_RESOURCE_ERROR_NOT_FOUND,
728   G_RESOURCE_ERROR_INTERNAL
729 } GResourceError;
730
731 /**
732  * GResourceFlags:
733  * @G_RESOURCE_FLAGS_NONE: No flags set.
734  * @G_RESOURCE_FLAGS_COMPRESSED: The file is compressed.
735  *
736  * GResourceFlags give information about a particular file inside a resource
737  * bundle.
738  * 
739  * Since: 2.32
740  **/
741 typedef enum {
742   G_RESOURCE_FLAGS_NONE       = 0,
743   G_RESOURCE_FLAGS_COMPRESSED = (1<<0)
744 } GResourceFlags;
745
746 /**
747  * GResourceLookupFlags:
748  * @G_RESOURCE_LOOKUP_FLAGS_NONE: No flags set.
749  *
750  * GResourceLookupFlags determine how resource path lookups are handled.
751  * 
752  * Since: 2.32
753  **/
754 typedef enum /*< flags >*/ {
755   G_RESOURCE_LOOKUP_FLAGS_NONE       = 0
756 } GResourceLookupFlags;
757
758 /**
759  * GSocketFamily:
760  * @G_SOCKET_FAMILY_INVALID: no address family
761  * @G_SOCKET_FAMILY_IPV4: the IPv4 family
762  * @G_SOCKET_FAMILY_IPV6: the IPv6 family
763  * @G_SOCKET_FAMILY_UNIX: the UNIX domain family
764  *
765  * The protocol family of a #GSocketAddress. (These values are
766  * identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX,
767  * if available.)
768  *
769  * Since: 2.22
770  */
771 typedef enum {
772   G_SOCKET_FAMILY_INVALID,
773   G_SOCKET_FAMILY_UNIX = GLIB_SYSDEF_AF_UNIX,
774   G_SOCKET_FAMILY_IPV4 = GLIB_SYSDEF_AF_INET,
775   G_SOCKET_FAMILY_IPV6 = GLIB_SYSDEF_AF_INET6
776 } GSocketFamily;
777
778 /**
779  * GSocketType:
780  * @G_SOCKET_TYPE_INVALID: Type unknown or wrong
781  * @G_SOCKET_TYPE_STREAM: Reliable connection-based byte streams (e.g. TCP).
782  * @G_SOCKET_TYPE_DATAGRAM: Connectionless, unreliable datagram passing.
783  *     (e.g. UDP)
784  * @G_SOCKET_TYPE_SEQPACKET: Reliable connection-based passing of datagrams
785  *     of fixed maximum length (e.g. SCTP).
786  *
787  * Flags used when creating a #GSocket. Some protocols may not implement
788  * all the socket types.
789  *
790  * Since: 2.22
791  */
792 typedef enum
793 {
794   G_SOCKET_TYPE_INVALID,
795   G_SOCKET_TYPE_STREAM,
796   G_SOCKET_TYPE_DATAGRAM,
797   G_SOCKET_TYPE_SEQPACKET
798 } GSocketType;
799
800 /**
801  * GSocketMsgFlags:
802  * @G_SOCKET_MSG_NONE: No flags.
803  * @G_SOCKET_MSG_OOB: Request to send/receive out of band data.
804  * @G_SOCKET_MSG_PEEK: Read data from the socket without removing it from
805  *     the queue.
806  * @G_SOCKET_MSG_DONTROUTE: Don't use a gateway to send out the packet,
807  *     only send to hosts on directly connected networks.
808  *
809  * Flags used in g_socket_receive_message() and g_socket_send_message().
810  * The flags listed in the enum are some commonly available flags, but the
811  * values used for them are the same as on the platform, and any other flags
812  * are passed in/out as is. So to use a platform specific flag, just include
813  * the right system header and pass in the flag.
814  *
815  * Since: 2.22
816  */
817 typedef enum /*< flags >*/
818 {
819   G_SOCKET_MSG_NONE,
820   G_SOCKET_MSG_OOB = GLIB_SYSDEF_MSG_OOB,
821   G_SOCKET_MSG_PEEK = GLIB_SYSDEF_MSG_PEEK,
822   G_SOCKET_MSG_DONTROUTE = GLIB_SYSDEF_MSG_DONTROUTE
823 } GSocketMsgFlags;
824
825 /**
826  * GSocketProtocol:
827  * @G_SOCKET_PROTOCOL_UNKNOWN: The protocol type is unknown
828  * @G_SOCKET_PROTOCOL_DEFAULT: The default protocol for the family/type
829  * @G_SOCKET_PROTOCOL_TCP: TCP over IP
830  * @G_SOCKET_PROTOCOL_UDP: UDP over IP
831  * @G_SOCKET_PROTOCOL_SCTP: SCTP over IP
832  *
833  * A protocol identifier is specified when creating a #GSocket, which is a
834  * family/type specific identifier, where 0 means the default protocol for
835  * the particular family/type.
836  *
837  * This enum contains a set of commonly available and used protocols. You
838  * can also pass any other identifiers handled by the platform in order to
839  * use protocols not listed here.
840  *
841  * Since: 2.22
842  */
843 typedef enum {
844   G_SOCKET_PROTOCOL_UNKNOWN = -1,
845   G_SOCKET_PROTOCOL_DEFAULT = 0,
846   G_SOCKET_PROTOCOL_TCP     = 6,
847   G_SOCKET_PROTOCOL_UDP     = 17,
848   G_SOCKET_PROTOCOL_SCTP    = 132
849 } GSocketProtocol;
850
851 /**
852  * GZlibCompressorFormat:
853  * @G_ZLIB_COMPRESSOR_FORMAT_ZLIB: deflate compression with zlib header
854  * @G_ZLIB_COMPRESSOR_FORMAT_GZIP: gzip file format
855  * @G_ZLIB_COMPRESSOR_FORMAT_RAW: deflate compression with no header
856  *
857  * Used to select the type of data format to use for #GZlibDecompressor
858  * and #GZlibCompressor.
859  *
860  * Since: 2.24
861  */
862 typedef enum {
863   G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
864   G_ZLIB_COMPRESSOR_FORMAT_GZIP,
865   G_ZLIB_COMPRESSOR_FORMAT_RAW
866 } GZlibCompressorFormat;
867
868 /**
869  * GUnixSocketAddressType:
870  * @G_UNIX_SOCKET_ADDRESS_INVALID: invalid
871  * @G_UNIX_SOCKET_ADDRESS_ANONYMOUS: anonymous
872  * @G_UNIX_SOCKET_ADDRESS_PATH: a filesystem path
873  * @G_UNIX_SOCKET_ADDRESS_ABSTRACT: an abstract name
874  * @G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED: an abstract name, 0-padded
875  *   to the full length of a unix socket name
876  *
877  * The type of name used by a #GUnixSocketAddress.
878  * %G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain
879  * socket bound to a filesystem path. %G_UNIX_SOCKET_ADDRESS_ANONYMOUS
880  * indicates a socket not bound to any name (eg, a client-side socket,
881  * or a socket created with socketpair()).
882  *
883  * For abstract sockets, there are two incompatible ways of naming
884  * them; the man pages suggest using the entire `struct sockaddr_un`
885  * as the name, padding the unused parts of the %sun_path field with
886  * zeroes; this corresponds to %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED.
887  * However, many programs instead just use a portion of %sun_path, and
888  * pass an appropriate smaller length to bind() or connect(). This is
889  * %G_UNIX_SOCKET_ADDRESS_ABSTRACT.
890  *
891  * Since: 2.26
892  */
893 typedef enum {
894   G_UNIX_SOCKET_ADDRESS_INVALID,
895   G_UNIX_SOCKET_ADDRESS_ANONYMOUS,
896   G_UNIX_SOCKET_ADDRESS_PATH,
897   G_UNIX_SOCKET_ADDRESS_ABSTRACT,
898   G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
899 } GUnixSocketAddressType;
900
901 /**
902  * GBusType:
903  * @G_BUS_TYPE_STARTER: An alias for the message bus that activated the process, if any.
904  * @G_BUS_TYPE_NONE: Not a message bus.
905  * @G_BUS_TYPE_SYSTEM: The system-wide message bus.
906  * @G_BUS_TYPE_SESSION: The login session message bus.
907  *
908  * An enumeration for well-known message buses.
909  *
910  * Since: 2.26
911  */
912 typedef enum
913 {
914   G_BUS_TYPE_STARTER = -1,
915   G_BUS_TYPE_NONE = 0,
916   G_BUS_TYPE_SYSTEM  = 1,
917   G_BUS_TYPE_SESSION = 2
918 } GBusType;
919
920 /**
921  * GBusNameOwnerFlags:
922  * @G_BUS_NAME_OWNER_FLAGS_NONE: No flags set.
923  * @G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT: Allow another message bus connection to claim the name.
924  * @G_BUS_NAME_OWNER_FLAGS_REPLACE: If another message bus connection owns the name and have
925  * specified #G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection.
926  *
927  * Flags used in g_bus_own_name().
928  *
929  * Since: 2.26
930  */
931 typedef enum
932 {
933   G_BUS_NAME_OWNER_FLAGS_NONE = 0,                    /*< nick=none >*/
934   G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT = (1<<0),  /*< nick=allow-replacement >*/
935   G_BUS_NAME_OWNER_FLAGS_REPLACE = (1<<1)            /*< nick=replace >*/
936 } GBusNameOwnerFlags;
937
938 /**
939  * GBusNameWatcherFlags:
940  * @G_BUS_NAME_WATCHER_FLAGS_NONE: No flags set.
941  * @G_BUS_NAME_WATCHER_FLAGS_AUTO_START: If no-one owns the name when
942  * beginning to watch the name, ask the bus to launch an owner for the
943  * name.
944  *
945  * Flags used in g_bus_watch_name().
946  *
947  * Since: 2.26
948  */
949 typedef enum
950 {
951   G_BUS_NAME_WATCHER_FLAGS_NONE = 0,
952   G_BUS_NAME_WATCHER_FLAGS_AUTO_START = (1<<0)
953 } GBusNameWatcherFlags;
954
955 /**
956  * GDBusProxyFlags:
957  * @G_DBUS_PROXY_FLAGS_NONE: No flags set.
958  * @G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES: Don't load properties.
959  * @G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS: Don't connect to signals on the remote object.
960  * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START: If not set and the proxy if for a well-known name,
961  * then request the bus to launch an owner for the name if no-one owns the name. This flag can
962  * only be used in proxies for well-known names.
963  * @G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES: If set, the property value for any <emphasis>invalidated property</emphasis> will be (asynchronously) retrieved upon receiving the <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties">PropertiesChanged</ulink> D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32.
964  * @G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION: If the proxy is for a well-known name,
965  * do not ask the bus to launch an owner during proxy initialization, but allow it to be
966  * autostarted by a method call. This flag is only meaningful in proxies for well-known names,
967  * and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTOSTART is not also specified.
968  *
969  * Flags used when constructing an instance of a #GDBusProxy derived class.
970  *
971  * Since: 2.26
972  */
973 typedef enum
974 {
975   G_DBUS_PROXY_FLAGS_NONE = 0,
976   G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES = (1<<0),
977   G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS = (1<<1),
978   G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START = (1<<2),
979   G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES = (1<<3),
980   G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION = (1<<4)
981 } GDBusProxyFlags;
982
983 /**
984  * GDBusError:
985  * @G_DBUS_ERROR_FAILED:
986  * A generic error; "something went wrong" - see the error message for
987  * more.
988  * @G_DBUS_ERROR_NO_MEMORY:
989  * There was not enough memory to complete an operation.
990  * @G_DBUS_ERROR_SERVICE_UNKNOWN:
991  * The bus doesn't know how to launch a service to supply the bus name
992  * you wanted.
993  * @G_DBUS_ERROR_NAME_HAS_NO_OWNER:
994  * The bus name you referenced doesn't exist (i.e. no application owns
995  * it).
996  * @G_DBUS_ERROR_NO_REPLY:
997  * No reply to a message expecting one, usually means a timeout occurred.
998  * @G_DBUS_ERROR_IO_ERROR:
999  * Something went wrong reading or writing to a socket, for example.
1000  * @G_DBUS_ERROR_BAD_ADDRESS:
1001  * A D-Bus bus address was malformed.
1002  * @G_DBUS_ERROR_NOT_SUPPORTED:
1003  * Requested operation isn't supported (like ENOSYS on UNIX).
1004  * @G_DBUS_ERROR_LIMITS_EXCEEDED:
1005  * Some limited resource is exhausted.
1006  * @G_DBUS_ERROR_ACCESS_DENIED:
1007  * Security restrictions don't allow doing what you're trying to do.
1008  * @G_DBUS_ERROR_AUTH_FAILED:
1009  * Authentication didn't work.
1010  * @G_DBUS_ERROR_NO_SERVER:
1011  * Unable to connect to server (probably caused by ECONNREFUSED on a
1012  * socket).
1013  * @G_DBUS_ERROR_TIMEOUT:
1014  * Certain timeout errors, possibly ETIMEDOUT on a socket.  Note that
1015  * %G_DBUS_ERROR_NO_REPLY is used for message reply timeouts. Warning:
1016  * this is confusingly-named given that %G_DBUS_ERROR_TIMED_OUT also
1017  * exists. We can't fix it for compatibility reasons so just be
1018  * careful.
1019  * @G_DBUS_ERROR_NO_NETWORK:
1020  * No network access (probably ENETUNREACH on a socket).
1021  * @G_DBUS_ERROR_ADDRESS_IN_USE:
1022  * Can't bind a socket since its address is in use (i.e. EADDRINUSE).
1023  * @G_DBUS_ERROR_DISCONNECTED:
1024  * The connection is disconnected and you're trying to use it.
1025  * @G_DBUS_ERROR_INVALID_ARGS:
1026  * Invalid arguments passed to a method call.
1027  * @G_DBUS_ERROR_FILE_NOT_FOUND:
1028  * Missing file.
1029  * @G_DBUS_ERROR_FILE_EXISTS:
1030  * Existing file and the operation you're using does not silently overwrite.
1031  * @G_DBUS_ERROR_UNKNOWN_METHOD:
1032  * Method name you invoked isn't known by the object you invoked it on.
1033  * @G_DBUS_ERROR_TIMED_OUT:
1034  * Certain timeout errors, e.g. while starting a service. Warning: this is
1035  * confusingly-named given that %G_DBUS_ERROR_TIMEOUT also exists. We
1036  * can't fix it for compatibility reasons so just be careful.
1037  * @G_DBUS_ERROR_MATCH_RULE_NOT_FOUND:
1038  * Tried to remove or modify a match rule that didn't exist.
1039  * @G_DBUS_ERROR_MATCH_RULE_INVALID:
1040  * The match rule isn't syntactically valid.
1041  * @G_DBUS_ERROR_SPAWN_EXEC_FAILED:
1042  * While starting a new process, the exec() call failed.
1043  * @G_DBUS_ERROR_SPAWN_FORK_FAILED:
1044  * While starting a new process, the fork() call failed.
1045  * @G_DBUS_ERROR_SPAWN_CHILD_EXITED:
1046  * While starting a new process, the child exited with a status code.
1047  * @G_DBUS_ERROR_SPAWN_CHILD_SIGNALED:
1048  * While starting a new process, the child exited on a signal.
1049  * @G_DBUS_ERROR_SPAWN_FAILED:
1050  * While starting a new process, something went wrong.
1051  * @G_DBUS_ERROR_SPAWN_SETUP_FAILED:
1052  * We failed to setup the environment correctly.
1053  * @G_DBUS_ERROR_SPAWN_CONFIG_INVALID:
1054  * We failed to setup the config parser correctly.
1055  * @G_DBUS_ERROR_SPAWN_SERVICE_INVALID:
1056  * Bus name was not valid.
1057  * @G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND:
1058  * Service file not found in system-services directory.
1059  * @G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID:
1060  * Permissions are incorrect on the setuid helper.
1061  * @G_DBUS_ERROR_SPAWN_FILE_INVALID:
1062  * Service file invalid (Name, User or Exec missing).
1063  * @G_DBUS_ERROR_SPAWN_NO_MEMORY:
1064  * Tried to get a UNIX process ID and it wasn't available.
1065  * @G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN:
1066  * Tried to get a UNIX process ID and it wasn't available.
1067  * @G_DBUS_ERROR_INVALID_SIGNATURE:
1068  * A type signature is not valid.
1069  * @G_DBUS_ERROR_INVALID_FILE_CONTENT:
1070  * A file contains invalid syntax or is otherwise broken.
1071  * @G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN:
1072  * Asked for SELinux security context and it wasn't available.
1073  * @G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN:
1074  * Asked for ADT audit data and it wasn't available.
1075  * @G_DBUS_ERROR_OBJECT_PATH_IN_USE:
1076  * There's already an object with the requested object path.
1077  *
1078  * Error codes for the %G_DBUS_ERROR error domain.
1079  *
1080  * Since: 2.26
1081  */
1082 typedef enum
1083 {
1084   /* Well-known errors in the org.freedesktop.DBus.Error namespace */
1085   G_DBUS_ERROR_FAILED,                           /* org.freedesktop.DBus.Error.Failed */
1086   G_DBUS_ERROR_NO_MEMORY,                        /* org.freedesktop.DBus.Error.NoMemory */
1087   G_DBUS_ERROR_SERVICE_UNKNOWN,                  /* org.freedesktop.DBus.Error.ServiceUnknown */
1088   G_DBUS_ERROR_NAME_HAS_NO_OWNER,                /* org.freedesktop.DBus.Error.NameHasNoOwner */
1089   G_DBUS_ERROR_NO_REPLY,                         /* org.freedesktop.DBus.Error.NoReply */
1090   G_DBUS_ERROR_IO_ERROR,                         /* org.freedesktop.DBus.Error.IOError */
1091   G_DBUS_ERROR_BAD_ADDRESS,                      /* org.freedesktop.DBus.Error.BadAddress */
1092   G_DBUS_ERROR_NOT_SUPPORTED,                    /* org.freedesktop.DBus.Error.NotSupported */
1093   G_DBUS_ERROR_LIMITS_EXCEEDED,                  /* org.freedesktop.DBus.Error.LimitsExceeded */
1094   G_DBUS_ERROR_ACCESS_DENIED,                    /* org.freedesktop.DBus.Error.AccessDenied */
1095   G_DBUS_ERROR_AUTH_FAILED,                      /* org.freedesktop.DBus.Error.AuthFailed */
1096   G_DBUS_ERROR_NO_SERVER,                        /* org.freedesktop.DBus.Error.NoServer */
1097   G_DBUS_ERROR_TIMEOUT,                          /* org.freedesktop.DBus.Error.Timeout */
1098   G_DBUS_ERROR_NO_NETWORK,                       /* org.freedesktop.DBus.Error.NoNetwork */
1099   G_DBUS_ERROR_ADDRESS_IN_USE,                   /* org.freedesktop.DBus.Error.AddressInUse */
1100   G_DBUS_ERROR_DISCONNECTED,                     /* org.freedesktop.DBus.Error.Disconnected */
1101   G_DBUS_ERROR_INVALID_ARGS,                     /* org.freedesktop.DBus.Error.InvalidArgs */
1102   G_DBUS_ERROR_FILE_NOT_FOUND,                   /* org.freedesktop.DBus.Error.FileNotFound */
1103   G_DBUS_ERROR_FILE_EXISTS,                      /* org.freedesktop.DBus.Error.FileExists */
1104   G_DBUS_ERROR_UNKNOWN_METHOD,                   /* org.freedesktop.DBus.Error.UnknownMethod */
1105   G_DBUS_ERROR_TIMED_OUT,                        /* org.freedesktop.DBus.Error.TimedOut */
1106   G_DBUS_ERROR_MATCH_RULE_NOT_FOUND,             /* org.freedesktop.DBus.Error.MatchRuleNotFound */
1107   G_DBUS_ERROR_MATCH_RULE_INVALID,               /* org.freedesktop.DBus.Error.MatchRuleInvalid */
1108   G_DBUS_ERROR_SPAWN_EXEC_FAILED,                /* org.freedesktop.DBus.Error.Spawn.ExecFailed */
1109   G_DBUS_ERROR_SPAWN_FORK_FAILED,                /* org.freedesktop.DBus.Error.Spawn.ForkFailed */
1110   G_DBUS_ERROR_SPAWN_CHILD_EXITED,               /* org.freedesktop.DBus.Error.Spawn.ChildExited */
1111   G_DBUS_ERROR_SPAWN_CHILD_SIGNALED,             /* org.freedesktop.DBus.Error.Spawn.ChildSignaled */
1112   G_DBUS_ERROR_SPAWN_FAILED,                     /* org.freedesktop.DBus.Error.Spawn.Failed */
1113   G_DBUS_ERROR_SPAWN_SETUP_FAILED,               /* org.freedesktop.DBus.Error.Spawn.FailedToSetup */
1114   G_DBUS_ERROR_SPAWN_CONFIG_INVALID,             /* org.freedesktop.DBus.Error.Spawn.ConfigInvalid */
1115   G_DBUS_ERROR_SPAWN_SERVICE_INVALID,            /* org.freedesktop.DBus.Error.Spawn.ServiceNotValid */
1116   G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND,          /* org.freedesktop.DBus.Error.Spawn.ServiceNotFound */
1117   G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID,        /* org.freedesktop.DBus.Error.Spawn.PermissionsInvalid */
1118   G_DBUS_ERROR_SPAWN_FILE_INVALID,               /* org.freedesktop.DBus.Error.Spawn.FileInvalid */
1119   G_DBUS_ERROR_SPAWN_NO_MEMORY,                  /* org.freedesktop.DBus.Error.Spawn.NoMemory */
1120   G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN,          /* org.freedesktop.DBus.Error.UnixProcessIdUnknown */
1121   G_DBUS_ERROR_INVALID_SIGNATURE,                /* org.freedesktop.DBus.Error.InvalidSignature */
1122   G_DBUS_ERROR_INVALID_FILE_CONTENT,             /* org.freedesktop.DBus.Error.InvalidFileContent */
1123   G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN, /* org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown */
1124   G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN,           /* org.freedesktop.DBus.Error.AdtAuditDataUnknown */
1125   G_DBUS_ERROR_OBJECT_PATH_IN_USE                /* org.freedesktop.DBus.Error.ObjectPathInUse */
1126 } GDBusError;
1127 /* Remember to update g_dbus_error_quark() in gdbuserror.c if you extend this enumeration */
1128
1129 /**
1130  * GDBusConnectionFlags:
1131  * @G_DBUS_CONNECTION_FLAGS_NONE: No flags set.
1132  * @G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT: Perform authentication against server.
1133  * @G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER: Perform authentication against client.
1134  * @G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS: When
1135  * authenticating as a server, allow the anonymous authentication
1136  * method.
1137  * @G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION: Pass this flag if connecting to a peer that is a
1138  * message bus. This means that the Hello() method will be invoked as part of the connection setup.
1139  * @G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING: If set, processing of D-Bus messages is
1140  * delayed until g_dbus_connection_start_message_processing() is called.
1141  *
1142  * Flags used when creating a new #GDBusConnection.
1143  *
1144  * Since: 2.26
1145  */
1146 typedef enum {
1147   G_DBUS_CONNECTION_FLAGS_NONE = 0,
1148   G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT = (1<<0),
1149   G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER = (1<<1),
1150   G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS = (1<<2),
1151   G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION = (1<<3),
1152   G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING = (1<<4)
1153 } GDBusConnectionFlags;
1154
1155 /**
1156  * GDBusCapabilityFlags:
1157  * @G_DBUS_CAPABILITY_FLAGS_NONE: No flags set.
1158  * @G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING: The connection
1159  * supports exchanging UNIX file descriptors with the remote peer.
1160  *
1161  * Capabilities negotiated with the remote peer.
1162  *
1163  * Since: 2.26
1164  */
1165 typedef enum {
1166   G_DBUS_CAPABILITY_FLAGS_NONE = 0,
1167   G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING = (1<<0)
1168 } GDBusCapabilityFlags;
1169
1170 /**
1171  * GDBusCallFlags:
1172  * @G_DBUS_CALL_FLAGS_NONE: No flags set.
1173  * @G_DBUS_CALL_FLAGS_NO_AUTO_START: The bus must not launch
1174  * an owner for the destination name in response to this method
1175  * invocation.
1176  *
1177  * Flags used in g_dbus_connection_call() and similar APIs.
1178  *
1179  * Since: 2.26
1180  */
1181 typedef enum {
1182   G_DBUS_CALL_FLAGS_NONE = 0,
1183   G_DBUS_CALL_FLAGS_NO_AUTO_START = (1<<0)
1184 } GDBusCallFlags;
1185 /* (1<<31) is reserved for internal use by GDBusConnection, do not use it. */
1186
1187 /**
1188  * GDBusMessageType:
1189  * @G_DBUS_MESSAGE_TYPE_INVALID: Message is of invalid type.
1190  * @G_DBUS_MESSAGE_TYPE_METHOD_CALL: Method call.
1191  * @G_DBUS_MESSAGE_TYPE_METHOD_RETURN: Method reply.
1192  * @G_DBUS_MESSAGE_TYPE_ERROR: Error reply.
1193  * @G_DBUS_MESSAGE_TYPE_SIGNAL: Signal emission.
1194  *
1195  * Message types used in #GDBusMessage.
1196  *
1197  * Since: 2.26
1198  */
1199 typedef enum {
1200   G_DBUS_MESSAGE_TYPE_INVALID,
1201   G_DBUS_MESSAGE_TYPE_METHOD_CALL,
1202   G_DBUS_MESSAGE_TYPE_METHOD_RETURN,
1203   G_DBUS_MESSAGE_TYPE_ERROR,
1204   G_DBUS_MESSAGE_TYPE_SIGNAL
1205 } GDBusMessageType;
1206
1207 /**
1208  * GDBusMessageFlags:
1209  * @G_DBUS_MESSAGE_FLAGS_NONE: No flags set.
1210  * @G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED: A reply is not expected.
1211  * @G_DBUS_MESSAGE_FLAGS_NO_AUTO_START: The bus must not launch an
1212  * owner for the destination name in response to this message.
1213  *
1214  * Message flags used in #GDBusMessage.
1215  *
1216  * Since: 2.26
1217  */
1218 typedef enum {
1219   G_DBUS_MESSAGE_FLAGS_NONE = 0,
1220   G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED = (1<<0),
1221   G_DBUS_MESSAGE_FLAGS_NO_AUTO_START = (1<<1)
1222 } GDBusMessageFlags;
1223
1224 /**
1225  * GDBusMessageHeaderField:
1226  * @G_DBUS_MESSAGE_HEADER_FIELD_INVALID: Not a valid header field.
1227  * @G_DBUS_MESSAGE_HEADER_FIELD_PATH: The object path.
1228  * @G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE: The interface name.
1229  * @G_DBUS_MESSAGE_HEADER_FIELD_MEMBER: The method or signal name.
1230  * @G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME: The name of the error that occurred.
1231  * @G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL: The serial number the message is a reply to.
1232  * @G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION: The name the message is intended for.
1233  * @G_DBUS_MESSAGE_HEADER_FIELD_SENDER: Unique name of the sender of the message (filled in by the bus).
1234  * @G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE: The signature of the message body.
1235  * @G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS: The number of UNIX file descriptors that accompany the message.
1236  *
1237  * Header fields used in #GDBusMessage.
1238  *
1239  * Since: 2.26
1240  */
1241 typedef enum {
1242   G_DBUS_MESSAGE_HEADER_FIELD_INVALID,
1243   G_DBUS_MESSAGE_HEADER_FIELD_PATH,
1244   G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE,
1245   G_DBUS_MESSAGE_HEADER_FIELD_MEMBER,
1246   G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME,
1247   G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL,
1248   G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
1249   G_DBUS_MESSAGE_HEADER_FIELD_SENDER,
1250   G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE,
1251   G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS
1252 } GDBusMessageHeaderField;
1253
1254 /**
1255  * GDBusPropertyInfoFlags:
1256  * @G_DBUS_PROPERTY_INFO_FLAGS_NONE: No flags set.
1257  * @G_DBUS_PROPERTY_INFO_FLAGS_READABLE: Property is readable.
1258  * @G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE: Property is writable.
1259  *
1260  * Flags describing the access control of a D-Bus property.
1261  *
1262  * Since: 2.26
1263  */
1264 typedef enum
1265 {
1266   G_DBUS_PROPERTY_INFO_FLAGS_NONE = 0,
1267   G_DBUS_PROPERTY_INFO_FLAGS_READABLE = (1<<0),
1268   G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE = (1<<1)
1269 } GDBusPropertyInfoFlags;
1270
1271 /**
1272  * GDBusSubtreeFlags:
1273  * @G_DBUS_SUBTREE_FLAGS_NONE: No flags set.
1274  * @G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES: Method calls to objects not in the enumerated range
1275  *                                                       will still be dispatched. This is useful if you want
1276  *                                                       to dynamically spawn objects in the subtree.
1277  *
1278  * Flags passed to g_dbus_connection_register_subtree().
1279  *
1280  * Since: 2.26
1281  */
1282 typedef enum
1283 {
1284   G_DBUS_SUBTREE_FLAGS_NONE = 0,
1285   G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES = (1<<0)
1286 } GDBusSubtreeFlags;
1287
1288 /**
1289  * GDBusServerFlags:
1290  * @G_DBUS_SERVER_FLAGS_NONE: No flags set.
1291  * @G_DBUS_SERVER_FLAGS_RUN_IN_THREAD: All #GDBusServer::new-connection
1292  * signals will run in separated dedicated threads (see signal for
1293  * details).
1294  * @G_DBUS_SERVER_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS: Allow the anonymous
1295  * authentication method.
1296  *
1297  * Flags used when creating a #GDBusServer.
1298  *
1299  * Since: 2.26
1300  */
1301 typedef enum
1302 {
1303   G_DBUS_SERVER_FLAGS_NONE = 0,
1304   G_DBUS_SERVER_FLAGS_RUN_IN_THREAD = (1<<0),
1305   G_DBUS_SERVER_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS = (1<<1)
1306 } GDBusServerFlags;
1307
1308 /**
1309  * GDBusSignalFlags:
1310  * @G_DBUS_SIGNAL_FLAGS_NONE: No flags set.
1311  * @G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE: Don't actually send the AddMatch
1312  * D-Bus call for this signal subscription.  This gives you more control
1313  * over which match rules you add (but you must add them manually).
1314  * @G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE: Match first arguments that
1315  * contain a bus or interface name with the given namespace.
1316  * @G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH: Match first arguments that
1317  * contain an object path that is either equivalent to the given path,
1318  * or one of the paths is a subpath of the other.
1319  *
1320  * Flags used when subscribing to signals via g_dbus_connection_signal_subscribe().
1321  *
1322  * Since: 2.26
1323  */
1324 typedef enum /*< flags >*/
1325 {
1326   G_DBUS_SIGNAL_FLAGS_NONE = 0,
1327   G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE = (1<<0),
1328   G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE = (1<<1),
1329   G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH = (1<<2)
1330 } GDBusSignalFlags;
1331
1332 /**
1333  * GDBusSendMessageFlags:
1334  * @G_DBUS_SEND_MESSAGE_FLAGS_NONE: No flags set.
1335  * @G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL: Do not automatically
1336  * assign a serial number from the #GDBusConnection object when
1337  * sending a message.
1338  *
1339  * Flags used when sending #GDBusMessage<!-- -->s on a #GDBusConnection.
1340  *
1341  * Since: 2.26
1342  */
1343 typedef enum
1344 {
1345   G_DBUS_SEND_MESSAGE_FLAGS_NONE = 0,
1346   G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL = (1<<0)
1347 } GDBusSendMessageFlags;
1348 /* (1<<31) is reserved for internal use by GDBusConnection, do not use it. */
1349
1350 /**
1351  * GCredentialsType:
1352  * @G_CREDENTIALS_TYPE_INVALID: Indicates an invalid native credential type.
1353  * @G_CREDENTIALS_TYPE_LINUX_UCRED: The native credentials type is a <type>struct ucred</type>.
1354  * @G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED: The native credentials type is a <type>struct cmsgcred</type>.
1355  * @G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED: The native credentials type is a <type>struct sockpeercred</type>. Added in 2.30.
1356  * @G_CREDENTIALS_TYPE_SOLARIS_UCRED: The native credentials type is a <type>ucred_t</type>. Added in 2.40.
1357  *
1358  * Enumeration describing different kinds of native credential types.
1359  *
1360  * Since: 2.26
1361  */
1362 typedef enum
1363 {
1364   G_CREDENTIALS_TYPE_INVALID,
1365   G_CREDENTIALS_TYPE_LINUX_UCRED,
1366   G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED,
1367   G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED,
1368   G_CREDENTIALS_TYPE_SOLARIS_UCRED
1369 } GCredentialsType;
1370
1371 /**
1372  * GDBusMessageByteOrder:
1373  * @G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN: The byte order is big endian.
1374  * @G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN: The byte order is little endian.
1375  *
1376  * Enumeration used to describe the byte order of a D-Bus message.
1377  *
1378  * Since: 2.26
1379  */
1380 typedef enum
1381 {
1382   G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN    = 'B',
1383   G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN = 'l'
1384 } GDBusMessageByteOrder;
1385
1386 /**
1387  * GApplicationFlags:
1388  * @G_APPLICATION_FLAGS_NONE: Default
1389  * @G_APPLICATION_IS_SERVICE: Run as a service. In this mode, registration
1390  *      fails if the service is already running, and the application
1391  *      will initially wait up to 10 seconds for an initial activation
1392  *      message to arrive.
1393  * @G_APPLICATION_IS_LAUNCHER: Don't try to become the primary instance.
1394  * @G_APPLICATION_HANDLES_OPEN: This application handles opening files (in
1395  *     the primary instance). Note that this flag only affects the default
1396  *     implementation of local_command_line(), and has no effect if
1397  *     %G_APPLICATION_HANDLES_COMMAND_LINE is given.
1398  *     See g_application_run() for details.
1399  * @G_APPLICATION_HANDLES_COMMAND_LINE: This application handles command line
1400  *     arguments (in the primary instance). Note that this flag only affect
1401  *     the default implementation of local_command_line().
1402  *     See g_application_run() for details.
1403  * @G_APPLICATION_SEND_ENVIRONMENT: Send the environment of the
1404  *     launching process to the primary instance. Set this flag if your
1405  *     application is expected to behave differently depending on certain
1406  *     environment variables. For instance, an editor might be expected
1407  *     to use the <envar>GIT_COMMITTER_NAME</envar> environment variable
1408  *     when editing a git commit message. The environment is available
1409  *     to the #GApplication::command-line signal handler, via
1410  *     g_application_command_line_getenv().
1411  * @G_APPLICATION_NON_UNIQUE: Make no attempts to do any of the typical
1412  *     single-instance application negotiation, even if the application
1413  *     ID is given.  The application neither attempts to become the
1414  *     owner of the application ID nor does it check if an existing
1415  *     owner already exists.  Everything occurs in the local process.
1416  *     Since: 2.30.
1417  *
1418  * Flags used to define the behaviour of a #GApplication.
1419  *
1420  * Since: 2.28
1421  **/
1422 typedef enum
1423 {
1424   G_APPLICATION_FLAGS_NONE,
1425   G_APPLICATION_IS_SERVICE  =          (1 << 0),
1426   G_APPLICATION_IS_LAUNCHER =          (1 << 1),
1427
1428   G_APPLICATION_HANDLES_OPEN =         (1 << 2),
1429   G_APPLICATION_HANDLES_COMMAND_LINE = (1 << 3),
1430   G_APPLICATION_SEND_ENVIRONMENT    =  (1 << 4),
1431
1432   G_APPLICATION_NON_UNIQUE =           (1 << 5)
1433 } GApplicationFlags;
1434
1435 /**
1436  * GTlsError:
1437  * @G_TLS_ERROR_UNAVAILABLE: No TLS provider is available
1438  * @G_TLS_ERROR_MISC: Miscellaneous TLS error
1439  * @G_TLS_ERROR_BAD_CERTIFICATE: A certificate could not be parsed
1440  * @G_TLS_ERROR_NOT_TLS: The TLS handshake failed because the
1441  *   peer does not seem to be a TLS server.
1442  * @G_TLS_ERROR_HANDSHAKE: The TLS handshake failed because the
1443  *   peer's certificate was not acceptable.
1444  * @G_TLS_ERROR_CERTIFICATE_REQUIRED: The TLS handshake failed because
1445  *   the server requested a client-side certificate, but none was
1446  *   provided. See g_tls_connection_set_certificate().
1447  * @G_TLS_ERROR_EOF: The TLS connection was closed without proper
1448  *   notice, which may indicate an attack. See
1449  *   g_tls_connection_set_require_close_notify().
1450  *
1451  * An error code used with %G_TLS_ERROR in a #GError returned from a
1452  * TLS-related routine.
1453  *
1454  * Since: 2.28
1455  */
1456 typedef enum {
1457   G_TLS_ERROR_UNAVAILABLE,
1458   G_TLS_ERROR_MISC,
1459   G_TLS_ERROR_BAD_CERTIFICATE,
1460   G_TLS_ERROR_NOT_TLS,
1461   G_TLS_ERROR_HANDSHAKE,
1462   G_TLS_ERROR_CERTIFICATE_REQUIRED,
1463   G_TLS_ERROR_EOF
1464 } GTlsError;
1465
1466 /**
1467  * GTlsCertificateFlags:
1468  * @G_TLS_CERTIFICATE_UNKNOWN_CA: The signing certificate authority is
1469  *   not known.
1470  * @G_TLS_CERTIFICATE_BAD_IDENTITY: The certificate does not match the
1471  *   expected identity of the site that it was retrieved from.
1472  * @G_TLS_CERTIFICATE_NOT_ACTIVATED: The certificate's activation time
1473  *   is still in the future
1474  * @G_TLS_CERTIFICATE_EXPIRED: The certificate has expired
1475  * @G_TLS_CERTIFICATE_REVOKED: The certificate has been revoked
1476  *   according to the #GTlsConnection's certificate revocation list.
1477  * @G_TLS_CERTIFICATE_INSECURE: The certificate's algorithm is
1478  *   considered insecure.
1479  * @G_TLS_CERTIFICATE_GENERIC_ERROR: Some other error occurred validating
1480  *   the certificate
1481  * @G_TLS_CERTIFICATE_VALIDATE_ALL: the combination of all of the above
1482  *   flags
1483  *
1484  * A set of flags describing TLS certification validation. This can be
1485  * used to set which validation steps to perform (eg, with
1486  * g_tls_client_connection_set_validation_flags()), or to describe why
1487  * a particular certificate was rejected (eg, in
1488  * #GTlsConnection::accept-certificate).
1489  *
1490  * Since: 2.28
1491  */
1492 typedef enum {
1493   G_TLS_CERTIFICATE_UNKNOWN_CA    = (1 << 0),
1494   G_TLS_CERTIFICATE_BAD_IDENTITY  = (1 << 1),
1495   G_TLS_CERTIFICATE_NOT_ACTIVATED = (1 << 2),
1496   G_TLS_CERTIFICATE_EXPIRED       = (1 << 3),
1497   G_TLS_CERTIFICATE_REVOKED       = (1 << 4),
1498   G_TLS_CERTIFICATE_INSECURE      = (1 << 5),
1499   G_TLS_CERTIFICATE_GENERIC_ERROR = (1 << 6),
1500
1501   G_TLS_CERTIFICATE_VALIDATE_ALL  = 0x007f
1502 } GTlsCertificateFlags;
1503
1504 /**
1505  * GTlsAuthenticationMode:
1506  * @G_TLS_AUTHENTICATION_NONE: client authentication not required
1507  * @G_TLS_AUTHENTICATION_REQUESTED: client authentication is requested
1508  * @G_TLS_AUTHENTICATION_REQUIRED: client authentication is required
1509  *
1510  * The client authentication mode for a #GTlsServerConnection.
1511  *
1512  * Since: 2.28
1513  */
1514 typedef enum {
1515   G_TLS_AUTHENTICATION_NONE,
1516   G_TLS_AUTHENTICATION_REQUESTED,
1517   G_TLS_AUTHENTICATION_REQUIRED
1518 } GTlsAuthenticationMode;
1519
1520 /**
1521  * GTlsRehandshakeMode:
1522  * @G_TLS_REHANDSHAKE_NEVER: Never allow rehandshaking
1523  * @G_TLS_REHANDSHAKE_SAFELY: Allow safe rehandshaking only
1524  * @G_TLS_REHANDSHAKE_UNSAFELY: Allow unsafe rehandshaking
1525  *
1526  * When to allow rehandshaking. See
1527  * g_tls_connection_set_rehandshake_mode().
1528  *
1529  * Since: 2.28
1530  */
1531 typedef enum {
1532   G_TLS_REHANDSHAKE_NEVER,
1533   G_TLS_REHANDSHAKE_SAFELY,
1534   G_TLS_REHANDSHAKE_UNSAFELY
1535 } GTlsRehandshakeMode;
1536
1537 /**
1538  * GTlsPasswordFlags:
1539  * @G_TLS_PASSWORD_NONE: No flags
1540  * @G_TLS_PASSWORD_RETRY: The password was wrong, and the user should retry.
1541  * @G_TLS_PASSWORD_MANY_TRIES: Hint to the user that the password has been
1542  *    wrong many times, and the user may not have many chances left.
1543  * @G_TLS_PASSWORD_FINAL_TRY: Hint to the user that this is the last try to get
1544  *    this password right.
1545  *
1546  * Various flags for the password.
1547  *
1548  * Since: 2.30
1549  */
1550
1551 typedef enum _GTlsPasswordFlags
1552 {
1553   G_TLS_PASSWORD_NONE = 0,
1554   G_TLS_PASSWORD_RETRY = 1 << 1,
1555   G_TLS_PASSWORD_MANY_TRIES = 1 << 2,
1556   G_TLS_PASSWORD_FINAL_TRY = 1 << 3
1557 } GTlsPasswordFlags;
1558
1559 /**
1560  * GTlsInteractionResult:
1561  * @G_TLS_INTERACTION_UNHANDLED: The interaction was unhandled (i.e. not
1562  *     implemented).
1563  * @G_TLS_INTERACTION_HANDLED: The interaction completed, and resulting data
1564  *     is available.
1565  * @G_TLS_INTERACTION_FAILED: The interaction has failed, or was cancelled.
1566  *     and the operation should be aborted.
1567  *
1568  * #GTlsInteractionResult is returned by various functions in #GTlsInteraction
1569  * when finishing an interaction request.
1570  *
1571  * Since: 2.30
1572  */
1573 typedef enum {
1574   G_TLS_INTERACTION_UNHANDLED,
1575   G_TLS_INTERACTION_HANDLED,
1576   G_TLS_INTERACTION_FAILED
1577 } GTlsInteractionResult;
1578
1579 /**
1580  * GDBusInterfaceSkeletonFlags:
1581  * @G_DBUS_INTERFACE_SKELETON_FLAGS_NONE: No flags set.
1582  * @G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD: Each method invocation is handled in
1583  *   a thread dedicated to the invocation. This means that the method implementation can use blocking IO
1584  *   without blocking any other part of the process. It also means that the method implementation must
1585  *   use locking to access data structures used by other threads.
1586  *
1587  * Flags describing the behavior of a #GDBusInterfaceSkeleton instance.
1588  *
1589  * Since: 2.30
1590  */
1591 typedef enum
1592 {
1593   G_DBUS_INTERFACE_SKELETON_FLAGS_NONE = 0,
1594   G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD = (1<<0)
1595 } GDBusInterfaceSkeletonFlags;
1596
1597 /**
1598  * GDBusObjectManagerClientFlags:
1599  * @G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_NONE: No flags set.
1600  * @G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START: If not set and the
1601  *   manager is for a well-known name, then request the bus to launch
1602  *   an owner for the name if no-one owns the name. This flag can only
1603  *   be used in managers for well-known names.
1604  *
1605  * Flags used when constructing a #GDBusObjectManagerClient.
1606  *
1607  * Since: 2.30
1608  */
1609 typedef enum
1610 {
1611   G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_NONE = 0,
1612   G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START = (1<<0)
1613 } GDBusObjectManagerClientFlags;
1614
1615 /**
1616  * GTlsDatabaseVerifyFlags:
1617  * @G_TLS_DATABASE_VERIFY_NONE: No verification flags
1618  *
1619  * Flags for g_tls_database_verify_chain().
1620  *
1621  * Since: 2.30
1622  */
1623 typedef enum /*< flags >*/ {
1624   G_TLS_DATABASE_VERIFY_NONE = 0
1625 } GTlsDatabaseVerifyFlags;
1626
1627 /**
1628  * GTlsDatabaseLookupFlags:
1629  * @G_TLS_DATABASE_LOOKUP_NONE: No lookup flags
1630  * @G_TLS_DATABASE_LOOKUP_KEYPAIR: Restrict lookup to certificates that have
1631  *     a private key.
1632  *
1633  * Flags for g_tls_database_lookup_certificate_handle(),
1634  * g_tls_database_lookup_certificate_issuer(),
1635  * and g_tls_database_lookup_certificates_issued_by().
1636  *
1637  * Since: 2.30
1638  */
1639 typedef enum {
1640   G_TLS_DATABASE_LOOKUP_NONE = 0,
1641   G_TLS_DATABASE_LOOKUP_KEYPAIR = 1
1642 } GTlsDatabaseLookupFlags;
1643
1644 /**
1645  * GTlsCertificateRequestFlags:
1646  * @G_TLS_CERTIFICATE_REQUEST_NONE: No flags
1647  *
1648  * Flags for g_tls_interaction_request_certificate(),
1649  * g_tls_interaction_request_certificate_async(), and
1650  * g_tls_interaction_invoke_request_certificate().
1651  *
1652  * Since: 2.40
1653  */
1654 typedef enum {
1655   G_TLS_CERTIFICATE_REQUEST_NONE = 0
1656 } GTlsCertificateRequestFlags;
1657
1658 /**
1659  * GIOModuleScopeFlags:
1660  * @G_IO_MODULE_SCOPE_NONE: No module scan flags
1661  * @G_IO_MODULE_SCOPE_BLOCK_DUPLICATES: When using this scope to load or
1662  *     scan modules, automatically block a modules which has the same base
1663  *     basename as previously loaded module.
1664  *
1665  * Flags for use with g_io_module_scope_new().
1666  *
1667  * Since: 2.30
1668  */
1669 typedef enum {
1670   G_IO_MODULE_SCOPE_NONE,
1671   G_IO_MODULE_SCOPE_BLOCK_DUPLICATES
1672 } GIOModuleScopeFlags;
1673
1674 /**
1675  * GSocketClientEvent:
1676  * @G_SOCKET_CLIENT_RESOLVING: The client is doing a DNS lookup.
1677  * @G_SOCKET_CLIENT_RESOLVED: The client has completed a DNS lookup.
1678  * @G_SOCKET_CLIENT_CONNECTING: The client is connecting to a remote
1679  *   host (either a proxy or the destination server).
1680  * @G_SOCKET_CLIENT_CONNECTED: The client has connected to a remote
1681  *   host.
1682  * @G_SOCKET_CLIENT_PROXY_NEGOTIATING: The client is negotiating
1683  *   with a proxy to connect to the destination server.
1684  * @G_SOCKET_CLIENT_PROXY_NEGOTIATED: The client has negotiated
1685  *   with the proxy server.
1686  * @G_SOCKET_CLIENT_TLS_HANDSHAKING: The client is performing a
1687  *   TLS handshake.
1688  * @G_SOCKET_CLIENT_TLS_HANDSHAKED: The client has performed a
1689  *   TLS handshake.
1690  * @G_SOCKET_CLIENT_COMPLETE: The client is done with a particular
1691  *   #GSocketConnectable.
1692  *
1693  * Describes an event occurring on a #GSocketClient. See the
1694  * #GSocketClient::event signal for more details.
1695  *
1696  * Additional values may be added to this type in the future.
1697  *
1698  * Since: 2.32
1699  */
1700 typedef enum {
1701   G_SOCKET_CLIENT_RESOLVING,
1702   G_SOCKET_CLIENT_RESOLVED,
1703   G_SOCKET_CLIENT_CONNECTING,
1704   G_SOCKET_CLIENT_CONNECTED,
1705   G_SOCKET_CLIENT_PROXY_NEGOTIATING,
1706   G_SOCKET_CLIENT_PROXY_NEGOTIATED,
1707   G_SOCKET_CLIENT_TLS_HANDSHAKING,
1708   G_SOCKET_CLIENT_TLS_HANDSHAKED,
1709   G_SOCKET_CLIENT_COMPLETE
1710 } GSocketClientEvent;
1711
1712 /**
1713  * GTestDBusFlags:
1714  * @G_TEST_DBUS_NONE: No flags.
1715  *
1716  * Flags to define future #GTestDBus behaviour.
1717  *
1718  * Since: 2.34
1719  */
1720 typedef enum /*< flags >*/ {
1721   G_TEST_DBUS_NONE = 0
1722 } GTestDBusFlags;
1723
1724 /**
1725  * GSubprocessFlags:
1726  * @G_SUBPROCESS_FLAGS_NONE: No flags.
1727  * @G_SUBPROCESS_FLAGS_STDIN_PIPE: create a pipe for the stdin of the
1728  *   spawned process that can be accessed with
1729  *   g_subprocess_get_stdin_pipe().
1730  * @G_SUBPROCESS_FLAGS_STDIN_INHERIT: stdin is inherited from the
1731  *   calling process.
1732  * @G_SUBPROCESS_FLAGS_STDOUT_PIPE: create a pipe for the stdout of the
1733  *   spawned process that can be accessed with
1734  *   g_subprocess_get_stdout_pipe().
1735  * @G_SUBPROCESS_FLAGS_STDOUT_SILENCE: silence the stdout of the spawned
1736  *   process (ie: redirect to /dev/null).
1737  * @G_SUBPROCESS_FLAGS_STDERR_PIPE: create a pipe for the stderr of the
1738  *   spawned process that can be accessed with
1739  *   g_subprocess_get_stderr_pipe().
1740  * @G_SUBPROCESS_FLAGS_STDERR_SILENCE: silence the stderr of the spawned
1741  *   process (ie: redirect to /dev/null).
1742  * @G_SUBPROCESS_FLAGS_STDERR_MERGE: merge the stderr of the spawned
1743  *   process with whatever the stdout happens to be.  This is a good way
1744  *   of directing both streams to a common log file, for example.
1745  * @G_SUBPROCESS_FLAGS_INHERIT_FDS: spawned processes will inherit the
1746  *   file descriptors of their parent, unless those descriptors have
1747  *   been explicitly marked as close-on-exec.  This flag has no effect
1748  *   over the "standard" file descriptors (stdin, stdout, stderr).
1749  *
1750  * Flags to define the behaviour of a #GSubprocess.
1751  *
1752  * Note that the default for stdin is to redirect from /dev/null.  For
1753  * stdout and stderr the default are for them to inherit the
1754  * corresponding descriptor from the calling process.
1755  *
1756  * Note that it is a programmer error to mix 'incompatible' flags.  For
1757  * example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and
1758  * %G_SUBPROCESS_FLAGS_STDOUT_SILENCE.
1759  *
1760  * Since: 2.40
1761  **/
1762 typedef enum {
1763   G_SUBPROCESS_FLAGS_NONE                  = 0,
1764   G_SUBPROCESS_FLAGS_STDIN_PIPE            = (1u << 0),
1765   G_SUBPROCESS_FLAGS_STDIN_INHERIT         = (1u << 1),
1766   G_SUBPROCESS_FLAGS_STDOUT_PIPE           = (1u << 2),
1767   G_SUBPROCESS_FLAGS_STDOUT_SILENCE        = (1u << 3),
1768   G_SUBPROCESS_FLAGS_STDERR_PIPE           = (1u << 4),
1769   G_SUBPROCESS_FLAGS_STDERR_SILENCE        = (1u << 5),
1770   G_SUBPROCESS_FLAGS_STDERR_MERGE          = (1u << 6),
1771   G_SUBPROCESS_FLAGS_INHERIT_FDS           = (1u << 7)
1772 } GSubprocessFlags;
1773
1774 G_END_DECLS
1775
1776 #endif /* __GIO_ENUMS_H__ */