2.54.2
[glib.git] / gio / giotypes.h
blob67c9cc7b7fed7ca69405f207b2a03da982766f4e
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.1 of the License, or (at your option) any later version.
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.
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/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
21 #ifndef __GIO_TYPES_H__
22 #define __GIO_TYPES_H__
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
28 #include <gio/gioenums.h>
30 G_BEGIN_DECLS
32 typedef struct _GAppLaunchContext GAppLaunchContext;
33 typedef struct _GAppInfo GAppInfo; /* Dummy typedef */
34 typedef struct _GAsyncResult GAsyncResult; /* Dummy typedef */
35 typedef struct _GAsyncInitable GAsyncInitable;
36 typedef struct _GBufferedInputStream GBufferedInputStream;
37 typedef struct _GBufferedOutputStream GBufferedOutputStream;
38 typedef struct _GCancellable GCancellable;
39 typedef struct _GCharsetConverter GCharsetConverter;
40 typedef struct _GConverter GConverter;
41 typedef struct _GConverterInputStream GConverterInputStream;
42 typedef struct _GConverterOutputStream GConverterOutputStream;
43 typedef struct _GDatagramBased GDatagramBased;
44 typedef struct _GDataInputStream GDataInputStream;
45 typedef struct _GSimplePermission GSimplePermission;
46 typedef struct _GZlibCompressor GZlibCompressor;
47 typedef struct _GZlibDecompressor GZlibDecompressor;
49 typedef struct _GSimpleActionGroup GSimpleActionGroup;
50 typedef struct _GRemoteActionGroup GRemoteActionGroup;
51 typedef struct _GDBusActionGroup GDBusActionGroup;
52 typedef struct _GActionMap GActionMap;
53 typedef struct _GActionGroup GActionGroup;
54 typedef struct _GPropertyAction GPropertyAction;
55 typedef struct _GSimpleAction GSimpleAction;
56 typedef struct _GAction GAction;
57 typedef struct _GApplication GApplication;
58 typedef struct _GApplicationCommandLine GApplicationCommandLine;
59 typedef struct _GSettingsBackend GSettingsBackend;
60 typedef struct _GSettings GSettings;
61 typedef struct _GPermission GPermission;
63 typedef struct _GMenuModel GMenuModel;
64 typedef struct _GNotification GNotification;
66 /**
67 * GDrive:
69 * Opaque drive object.
70 **/
71 typedef struct _GDrive GDrive; /* Dummy typedef */
72 typedef struct _GFileEnumerator GFileEnumerator;
73 typedef struct _GFileMonitor GFileMonitor;
74 typedef struct _GFilterInputStream GFilterInputStream;
75 typedef struct _GFilterOutputStream GFilterOutputStream;
77 /**
78 * GFile:
80 * A handle to an object implementing the #GFileIface interface.
81 * Generally stores a location within the file system. Handles do not
82 * necessarily represent files or directories that currently exist.
83 **/
84 typedef struct _GFile GFile; /* Dummy typedef */
85 typedef struct _GFileInfo GFileInfo;
87 /**
88 * GFileAttributeMatcher:
90 * Determines if a string matches a file attribute.
91 **/
92 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
93 typedef struct _GFileAttributeInfo GFileAttributeInfo;
94 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
95 typedef struct _GFileDescriptorBased GFileDescriptorBased;
96 typedef struct _GFileInputStream GFileInputStream;
97 typedef struct _GFileOutputStream GFileOutputStream;
98 typedef struct _GFileIOStream GFileIOStream;
99 typedef struct _GFileIcon GFileIcon;
100 typedef struct _GFilenameCompleter GFilenameCompleter;
103 typedef struct _GIcon GIcon; /* Dummy typedef */
104 typedef struct _GInetAddress GInetAddress;
105 typedef struct _GInetAddressMask GInetAddressMask;
106 typedef struct _GInetSocketAddress GInetSocketAddress;
107 typedef struct _GNativeSocketAddress GNativeSocketAddress;
108 typedef struct _GInputStream GInputStream;
109 typedef struct _GInitable GInitable;
110 typedef struct _GIOModule GIOModule;
111 typedef struct _GIOExtensionPoint GIOExtensionPoint;
112 typedef struct _GIOExtension GIOExtension;
115 * GIOSchedulerJob:
117 * Opaque class for defining and scheduling IO jobs.
119 typedef struct _GIOSchedulerJob GIOSchedulerJob;
120 typedef struct _GIOStreamAdapter GIOStreamAdapter;
121 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
122 typedef struct _GBytesIcon GBytesIcon;
123 typedef struct _GMemoryInputStream GMemoryInputStream;
124 typedef struct _GMemoryOutputStream GMemoryOutputStream;
127 * GMount:
129 * A handle to an object implementing the #GMountIface interface.
131 typedef struct _GMount GMount; /* Dummy typedef */
132 typedef struct _GMountOperation GMountOperation;
133 typedef struct _GNetworkAddress GNetworkAddress;
134 typedef struct _GNetworkMonitor GNetworkMonitor;
135 typedef struct _GNetworkService GNetworkService;
136 typedef struct _GOutputStream GOutputStream;
137 typedef struct _GIOStream GIOStream;
138 typedef struct _GSimpleIOStream GSimpleIOStream;
139 typedef struct _GPollableInputStream GPollableInputStream; /* Dummy typedef */
140 typedef struct _GPollableOutputStream GPollableOutputStream; /* Dummy typedef */
141 typedef struct _GResolver GResolver;
144 * GResource:
146 * A resource bundle.
148 * Since: 2.32
150 typedef struct _GResource GResource;
151 typedef struct _GSeekable GSeekable;
152 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
155 * GSocket:
157 * A lowlevel network socket object.
159 * Since: 2.22
161 typedef struct _GSocket GSocket;
164 * GSocketControlMessage:
166 * Base class for socket-type specific control messages that can be sent and
167 * received over #GSocket.
169 typedef struct _GSocketControlMessage GSocketControlMessage;
171 * GSocketClient:
173 * A helper class for network clients to make connections.
175 * Since: 2.22
177 typedef struct _GSocketClient GSocketClient;
179 * GSocketConnection:
181 * A socket connection GIOStream object for connection-oriented sockets.
183 * Since: 2.22
185 typedef struct _GSocketConnection GSocketConnection;
187 * GSocketListener:
189 * A helper class for network servers to listen for and accept connections.
191 * Since: 2.22
193 typedef struct _GSocketListener GSocketListener;
195 * GSocketService:
197 * A helper class for handling accepting incomming connections in the
198 * glib mainloop.
200 * Since: 2.22
202 typedef struct _GSocketService GSocketService;
203 typedef struct _GSocketAddress GSocketAddress;
204 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
205 typedef struct _GSocketConnectable GSocketConnectable;
206 typedef struct _GSrvTarget GSrvTarget;
207 typedef struct _GTask GTask;
209 * GTcpConnection:
211 * A #GSocketConnection for TCP/IP connections.
213 * Since: 2.22
215 typedef struct _GTcpConnection GTcpConnection;
216 typedef struct _GTcpWrapperConnection GTcpWrapperConnection;
218 * GThreadedSocketService:
220 * A helper class for handling accepting incoming connections in the
221 * glib mainloop and handling them in a thread.
223 * Since: 2.22
225 typedef struct _GThreadedSocketService GThreadedSocketService;
226 typedef struct _GDtlsConnection GDtlsConnection;
227 typedef struct _GDtlsClientConnection GDtlsClientConnection; /* Dummy typedef */
228 typedef struct _GDtlsServerConnection GDtlsServerConnection; /* Dummy typedef */
229 typedef struct _GThemedIcon GThemedIcon;
230 typedef struct _GTlsCertificate GTlsCertificate;
231 typedef struct _GTlsClientConnection GTlsClientConnection; /* Dummy typedef */
232 typedef struct _GTlsConnection GTlsConnection;
233 typedef struct _GTlsDatabase GTlsDatabase;
234 typedef struct _GTlsFileDatabase GTlsFileDatabase;
235 typedef struct _GTlsInteraction GTlsInteraction;
236 typedef struct _GTlsPassword GTlsPassword;
237 typedef struct _GTlsServerConnection GTlsServerConnection; /* Dummy typedef */
238 typedef struct _GVfs GVfs; /* Dummy typedef */
241 * GProxyResolver:
243 * A helper class to enumerate proxies base on URI.
245 * Since: 2.26
247 typedef struct _GProxyResolver GProxyResolver;
248 typedef struct _GProxy GProxy;
249 typedef struct _GProxyAddress GProxyAddress;
250 typedef struct _GProxyAddressEnumerator GProxyAddressEnumerator;
253 * GVolume:
255 * Opaque mountable volume object.
257 typedef struct _GVolume GVolume; /* Dummy typedef */
258 typedef struct _GVolumeMonitor GVolumeMonitor;
261 * GAsyncReadyCallback:
262 * @source_object: the object the asynchronous operation was started with.
263 * @res: a #GAsyncResult.
264 * @user_data: user data passed to the callback.
266 * Type definition for a function that will be called back when an asynchronous
267 * operation within GIO has been completed.
269 typedef void (*GAsyncReadyCallback) (GObject *source_object,
270 GAsyncResult *res,
271 gpointer user_data);
274 * GFileProgressCallback:
275 * @current_num_bytes: the current number of bytes in the operation.
276 * @total_num_bytes: the total number of bytes in the operation.
277 * @user_data: user data passed to the callback.
279 * When doing file operations that may take a while, such as moving
280 * a file or copying a file, a progress callback is used to pass how
281 * far along that operation is to the application.
283 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
284 goffset total_num_bytes,
285 gpointer user_data);
288 * GFileReadMoreCallback:
289 * @file_contents: the data as currently read.
290 * @file_size: the size of the data currently read.
291 * @callback_data: data passed to the callback.
293 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
294 * it may become necessary to determine if any more data from the file should be loaded.
295 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
296 * should be read, or %FALSE otherwise.
298 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
300 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
301 goffset file_size,
302 gpointer callback_data);
305 * GFileMeasureProgressCallback:
306 * @reporting: %TRUE if more reports will come
307 * @current_size: the current cumulative size measurement
308 * @num_dirs: the number of directories visited so far
309 * @num_files: the number of non-directory files encountered
310 * @user_data: the data passed to the original request for this callback
312 * This callback type is used by g_file_measure_disk_usage() to make
313 * periodic progress reports when measuring the amount of disk spaced
314 * used by a directory.
316 * These calls are made on a best-effort basis and not all types of
317 * #GFile will support them. At the minimum, however, one call will
318 * always be made immediately.
320 * In the case that there is no support, @reporting will be set to
321 * %FALSE (and the other values undefined) and no further calls will be
322 * made. Otherwise, the @reporting will be %TRUE and the other values
323 * all-zeros during the first (immediate) call. In this way, you can
324 * know which type of progress UI to show without a delay.
326 * For g_file_measure_disk_usage() the callback is made directly. For
327 * g_file_measure_disk_usage_async() the callback is made via the
328 * default main context of the calling thread (ie: the same way that the
329 * final async result would be reported).
331 * @current_size is in the same units as requested by the operation (see
332 * %G_FILE_DISK_USAGE_APPARENT_SIZE).
334 * The frequency of the updates is implementation defined, but is
335 * ideally about once every 200ms.
337 * The last progress callback may or may not be equal to the final
338 * result. Always check the async result to get the final value.
340 * Since: 2.38
342 typedef void (* GFileMeasureProgressCallback) (gboolean reporting,
343 guint64 current_size,
344 guint64 num_dirs,
345 guint64 num_files,
346 gpointer user_data);
349 * GIOSchedulerJobFunc:
350 * @job: a #GIOSchedulerJob.
351 * @cancellable: optional #GCancellable object, %NULL to ignore.
352 * @user_data: the data to pass to callback function
354 * I/O Job function.
356 * Long-running jobs should periodically check the @cancellable
357 * to see if they have been cancelled.
359 * Returns: %TRUE if this function should be called again to
360 * complete the job, %FALSE if the job is complete (or cancelled)
362 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
363 GCancellable *cancellable,
364 gpointer user_data);
367 * GSimpleAsyncThreadFunc:
368 * @res: a #GSimpleAsyncResult.
369 * @object: a #GObject.
370 * @cancellable: optional #GCancellable object, %NULL to ignore.
372 * Simple thread function that runs an asynchronous operation and
373 * checks for cancellation.
375 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
376 GObject *object,
377 GCancellable *cancellable);
380 * GSocketSourceFunc:
381 * @socket: the #GSocket
382 * @condition: the current condition at the source fired.
383 * @user_data: data passed in by the user.
385 * This is the function type of the callback used for the #GSource
386 * returned by g_socket_create_source().
388 * Returns: it should return %FALSE if the source should be removed.
390 * Since: 2.22
392 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
393 GIOCondition condition,
394 gpointer user_data);
397 * GDatagramBasedSourceFunc:
398 * @datagram_based: the #GDatagramBased
399 * @condition: the current condition at the source fired
400 * @user_data: data passed in by the user
402 * This is the function type of the callback used for the #GSource
403 * returned by g_datagram_based_create_source().
405 * Returns: %G_SOURCE_REMOVE if the source should be removed,
406 * %G_SOURCE_CONTINUE otherwise
408 * Since: 2.48
410 typedef gboolean (*GDatagramBasedSourceFunc) (GDatagramBased *datagram_based,
411 GIOCondition condition,
412 gpointer user_data);
415 * GInputVector:
416 * @buffer: Pointer to a buffer where data will be written.
417 * @size: the available size in @buffer.
419 * Structure used for scatter/gather data input.
420 * You generally pass in an array of #GInputVectors
421 * and the operation will store the read data starting in the
422 * first buffer, switching to the next as needed.
424 * Since: 2.22
426 typedef struct _GInputVector GInputVector;
428 struct _GInputVector {
429 gpointer buffer;
430 gsize size;
434 * GInputMessage:
435 * @address: (optional) (out) (transfer full): return location
436 * for a #GSocketAddress, or %NULL
437 * @vectors: (array length=num_vectors) (out): pointer to an
438 * array of input vectors
439 * @num_vectors: the number of input vectors pointed to by @vectors
440 * @bytes_received: (out): will be set to the number of bytes that have been
441 * received
442 * @flags: (out): collection of #GSocketMsgFlags for the received message,
443 * outputted by the call
444 * @control_messages: (array length=num_control_messages) (optional)
445 * (out) (transfer full): return location for a
446 * caller-allocated array of #GSocketControlMessages, or %NULL
447 * @num_control_messages: (out) (optional): return location for the number of
448 * elements in @control_messages
450 * Structure used for scatter/gather data input when receiving multiple
451 * messages or packets in one go. You generally pass in an array of empty
452 * #GInputVectors and the operation will use all the buffers as if they
453 * were one buffer, and will set @bytes_received to the total number of bytes
454 * received across all #GInputVectors.
456 * This structure closely mirrors `struct mmsghdr` and `struct msghdr` from
457 * the POSIX sockets API (see `man 2 recvmmsg`).
459 * If @address is non-%NULL then it is set to the source address the message
460 * was received from, and the caller must free it afterwards.
462 * If @control_messages is non-%NULL then it is set to an array of control
463 * messages received with the message (if any), and the caller must free it
464 * afterwards. @num_control_messages is set to the number of elements in
465 * this array, which may be zero.
467 * Flags relevant to this message will be returned in @flags. For example,
468 * `MSG_EOR` or `MSG_TRUNC`.
470 * Since: 2.48
472 typedef struct _GInputMessage GInputMessage;
474 struct _GInputMessage {
475 GSocketAddress **address;
477 GInputVector *vectors;
478 guint num_vectors;
480 gsize bytes_received;
481 gint flags;
483 GSocketControlMessage ***control_messages;
484 guint *num_control_messages;
488 * GOutputVector:
489 * @buffer: Pointer to a buffer of data to read.
490 * @size: the size of @buffer.
492 * Structure used for scatter/gather data output.
493 * You generally pass in an array of #GOutputVectors
494 * and the operation will use all the buffers as if they were
495 * one buffer.
497 * Since: 2.22
499 typedef struct _GOutputVector GOutputVector;
501 struct _GOutputVector {
502 gconstpointer buffer;
503 gsize size;
507 * GOutputMessage:
508 * @address: (nullable): a #GSocketAddress, or %NULL
509 * @vectors: pointer to an array of output vectors
510 * @num_vectors: the number of output vectors pointed to by @vectors.
511 * @bytes_sent: initialize to 0. Will be set to the number of bytes
512 * that have been sent
513 * @control_messages: (array length=num_control_messages) (nullable): a pointer
514 * to an array of #GSocketControlMessages, or %NULL.
515 * @num_control_messages: number of elements in @control_messages.
517 * Structure used for scatter/gather data output when sending multiple
518 * messages or packets in one go. You generally pass in an array of
519 * #GOutputVectors and the operation will use all the buffers as if they
520 * were one buffer.
522 * If @address is %NULL then the message is sent to the default receiver
523 * (as previously set by g_socket_connect()).
525 * Since: 2.44
527 typedef struct _GOutputMessage GOutputMessage;
529 struct _GOutputMessage {
530 GSocketAddress *address;
532 GOutputVector *vectors;
533 guint num_vectors;
535 guint bytes_sent;
537 GSocketControlMessage **control_messages;
538 guint num_control_messages;
541 typedef struct _GCredentials GCredentials;
542 typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage;
543 typedef struct _GUnixFDList GUnixFDList;
544 typedef struct _GDBusMessage GDBusMessage;
545 typedef struct _GDBusConnection GDBusConnection;
546 typedef struct _GDBusProxy GDBusProxy;
547 typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
548 typedef struct _GDBusServer GDBusServer;
549 typedef struct _GDBusAuthObserver GDBusAuthObserver;
550 typedef struct _GDBusErrorEntry GDBusErrorEntry;
551 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
552 typedef struct _GDBusSubtreeVTable GDBusSubtreeVTable;
553 typedef struct _GDBusAnnotationInfo GDBusAnnotationInfo;
554 typedef struct _GDBusArgInfo GDBusArgInfo;
555 typedef struct _GDBusMethodInfo GDBusMethodInfo;
556 typedef struct _GDBusSignalInfo GDBusSignalInfo;
557 typedef struct _GDBusPropertyInfo GDBusPropertyInfo;
558 typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo;
559 typedef struct _GDBusNodeInfo GDBusNodeInfo;
562 * GCancellableSourceFunc:
563 * @cancellable: the #GCancellable
564 * @user_data: data passed in by the user.
566 * This is the function type of the callback used for the #GSource
567 * returned by g_cancellable_source_new().
569 * Returns: it should return %FALSE if the source should be removed.
571 * Since: 2.28
573 typedef gboolean (*GCancellableSourceFunc) (GCancellable *cancellable,
574 gpointer user_data);
577 * GPollableSourceFunc:
578 * @pollable_stream: the #GPollableInputStream or #GPollableOutputStream
579 * @user_data: data passed in by the user.
581 * This is the function type of the callback used for the #GSource
582 * returned by g_pollable_input_stream_create_source() and
583 * g_pollable_output_stream_create_source().
585 * Returns: it should return %FALSE if the source should be removed.
587 * Since: 2.28
589 typedef gboolean (*GPollableSourceFunc) (GObject *pollable_stream,
590 gpointer user_data);
592 typedef struct _GDBusInterface GDBusInterface; /* Dummy typedef */
593 typedef struct _GDBusInterfaceSkeleton GDBusInterfaceSkeleton;
594 typedef struct _GDBusObject GDBusObject; /* Dummy typedef */
595 typedef struct _GDBusObjectSkeleton GDBusObjectSkeleton;
596 typedef struct _GDBusObjectProxy GDBusObjectProxy;
597 typedef struct _GDBusObjectManager GDBusObjectManager; /* Dummy typedef */
598 typedef struct _GDBusObjectManagerClient GDBusObjectManagerClient;
599 typedef struct _GDBusObjectManagerServer GDBusObjectManagerServer;
602 * GDBusProxyTypeFunc:
603 * @manager: A #GDBusObjectManagerClient.
604 * @object_path: The object path of the remote object.
605 * @interface_name: (nullable): The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested.
606 * @user_data: User data.
608 * Function signature for a function used to determine the #GType to
609 * use for an interface proxy (if @interface_name is not %NULL) or
610 * object proxy (if @interface_name is %NULL).
612 * This function is called in the
613 * [thread-default main loop][g-main-context-push-thread-default]
614 * that @manager was constructed in.
616 * Returns: A #GType to use for the remote object. The returned type
617 * must be a #GDBusProxy or #GDBusObjectProxy -derived
618 * type.
620 * Since: 2.30
622 typedef GType (*GDBusProxyTypeFunc) (GDBusObjectManagerClient *manager,
623 const gchar *object_path,
624 const gchar *interface_name,
625 gpointer user_data);
627 typedef struct _GTestDBus GTestDBus;
630 * GSubprocess:
632 * A child process.
634 * Since: 2.40
636 typedef struct _GSubprocess GSubprocess;
638 * GSubprocessLauncher:
640 * Options for launching a child process.
642 * Since: 2.40
644 typedef struct _GSubprocessLauncher GSubprocessLauncher;
646 G_END_DECLS
648 #endif /* __GIO_TYPES_H__ */