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 _GActionGroup GActionGroup;
52 typedef struct _GSimpleAction GSimpleAction;
53 typedef struct _GAction GAction;
54 typedef struct _GApplication GApplication;
55 typedef struct _GApplicationCommandLine GApplicationCommandLine;
56 typedef struct _GSettingsBackend GSettingsBackend;
57 typedef struct _GSettings GSettings;
58 typedef struct _GPermission GPermission;
63 * Opaque drive object.
65 typedef struct _GDrive GDrive; /* Dummy typedef */
66 typedef struct _GFileEnumerator GFileEnumerator;
67 typedef struct _GFileMonitor GFileMonitor;
68 typedef struct _GFilterInputStream GFilterInputStream;
69 typedef struct _GFilterOutputStream GFilterOutputStream;
74 * A handle to an object implementing the #GFileIface interface.
75 * Generally stores a location within the file system. Handles do not
76 * necessarily represent files or directories that currently exist.
78 typedef struct _GFile GFile; /* Dummy typedef */
79 typedef struct _GFileInfo GFileInfo;
82 * GFileAttributeMatcher:
84 * Determines if a string matches a file attribute.
86 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
87 typedef struct _GFileAttributeInfo GFileAttributeInfo;
88 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
89 typedef struct _GFileDescriptorBased GFileDescriptorBased;
90 typedef struct _GFileInputStream GFileInputStream;
91 typedef struct _GFileOutputStream GFileOutputStream;
92 typedef struct _GFileIOStream GFileIOStream;
93 typedef struct _GFileIcon GFileIcon;
94 typedef struct _GFilenameCompleter GFilenameCompleter;
97 typedef struct _GIcon GIcon; /* Dummy typedef */
98 typedef struct _GInetAddress GInetAddress;
99 typedef struct _GInetSocketAddress GInetSocketAddress;
100 typedef struct _GInputStream GInputStream;
101 typedef struct _GInitable GInitable;
102 typedef struct _GIOModule GIOModule;
103 typedef struct _GIOExtensionPoint GIOExtensionPoint;
104 typedef struct _GIOExtension GIOExtension;
109 * Opaque class for definining and scheduling IO jobs.
111 typedef struct _GIOSchedulerJob GIOSchedulerJob;
112 typedef struct _GIOStreamAdapter GIOStreamAdapter;
113 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
114 typedef struct _GMemoryInputStream GMemoryInputStream;
115 typedef struct _GMemoryOutputStream GMemoryOutputStream;
120 * A handle to an object implementing the #GMountIface interface.
122 typedef struct _GMount GMount; /* Dummy typedef */
123 typedef struct _GMountOperation GMountOperation;
124 typedef struct _GNetworkAddress GNetworkAddress;
125 typedef struct _GNetworkService GNetworkService;
126 typedef struct _GOutputStream GOutputStream;
127 typedef struct _GIOStream GIOStream;
128 typedef struct _GPollableInputStream GPollableInputStream; /* Dummy typedef */
129 typedef struct _GPollableOutputStream GPollableOutputStream; /* Dummy typedef */
130 typedef struct _GResolver GResolver;
131 typedef struct _GSeekable GSeekable;
132 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
137 * A lowlevel network socket object.
141 typedef struct _GSocket GSocket;
144 * GSocketControlMessage:
146 * Base class for socket-type specific control messages that can be sent and
147 * received over #GSocket.
149 typedef struct _GSocketControlMessage GSocketControlMessage;
153 * A helper class for network clients to make connections.
157 typedef struct _GSocketClient GSocketClient;
161 * A socket connection GIOStream object for connection-oriented sockets.
165 typedef struct _GSocketConnection GSocketConnection;
169 * A helper class for network servers to listen for and accept connections.
173 typedef struct _GSocketListener GSocketListener;
177 * A helper class for handling accepting incomming connections in the
182 typedef struct _GSocketService GSocketService;
183 typedef struct _GSocketAddress GSocketAddress;
184 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
185 typedef struct _GSocketConnectable GSocketConnectable;
186 typedef struct _GSrvTarget GSrvTarget;
190 * A #GSocketConnection for TCP/IP connections.
194 typedef struct _GTcpConnection GTcpConnection;
195 typedef struct _GTcpWrapperConnection GTcpWrapperConnection;
197 * GThreadedSocketService:
199 * A helper class for handling accepting incomming connections in the
200 * glib mainloop and handling them in a thread.
204 typedef struct _GThreadedSocketService GThreadedSocketService;
205 typedef struct _GThemedIcon GThemedIcon;
206 typedef struct _GTlsCertificate GTlsCertificate;
207 typedef struct _GTlsClientConnection GTlsClientConnection; /* Dummy typedef */
208 typedef struct _GTlsClientContext GTlsClientContext; /* Dummy typedef */
209 typedef struct _GTlsConnection GTlsConnection;
210 typedef struct _GTlsContext GTlsContext;
211 typedef struct _GTlsServerConnection GTlsServerConnection; /* Dummy typedef */
212 typedef struct _GTlsServerContext GTlsServerContext; /* Dummy typedef */
213 typedef struct _GVfs GVfs; /* Dummy typedef */
218 * A helper class to enumerate proxies base on URI.
222 typedef struct _GProxyResolver GProxyResolver;
223 typedef struct _GProxy GProxy;
224 typedef struct _GProxyAddress GProxyAddress;
225 typedef struct _GProxyAddressEnumerator GProxyAddressEnumerator;
230 * Opaque mountable volume object.
232 typedef struct _GVolume GVolume; /* Dummy typedef */
233 typedef struct _GVolumeMonitor GVolumeMonitor;
236 * GAsyncReadyCallback:
237 * @source_object: the object the asynchronous operation was started with.
238 * @res: a #GAsyncResult.
239 * @user_data: user data passed to the callback.
241 * Type definition for a function that will be called back when an asynchronous
242 * operation within GIO has been completed.
244 typedef void (*GAsyncReadyCallback) (GObject *source_object,
249 * GFileProgressCallback:
250 * @current_num_bytes: the current number of bytes in the operation.
251 * @total_num_bytes: the total number of bytes in the operation.
252 * @user_data: user data passed to the callback.
254 * When doing file operations that may take a while, such as moving
255 * a file or copying a file, a progress callback is used to pass how
256 * far along that operation is to the application.
258 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
259 goffset total_num_bytes,
263 * GFileReadMoreCallback:
264 * @file_contents: the data as currently read.
265 * @file_size: the size of the data currently read.
266 * @callback_data: data passed to the callback.
268 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
269 * it may become necessary to determine if any more data from the file should be loaded.
270 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
271 * should be read, or %FALSE otherwise.
273 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
275 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
277 gpointer callback_data);
281 * GIOSchedulerJobFunc:
282 * @job: a #GIOSchedulerJob.
283 * @cancellable: optional #GCancellable object, %NULL to ignore.
284 * @user_data: the data to pass to callback function
288 * Note that depending on whether threads are available, the
289 * #GIOScheduler may run jobs in separate threads or in an idle
292 * Long-running jobs should periodically check the @cancellable
293 * to see if they have been cancelled.
295 * Returns: %TRUE if this function should be called again to
296 * complete the job, %FALSE if the job is complete (or cancelled)
298 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
299 GCancellable *cancellable,
303 * GSimpleAsyncThreadFunc:
304 * @res: a #GSimpleAsyncResult.
305 * @object: a #GObject.
306 * @cancellable: optional #GCancellable object, %NULL to ignore.
308 * Simple thread function that runs an asynchronous operation and
309 * checks for cancellation.
311 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
313 GCancellable *cancellable);
317 * @socket: the #GSocket
318 * @condition: the current condition at the source fired.
319 * @user_data: data passed in by the user.
321 * This is the function type of the callback used for the #GSource
322 * returned by g_socket_create_source().
324 * Returns: it should return %FALSE if the source should be removed.
328 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
329 GIOCondition condition,
334 * @buffer: Pointer to a buffer where data will be written.
335 * @size: the available size in @buffer.
337 * Structure used for scatter/gather data input.
338 * You generally pass in an array of #GInputVector<!-- -->s
339 * and the operation will store the read data starting in the
340 * first buffer, switching to the next as needed.
344 typedef struct _GInputVector GInputVector;
346 struct _GInputVector {
353 * @buffer: Pointer to a buffer of data to read.
354 * @size: the size of @buffer.
356 * Structure used for scatter/gather data output.
357 * You generally pass in an array of #GOutputVector<!-- -->s
358 * and the operation will use all the buffers as if they were
363 typedef struct _GOutputVector GOutputVector;
365 struct _GOutputVector {
366 gconstpointer buffer;
370 typedef struct _GCredentials GCredentials;
371 typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage;
372 typedef struct _GUnixFDList GUnixFDList;
373 typedef struct _GDBusMessage GDBusMessage;
374 typedef struct _GDBusConnection GDBusConnection;
375 typedef struct _GDBusProxy GDBusProxy;
376 typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
377 typedef struct _GDBusServer GDBusServer;
378 typedef struct _GDBusAuthObserver GDBusAuthObserver;
379 typedef struct _GDBusErrorEntry GDBusErrorEntry;
380 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
381 typedef struct _GDBusSubtreeVTable GDBusSubtreeVTable;
382 typedef struct _GDBusAnnotationInfo GDBusAnnotationInfo;
383 typedef struct _GDBusArgInfo GDBusArgInfo;
384 typedef struct _GDBusMethodInfo GDBusMethodInfo;
385 typedef struct _GDBusSignalInfo GDBusSignalInfo;
386 typedef struct _GDBusPropertyInfo GDBusPropertyInfo;
387 typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo;
388 typedef struct _GDBusNodeInfo GDBusNodeInfo;
391 * GCancellableSourceFunc:
392 * @cancellable: the #GCancellable
393 * @user_data: data passed in by the user.
395 * This is the function type of the callback used for the #GSource
396 * returned by g_cancellable_source_new().
398 * Returns: it should return %FALSE if the source should be removed.
402 typedef gboolean (*GCancellableSourceFunc) (GCancellable *cancellable,
406 * GPollableSourceFunc:
407 * @pollable_stream: the #GPollableInputStream or #GPollableOutputStream
408 * @user_data: data passed in by the user.
410 * This is the function type of the callback used for the #GSource
411 * returned by g_pollable_input_stream_create_source() and
412 * g_pollable_output_stream_create_source().
414 * Returns: it should return %FALSE if the source should be removed.
418 typedef gboolean (*GPollableSourceFunc) (GObject *pollable_stream,
421 typedef struct _GDBusInterface GDBusInterface; /* Dummy typedef */
422 typedef struct _GDBusInterfaceStub GDBusInterfaceStub;
423 typedef struct _GDBusObject GDBusObject; /* Dummy typedef */
424 typedef struct _GDBusObjectStub GDBusObjectStub;
425 typedef struct _GDBusObjectProxy GDBusObjectProxy;
426 typedef struct _GDBusObjectManager GDBusObjectManager; /* Dummy typedef */
427 typedef struct _GDBusObjectManagerClient GDBusObjectManagerClient;
428 typedef struct _GDBusObjectManagerServer GDBusObjectManagerServer;
431 * GDBusProxyTypeFunc:
432 * @manager: A #GDBusObjectManagerClient.
433 * @object_path: The object path of the remote object.
434 * @interface_name: The interface name of the remote object.
435 * @user_data: User data.
437 * Function signature for a function used to determine the #GType to
438 * use for an interface proxy.
440 * This function is called in the
441 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
442 * that @manager was constructed in.
444 * Returns: A #GType to use for the remote object. The returned type
445 * must be a #GDBusProxy derived type.
449 typedef GType (*GDBusProxyTypeFunc) (GDBusObjectManagerClient *manager,
450 const gchar *object_path,
451 const gchar *interface_name,
456 #endif /* __GIO_TYPES_H__ */