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 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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __GIO_TYPES_H__
28 #define __GIO_TYPES_H__
30 #include <gio/gioenums.h>
34 typedef struct _GAppLaunchContext GAppLaunchContext;
35 typedef struct _GAppInfo GAppInfo; /* Dummy typedef */
36 typedef struct _GAsyncResult GAsyncResult; /* Dummy typedef */
37 typedef struct _GAsyncInitable GAsyncInitable;
38 typedef struct _GBufferedInputStream GBufferedInputStream;
39 typedef struct _GBufferedOutputStream GBufferedOutputStream;
40 typedef struct _GCancellable GCancellable;
41 typedef struct _GCharsetConverter GCharsetConverter;
42 typedef struct _GConverter GConverter;
43 typedef struct _GConverterInputStream GConverterInputStream;
44 typedef struct _GConverterOutputStream GConverterOutputStream;
45 typedef struct _GDataInputStream GDataInputStream;
46 typedef struct _GSimplePermission GSimplePermission;
47 typedef struct _GZlibCompressor GZlibCompressor;
48 typedef struct _GZlibDecompressor GZlibDecompressor;
50 typedef struct _GSimpleActionGroup GSimpleActionGroup;
51 typedef struct _GRemoteActionGroup GRemoteActionGroup;
52 typedef struct _GDBusActionGroup GDBusActionGroup;
53 typedef struct _GActionMap GActionMap;
54 typedef struct _GActionGroup GActionGroup;
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;
68 * Opaque drive object.
70 typedef struct _GDrive GDrive; /* Dummy typedef */
71 typedef struct _GFileEnumerator GFileEnumerator;
72 typedef struct _GFileMonitor GFileMonitor;
73 typedef struct _GFilterInputStream GFilterInputStream;
74 typedef struct _GFilterOutputStream GFilterOutputStream;
79 * A handle to an object implementing the #GFileIface interface.
80 * Generally stores a location within the file system. Handles do not
81 * necessarily represent files or directories that currently exist.
83 typedef struct _GFile GFile; /* Dummy typedef */
84 typedef struct _GFileInfo GFileInfo;
87 * GFileAttributeMatcher:
89 * Determines if a string matches a file attribute.
91 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
92 typedef struct _GFileAttributeInfo GFileAttributeInfo;
93 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
94 typedef struct _GFileDescriptorBased GFileDescriptorBased;
95 typedef struct _GFileInputStream GFileInputStream;
96 typedef struct _GFileOutputStream GFileOutputStream;
97 typedef struct _GFileIOStream GFileIOStream;
98 typedef struct _GFileIcon GFileIcon;
99 typedef struct _GFilenameCompleter GFilenameCompleter;
102 typedef struct _GIcon GIcon; /* Dummy typedef */
103 typedef struct _GInetAddress GInetAddress;
104 typedef struct _GInetAddressMask GInetAddressMask;
105 typedef struct _GInetSocketAddress GInetSocketAddress;
106 typedef struct _GInputStream GInputStream;
107 typedef struct _GInitable GInitable;
108 typedef struct _GIOModule GIOModule;
109 typedef struct _GIOExtensionPoint GIOExtensionPoint;
110 typedef struct _GIOExtension GIOExtension;
115 * Opaque class for defining and scheduling IO jobs.
117 typedef struct _GIOSchedulerJob GIOSchedulerJob;
118 typedef struct _GIOStreamAdapter GIOStreamAdapter;
119 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
120 typedef struct _GMemoryInputStream GMemoryInputStream;
121 typedef struct _GMemoryOutputStream GMemoryOutputStream;
126 * A handle to an object implementing the #GMountIface interface.
128 typedef struct _GMount GMount; /* Dummy typedef */
129 typedef struct _GMountOperation GMountOperation;
130 typedef struct _GNetworkAddress GNetworkAddress;
131 typedef struct _GNetworkMonitor GNetworkMonitor;
132 typedef struct _GNetworkService GNetworkService;
133 typedef struct _GOutputStream GOutputStream;
134 typedef struct _GIOStream GIOStream;
135 typedef struct _GPollableInputStream GPollableInputStream; /* Dummy typedef */
136 typedef struct _GPollableOutputStream GPollableOutputStream; /* Dummy typedef */
137 typedef struct _GResolver GResolver;
145 typedef struct _GResource GResource;
146 typedef struct _GSeekable GSeekable;
147 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
152 * A lowlevel network socket object.
156 typedef struct _GSocket GSocket;
159 * GSocketControlMessage:
161 * Base class for socket-type specific control messages that can be sent and
162 * received over #GSocket.
164 typedef struct _GSocketControlMessage GSocketControlMessage;
168 * A helper class for network clients to make connections.
172 typedef struct _GSocketClient GSocketClient;
176 * A socket connection GIOStream object for connection-oriented sockets.
180 typedef struct _GSocketConnection GSocketConnection;
184 * A helper class for network servers to listen for and accept connections.
188 typedef struct _GSocketListener GSocketListener;
192 * A helper class for handling accepting incomming connections in the
197 typedef struct _GSocketService GSocketService;
198 typedef struct _GSocketAddress GSocketAddress;
199 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
200 typedef struct _GSocketConnectable GSocketConnectable;
201 typedef struct _GSrvTarget GSrvTarget;
205 * A #GSocketConnection for TCP/IP connections.
209 typedef struct _GTcpConnection GTcpConnection;
210 typedef struct _GTcpWrapperConnection GTcpWrapperConnection;
212 * GThreadedSocketService:
214 * A helper class for handling accepting incoming connections in the
215 * glib mainloop and handling them in a thread.
219 typedef struct _GThreadedSocketService GThreadedSocketService;
220 typedef struct _GThemedIcon GThemedIcon;
221 typedef struct _GTlsCertificate GTlsCertificate;
222 typedef struct _GTlsClientConnection GTlsClientConnection; /* Dummy typedef */
223 typedef struct _GTlsConnection GTlsConnection;
224 typedef struct _GTlsDatabase GTlsDatabase;
225 typedef struct _GTlsFileDatabase GTlsFileDatabase;
226 typedef struct _GTlsInteraction GTlsInteraction;
227 typedef struct _GTlsPassword GTlsPassword;
228 typedef struct _GTlsServerConnection GTlsServerConnection; /* Dummy typedef */
229 typedef struct _GVfs GVfs; /* Dummy typedef */
234 * A helper class to enumerate proxies base on URI.
238 typedef struct _GProxyResolver GProxyResolver;
239 typedef struct _GProxy GProxy;
240 typedef struct _GProxyAddress GProxyAddress;
241 typedef struct _GProxyAddressEnumerator GProxyAddressEnumerator;
246 * Opaque mountable volume object.
248 typedef struct _GVolume GVolume; /* Dummy typedef */
249 typedef struct _GVolumeMonitor GVolumeMonitor;
252 * GAsyncReadyCallback:
253 * @source_object: the object the asynchronous operation was started with.
254 * @res: a #GAsyncResult.
255 * @user_data: user data passed to the callback.
257 * Type definition for a function that will be called back when an asynchronous
258 * operation within GIO has been completed.
260 typedef void (*GAsyncReadyCallback) (GObject *source_object,
265 * GFileProgressCallback:
266 * @current_num_bytes: the current number of bytes in the operation.
267 * @total_num_bytes: the total number of bytes in the operation.
268 * @user_data: user data passed to the callback.
270 * When doing file operations that may take a while, such as moving
271 * a file or copying a file, a progress callback is used to pass how
272 * far along that operation is to the application.
274 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
275 goffset total_num_bytes,
279 * GFileReadMoreCallback:
280 * @file_contents: the data as currently read.
281 * @file_size: the size of the data currently read.
282 * @callback_data: data passed to the callback.
284 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
285 * it may become necessary to determine if any more data from the file should be loaded.
286 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
287 * should be read, or %FALSE otherwise.
289 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
291 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
293 gpointer callback_data);
297 * GIOSchedulerJobFunc:
298 * @job: a #GIOSchedulerJob.
299 * @cancellable: optional #GCancellable object, %NULL to ignore.
300 * @user_data: the data to pass to callback function
304 * Long-running jobs should periodically check the @cancellable
305 * to see if they have been cancelled.
307 * Returns: %TRUE if this function should be called again to
308 * complete the job, %FALSE if the job is complete (or cancelled)
310 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
311 GCancellable *cancellable,
315 * GSimpleAsyncThreadFunc:
316 * @res: a #GSimpleAsyncResult.
317 * @object: a #GObject.
318 * @cancellable: optional #GCancellable object, %NULL to ignore.
320 * Simple thread function that runs an asynchronous operation and
321 * checks for cancellation.
323 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
325 GCancellable *cancellable);
329 * @socket: the #GSocket
330 * @condition: the current condition at the source fired.
331 * @user_data: data passed in by the user.
333 * This is the function type of the callback used for the #GSource
334 * returned by g_socket_create_source().
336 * Returns: it should return %FALSE if the source should be removed.
340 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
341 GIOCondition condition,
346 * @buffer: Pointer to a buffer where data will be written.
347 * @size: the available size in @buffer.
349 * Structure used for scatter/gather data input.
350 * You generally pass in an array of #GInputVector<!-- -->s
351 * and the operation will store the read data starting in the
352 * first buffer, switching to the next as needed.
356 typedef struct _GInputVector GInputVector;
358 struct _GInputVector {
365 * @buffer: Pointer to a buffer of data to read.
366 * @size: the size of @buffer.
368 * Structure used for scatter/gather data output.
369 * You generally pass in an array of #GOutputVector<!-- -->s
370 * and the operation will use all the buffers as if they were
375 typedef struct _GOutputVector GOutputVector;
377 struct _GOutputVector {
378 gconstpointer buffer;
382 typedef struct _GCredentials GCredentials;
383 typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage;
384 typedef struct _GUnixFDList GUnixFDList;
385 typedef struct _GDBusMessage GDBusMessage;
386 typedef struct _GDBusConnection GDBusConnection;
387 typedef struct _GDBusProxy GDBusProxy;
388 typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
389 typedef struct _GDBusServer GDBusServer;
390 typedef struct _GDBusAuthObserver GDBusAuthObserver;
391 typedef struct _GDBusErrorEntry GDBusErrorEntry;
392 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
393 typedef struct _GDBusSubtreeVTable GDBusSubtreeVTable;
394 typedef struct _GDBusAnnotationInfo GDBusAnnotationInfo;
395 typedef struct _GDBusArgInfo GDBusArgInfo;
396 typedef struct _GDBusMethodInfo GDBusMethodInfo;
397 typedef struct _GDBusSignalInfo GDBusSignalInfo;
398 typedef struct _GDBusPropertyInfo GDBusPropertyInfo;
399 typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo;
400 typedef struct _GDBusNodeInfo GDBusNodeInfo;
403 * GCancellableSourceFunc:
404 * @cancellable: the #GCancellable
405 * @user_data: data passed in by the user.
407 * This is the function type of the callback used for the #GSource
408 * returned by g_cancellable_source_new().
410 * Returns: it should return %FALSE if the source should be removed.
414 typedef gboolean (*GCancellableSourceFunc) (GCancellable *cancellable,
418 * GPollableSourceFunc:
419 * @pollable_stream: the #GPollableInputStream or #GPollableOutputStream
420 * @user_data: data passed in by the user.
422 * This is the function type of the callback used for the #GSource
423 * returned by g_pollable_input_stream_create_source() and
424 * g_pollable_output_stream_create_source().
426 * Returns: it should return %FALSE if the source should be removed.
430 typedef gboolean (*GPollableSourceFunc) (GObject *pollable_stream,
433 typedef struct _GDBusInterface GDBusInterface; /* Dummy typedef */
434 typedef struct _GDBusInterfaceSkeleton GDBusInterfaceSkeleton;
435 typedef struct _GDBusObject GDBusObject; /* Dummy typedef */
436 typedef struct _GDBusObjectSkeleton GDBusObjectSkeleton;
437 typedef struct _GDBusObjectProxy GDBusObjectProxy;
438 typedef struct _GDBusObjectManager GDBusObjectManager; /* Dummy typedef */
439 typedef struct _GDBusObjectManagerClient GDBusObjectManagerClient;
440 typedef struct _GDBusObjectManagerServer GDBusObjectManagerServer;
443 * GDBusProxyTypeFunc:
444 * @manager: A #GDBusObjectManagerClient.
445 * @object_path: The object path of the remote object.
446 * @interface_name: (allow-none): The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested.
447 * @user_data: User data.
449 * Function signature for a function used to determine the #GType to
450 * use for an interface proxy (if @interface_name is not %NULL) or
451 * object proxy (if @interface_name is %NULL).
453 * This function is called in the
454 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
455 * that @manager was constructed in.
457 * Returns: A #GType to use for the remote object. The returned type
458 * must be a #GDBusProxy<!-- -->- or #GDBusObjectProxy<!-- -->-derived
463 typedef GType (*GDBusProxyTypeFunc) (GDBusObjectManagerClient *manager,
464 const gchar *object_path,
465 const gchar *interface_name,
468 typedef struct _GTestDBus GTestDBus;
472 #endif /* __GIO_TYPES_H__ */